OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-20 19:26:22 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
453 Commits 1 Branch 0 Tags 52 MiB
Python 40.5%
CSS 31%
TypeScript 27%
JavaScript 1.5%
e5c2c01a1d
Go to file
Justin Hayes e5c2c01a1d
Merge pull request #172 from thiswillbeyourgithub/docs_whitelist_ssl_https 
docs: mention ways to bypass HTTPS restrictions on chromium + untested ways on firefox
2024-08-07 13:09:37 -04:00
.github/workflows feat: gh-pages added 2024-02-19 21:33:28 -08:00
.vscode chore: add mdx-check script to package.json and md lint config 2024-06-16 21:44:42 +01:00
blog feat: blog 2024-06-11 13:10:48 -07:00
docs docs: mention ways to bypass HTTPS restrictions on chromium + untested ways on firefox 2024-08-07 12:20:57 +02:00
src chore: explain how to url encode an svg 2024-06-17 16:23:41 +01:00
static New docs for tools, functions and actions 2024-07-27 13:41:32 -06:00
.gitignore init 2024-02-19 21:02:13 -08:00
.prettierignore chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
.prettierrc.json setup prettier and local search 2024-06-16 21:10:18 +01:00
babel.config.js chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
docusaurus.config.ts Fixed docs layout 2024-07-20 11:33:23 -06:00
package-lock.json refactor: Rename files to use TypeScript extension 2024-06-17 15:46:52 +01:00
package.json chore: Add typecheck script to package.json 2024-06-17 15:47:58 +01: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.js chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
tsconfig.json refactor: Rename files to use TypeScript extension 2024-06-17 15:46:52 +01: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.