mirror of https://github.com/open-webui/docs synced 2025-06-16 03:18:14 +00:00

Go to file

Taylor Wilsdon 99bce83155 Add defaults		2025-02-26 12:39:37 -05:00
.github/workflows	chore: reset gh-pages.yml and docusaurus.config.ts to match upstream main	2024-11-07 20:51:46 +00:00
.vscode
blog
docs	Add defaults	2025-02-26 12:39:37 -05:00
scripts	Update scan-missing-env-vars.py	2024-12-26 13:54:20 -05:00
src	Apply stylelint fixes	2024-09-26 01:53:26 +02:00
static	feat: add doc for search web via SerpApi && update enable_web_search.png for the new UI	2025-02-15 12:01:36 +08:00
.gitignore	update to reflect support for env var config as well as in-ui config	2025-02-26 12:38:46 -05: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.