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
1,053 Commits 1 Branch 0 Tags 54 MiB
Python 35.7%
TypeScript 35.6%
CSS 27.4%
JavaScript 1.3%
99bce83155
Go to file
Taylor Wilsdon 99bce83155 Add defaults
2025-02-26 12:39:37 -05:00
.github/workflows Apply Prettier formatting to gh-pages workflow YAML file for CI compliance 2024-11-05 23:17:16 +00:00
.vscode chore: add mdx-check script to package.json and md lint config 2024-06-16 21:44:42 +01:00
blog Add truncate to fix Docusaurus warning 2024-09-26 01:52:25 +02:00
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 chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
.prettierrc.mjs Switch to ts and ESM configs 2024-09-26 01:51:00 +02:00
.stylelintrc.json Add stylelint config 2024-09-26 01:53:07 +02:00
babel.config.mjs Switch to ts and ESM configs 2024-09-26 01:51:00 +02:00
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 Bump dependancies and install lint and format packages 2024-09-26 01:47:47 +02:00
package.json Bump dependancies and install lint and format packages 2024-09-26 01:47:47 +02:00
postcss.config.js chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
README.md use npm ci instead of npm i. 2024-07-27 09:25:54 +00:00
sidebars.ts Fixed docs layout 2024-07-20 11:33:23 -06:00
tailwind.config.ts Switch to ts and ESM configs 2024-09-26 01:51:00 +02:00
tsconfig.json Run prettier 2024-09-26 01:51:58 +02:00

README.md

Website

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

Installation

npm ci

Local Development

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

npm run build

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

Deployment

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.