mirror of https://github.com/open-webui/docs synced 2025-06-16 11:28:36 +00:00

Go to file

Timothy Jaeryang Baek b999c70f16 Update faq.mdx		2025-03-31 01:03:01 -07: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	Add truncate to fix Docusaurus warning	2024-09-26 01:52:25 +02:00
docs	Update faq.mdx	2025-03-31 01:03:01 -07:00
scripts	Update scan-missing-env-vars.py	2024-12-26 13:54:20 -05:00
src	refac	2025-03-27 20:54:52 -07:00
static	doc: openapi + open webui	2025-03-30 01:45:00 -07:00
.gitignore	Update .gitignore	2025-03-14 15:36:56 -04:00
.node-version	Use node-version file to set the version once	2024-09-26 02:01:49 +02:00
.prettierignore
.prettierrc.mjs
.stylelintrc.json	Add stylelint config	2024-09-26 01:53:07 +02:00
babel.config.mjs
docusaurus.config.ts	refac	2025-01-31 01:34:19 -08:00
eslint.config.mjs	Add eslint flat config	2024-09-26 01:53:16 +02:00
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.