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

Go to file

parniantaghipour 68f13e1a6e Unsafe Explanation

Updated

More details on what SAFE_MODE does #215

Based on code base one line added to description.

2024-11-11 14:05:38 -08: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

Unsafe Explanation

2024-11-11 14:05:38 -08:00

scripts

feat: add script for scanning for missing env vars in docs

2024-09-07 12:42:53 +01:00

src

Apply stylelint fixes

2024-09-26 01:53:26 +02:00

static

doc: Folder and Tag

2024-11-06 23:28:56 -08:00

.gitignore

init

2024-02-19 21:02:13 -08: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

docs: revert changes to docusaurus and ghpages

2024-11-05 22:59:29 +00: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.