OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-10 00:27:43 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

feat: Update installation and local development instructions

Browse Source
This commit is contained in:
Hichem Fantar 2024-06-16 21:57:23 +01:00
parent 6b8147d818
commit f793887a77
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -2,40 +2,40 @@
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
## Installation
```
$ yarn
npm i
```
### Local Development
## Local Development
```
$ yarn start
npm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
## Build
```
$ yarn build
npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Deployment
## Deployment
Using SSH:
```
$ USE_SSH=true yarn deploy
USE_SSH=true npm run deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
GIT_USER=<Your GitHub username> npm run deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.