mirror of https://github.com/open-webui/docs synced 2025-05-19 10:52:14 +00:00

Go to file

Timothy Jaeryang Baek 64ddd5cee6 Update env-configuration.md		2025-03-05 13:40:03 -08:00
.github/workflows	Apply Prettier formatting to gh-pages workflow YAML file for CI compliance	2024-11-05 23:17:16 +00:00
.vscode
blog
docs	Update env-configuration.md	2025-03-05 13:40:03 -08:00
scripts	Update scan-missing-env-vars.py	2024-12-26 13:54:20 -05:00
src
static	STT documentation	2025-03-02 22:44:14 +02:00
.gitignore	Fix image paths and remove .gitignore from PR	2025-03-02 22:47:01 +02:00
.node-version
.prettierignore
.prettierrc.mjs
.stylelintrc.json
babel.config.mjs
docusaurus.config.ts	refac	2025-01-31 01:34:19 -08:00
eslint.config.mjs
package-lock.json
package.json
postcss.config.js
README.md
sidebars.ts
tailwind.config.ts
tsconfig.json

Website

This website is built using Docusaurus, a modern static website generator.

Installation

npm ci

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.

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Using SSH:

USE_SSH=true npm run deploy

Not using SSH:

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.