OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 18:58:41 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
339 Commits 1 Branch 0 Tags 51 MiB
Python 40.5%
CSS 31%
TypeScript 27%
JavaScript 1.5%
6b8147d818
Go to file
Hichem Fantar 6b8147d818 chore: add mdx-check script to package.json and md lint config
2024-06-16 21:44:42 +01: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 chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
src refactor: use JSX extension for React components 2024-06-16 21:38:16 +01:00
static feat: cat 2024-06-14 02:12:47 -07: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.js setup prettier and local search 2024-06-16 21:10:18 +01:00
package-lock.json chore: add mdx-check script to package.json and md lint config 2024-06-16 21:44:42 +01:00
package.json chore: add mdx-check script to package.json and md lint config 2024-06-16 21:44:42 +01:00
postcss.config.js chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
README.md init 2024-02-19 21:02:13 -08:00
sidebars.js chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00
tailwind.config.js chore: consistent formatting using prettier 2024-06-16 21:32:12 +01:00

README.md

Website

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

Installation

$ yarn

Local Development

$ yarn 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

$ yarn 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 yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn 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.