OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-06-14 18:40:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

setup prettier and local search

Browse Source
This commit is contained in:
Hichem Fantar 2024-06-16 21:10:18 +01:00
parent 6ed5ee1596
commit 306a003563
4 changed files with 17265 additions and 16491 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.prettierrc.json Normal file
View File

@ -0,0 +1,12 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"useTabs": true,
"singleQuote": false,
"semi": true,
"bracketSameLine": false,
"bracketSpacing": true,
"jsxSingleQuote": false,
"quoteProps": "as-needed",
"endOfLine": "lf"
}

289
docusaurus.config.js
View File

@ -8,158 +8,159 @@ import { themes as prismThemes } from "prism-react-renderer";
/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Open WebUI",
tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
favicon: "img/favicon.png",
title: "Open WebUI",
tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
favicon: "img/favicon.png",
// Set the production url of your site here
url: "https://openwebui.com",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
// Set the production url of your site here
url: "https://openwebui.com",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "open-webui", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "open-webui", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
},
// Enable Mermaid for diagrams
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
// Enable Mermaid for diagrams
markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: "./sidebars.js",
routeBasePath: "/",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/open-webui/docs/blob/main",
},
// blog: false,
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
theme: {
customCss: "./src/css/custom.css",
},
}),
],
],
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: "./sidebars.js",
routeBasePath: "/",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/open-webui/docs/blob/main",
},
// blog: false,
blog: {
showReadingTime: true,
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
theme: {
customCss: "./src/css/custom.css",
},
}),
],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
// image: "img/docusaurus-social-card.jpg",
navbar: {
title: "Open WebUI",
logo: {
src: "img/logo.png",
srcDark: "img/logo-dark.png",
},
items: [
// {
// type: "docSidebar",
// sidebarId: "blog",
// position: "left",
// label: "Blog",
// },
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
// image: "img/docusaurus-social-card.jpg",
navbar: {
title: "Open WebUI",
logo: {
src: "img/logo.png",
srcDark: "img/logo-dark.png",
},
items: [
// {
// type: "docSidebar",
// sidebarId: "blog",
// position: "left",
// label: "Blog",
// },
// {
// href: "/blog",
// label: "Blog",
// position: "left",
// },
{
href: "https://github.com/open-webui/open-webui",
label: "GitHub",
position: "right",
},
],
},
footer: {
logo: {
src: "img/logo-dark.png",
height: 100,
},
style: "light",
links: [
{
title: "Docs",
items: [
{
label: "Getting Started",
to: "getting-started",
},
{
label: "FAQ",
to: "faq",
},
],
},
{
title: "Community",
items: [
{
label: "GitHub",
href: "https://github.com/open-webui/open-webui",
},
{
label: "Discord",
href: "https://discord.gg/5rJgQTnV4s",
},
{
label: "Twitter",
href: "https://twitter.com/OpenWebUI",
},
],
},
{
title: "More",
items: [
{
label: "Release Notes",
to: "https://github.com/open-webui/open-webui/blob/main/CHANGELOG.md",
},
{
label: "About",
to: "https://openwebui.com",
},
{
label: "Research",
to: "research",
},
],
},
],
// copyright: `Copyright © ${new Date().getFullYear()} OpenWebUI`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
}),
// {
// href: "/blog",
// label: "Blog",
// position: "left",
// },
{
href: "https://github.com/open-webui/open-webui",
label: "GitHub",
position: "right",
},
],
},
footer: {
logo: {
src: "img/logo-dark.png",
height: 100,
},
style: "light",
links: [
{
title: "Docs",
items: [
{
label: "Getting Started",
to: "getting-started",
},
{
label: "FAQ",
to: "faq",
},
],
},
{
title: "Community",
items: [
{
label: "GitHub",
href: "https://github.com/open-webui/open-webui",
},
{
label: "Discord",
href: "https://discord.gg/5rJgQTnV4s",
},
{
label: "Twitter",
href: "https://twitter.com/OpenWebUI",
},
],
},
{
title: "More",
items: [
{
label: "Release Notes",
to: "https://github.com/open-webui/open-webui/blob/main/CHANGELOG.md",
},
{
label: "About",
to: "https://openwebui.com",
},
{
label: "Research",
to: "research",
},
],
},
],
// copyright: `Copyright © ${new Date().getFullYear()} OpenWebUI`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
}),
plugins: [require.resolve("docusaurus-lunr-search")],
};
export default config;

33361
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

94
package.json
View File

@ -1,48 +1,50 @@
{
"name": "docs",
"version": "0.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "^3.2.0",
"@docusaurus/preset-classic": "^3.2.0",
"@docusaurus/theme-mermaid": "^3.2.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.2.0",
"@docusaurus/types": "^3.2.0",
"autoprefixer": "^10.4.19",
"postcss": "^8.4.38",
"tailwindcss": "^3.4.3"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 3 chrome version",
"last 3 firefox version",
"last 5 safari version"
]
},
"engines": {
"node": ">=18.0"
}
"name": "docs",
"version": "0.0.0",
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"prettier": "npx prettier . --write"
},
"dependencies": {
"@docusaurus/core": "^3.2.0",
"@docusaurus/preset-classic": "^3.2.0",
"@docusaurus/theme-mermaid": "^3.2.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^2.0.0",
"docusaurus-lunr-search": "^3.4.0",
"prism-react-renderer": "^2.3.0",
"react": "^18.0.0",
"react-dom": "^18.0.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.2.0",
"@docusaurus/types": "^3.2.0",
"autoprefixer": "^10.4.19",
"postcss": "^8.4.38",
"tailwindcss": "^3.4.3"
},
"browserslist": {
"production": [
">0.5%",
"not dead",
"not op_mini all"
],
"development": [
"last 3 chrome version",
"last 3 firefox version",
"last 5 safari version"
]
},
"engines": {
"node": ">=18.0"
}
}