mirror of
https://github.com/open-webui/docs
synced 2025-06-16 11:28:36 +00:00
setup prettier and local search
This commit is contained in:
Hichem Fantar
parent
6ed5ee1596
commit
306a003563
12
.prettierrc.json
Normal file
12
.prettierrc.json
Normal 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"
|
||||||
|
}
|
||||||
@ -8,158 +8,159 @@ import { themes as prismThemes } from "prism-react-renderer";
|
|||||||
|
|
||||||
/** @type {import('@docusaurus/types').Config} */
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
const config = {
|
const config = {
|
||||||
title: "Open WebUI",
|
title: "Open WebUI",
|
||||||
tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
|
tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
|
||||||
favicon: "img/favicon.png",
|
favicon: "img/favicon.png",
|
||||||
|
|
||||||
// Set the production url of your site here
|
// Set the production url of your site here
|
||||||
url: "https://openwebui.com",
|
url: "https://openwebui.com",
|
||||||
// Set the /<baseUrl>/ pathname under which your site is served
|
// Set the /<baseUrl>/ pathname under which your site is served
|
||||||
// For GitHub pages deployment, it is often '/<projectName>/'
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
||||||
baseUrl: "/",
|
baseUrl: "/",
|
||||||
|
|
||||||
// GitHub pages deployment config.
|
// GitHub pages deployment config.
|
||||||
// If you aren't using GitHub pages, you don't need these.
|
// If you aren't using GitHub pages, you don't need these.
|
||||||
organizationName: "open-webui", // Usually your GitHub org/user name.
|
organizationName: "open-webui", // Usually your GitHub org/user name.
|
||||||
projectName: "docs", // Usually your repo name.
|
projectName: "docs", // Usually your repo name.
|
||||||
|
|
||||||
onBrokenLinks: "throw",
|
onBrokenLinks: "throw",
|
||||||
onBrokenMarkdownLinks: "warn",
|
onBrokenMarkdownLinks: "warn",
|
||||||
|
|
||||||
// Even if you don't use internationalization, you can use this field to set
|
// 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
|
// useful metadata like html lang. For example, if your site is Chinese, you
|
||||||
// may want to replace "en" with "zh-Hans".
|
// may want to replace "en" with "zh-Hans".
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: "en",
|
defaultLocale: "en",
|
||||||
locales: ["en"],
|
locales: ["en"],
|
||||||
},
|
},
|
||||||
|
|
||||||
// Enable Mermaid for diagrams
|
// Enable Mermaid for diagrams
|
||||||
markdown: {
|
markdown: {
|
||||||
mermaid: true,
|
mermaid: true,
|
||||||
},
|
},
|
||||||
themes: ["@docusaurus/theme-mermaid"],
|
themes: ["@docusaurus/theme-mermaid"],
|
||||||
|
|
||||||
presets: [
|
presets: [
|
||||||
[
|
[
|
||||||
"classic",
|
"classic",
|
||||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||||
({
|
({
|
||||||
docs: {
|
docs: {
|
||||||
sidebarPath: "./sidebars.js",
|
sidebarPath: "./sidebars.js",
|
||||||
routeBasePath: "/",
|
routeBasePath: "/",
|
||||||
// Please change this to your repo.
|
// Please change this to your repo.
|
||||||
// Remove this to remove the "edit this page" links.
|
// Remove this to remove the "edit this page" links.
|
||||||
editUrl: "https://github.com/open-webui/docs/blob/main",
|
editUrl: "https://github.com/open-webui/docs/blob/main",
|
||||||
},
|
},
|
||||||
// blog: false,
|
// blog: false,
|
||||||
blog: {
|
blog: {
|
||||||
showReadingTime: true,
|
showReadingTime: true,
|
||||||
// Please change this to your repo.
|
// Please change this to your repo.
|
||||||
// Remove this to remove the "edit this page" links.
|
// Remove this to remove the "edit this page" links.
|
||||||
// editUrl:
|
// editUrl:
|
||||||
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
|
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
|
||||||
},
|
},
|
||||||
theme: {
|
theme: {
|
||||||
customCss: "./src/css/custom.css",
|
customCss: "./src/css/custom.css",
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
|
|
||||||
themeConfig:
|
themeConfig:
|
||||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
({
|
({
|
||||||
// Replace with your project's social card
|
// Replace with your project's social card
|
||||||
// image: "img/docusaurus-social-card.jpg",
|
// image: "img/docusaurus-social-card.jpg",
|
||||||
navbar: {
|
navbar: {
|
||||||
title: "Open WebUI",
|
title: "Open WebUI",
|
||||||
logo: {
|
logo: {
|
||||||
src: "img/logo.png",
|
src: "img/logo.png",
|
||||||
srcDark: "img/logo-dark.png",
|
srcDark: "img/logo-dark.png",
|
||||||
},
|
},
|
||||||
items: [
|
items: [
|
||||||
// {
|
// {
|
||||||
// type: "docSidebar",
|
// type: "docSidebar",
|
||||||
// sidebarId: "blog",
|
// sidebarId: "blog",
|
||||||
// position: "left",
|
// position: "left",
|
||||||
// label: "Blog",
|
// label: "Blog",
|
||||||
// },
|
// },
|
||||||
|
|
||||||
// {
|
// {
|
||||||
// href: "/blog",
|
// href: "/blog",
|
||||||
// label: "Blog",
|
// label: "Blog",
|
||||||
// position: "left",
|
// position: "left",
|
||||||
// },
|
// },
|
||||||
{
|
{
|
||||||
href: "https://github.com/open-webui/open-webui",
|
href: "https://github.com/open-webui/open-webui",
|
||||||
label: "GitHub",
|
label: "GitHub",
|
||||||
position: "right",
|
position: "right",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
footer: {
|
footer: {
|
||||||
logo: {
|
logo: {
|
||||||
src: "img/logo-dark.png",
|
src: "img/logo-dark.png",
|
||||||
height: 100,
|
height: 100,
|
||||||
},
|
},
|
||||||
style: "light",
|
style: "light",
|
||||||
links: [
|
links: [
|
||||||
{
|
{
|
||||||
title: "Docs",
|
title: "Docs",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: "Getting Started",
|
label: "Getting Started",
|
||||||
to: "getting-started",
|
to: "getting-started",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "FAQ",
|
label: "FAQ",
|
||||||
to: "faq",
|
to: "faq",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "Community",
|
title: "Community",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: "GitHub",
|
label: "GitHub",
|
||||||
href: "https://github.com/open-webui/open-webui",
|
href: "https://github.com/open-webui/open-webui",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Discord",
|
label: "Discord",
|
||||||
href: "https://discord.gg/5rJgQTnV4s",
|
href: "https://discord.gg/5rJgQTnV4s",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Twitter",
|
label: "Twitter",
|
||||||
href: "https://twitter.com/OpenWebUI",
|
href: "https://twitter.com/OpenWebUI",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
title: "More",
|
title: "More",
|
||||||
items: [
|
items: [
|
||||||
{
|
{
|
||||||
label: "Release Notes",
|
label: "Release Notes",
|
||||||
to: "https://github.com/open-webui/open-webui/blob/main/CHANGELOG.md",
|
to: "https://github.com/open-webui/open-webui/blob/main/CHANGELOG.md",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "About",
|
label: "About",
|
||||||
to: "https://openwebui.com",
|
to: "https://openwebui.com",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "Research",
|
label: "Research",
|
||||||
to: "research",
|
to: "research",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
// copyright: `Copyright © ${new Date().getFullYear()} OpenWebUI`,
|
// copyright: `Copyright © ${new Date().getFullYear()} OpenWebUI`,
|
||||||
},
|
},
|
||||||
prism: {
|
prism: {
|
||||||
theme: prismThemes.github,
|
theme: prismThemes.github,
|
||||||
darkTheme: prismThemes.dracula,
|
darkTheme: prismThemes.dracula,
|
||||||
},
|
},
|
||||||
}),
|
}),
|
||||||
|
plugins: [require.resolve("docusaurus-lunr-search")],
|
||||||
};
|
};
|
||||||
|
|
||||||
export default config;
|
export default config;
|
||||||
|
|||||||
33361
package-lock.json
generated
33361
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
94
package.json
94
package.json
@ -1,48 +1,50 @@
|
|||||||
{
|
{
|
||||||
"name": "docs",
|
"name": "docs",
|
||||||
"version": "0.0.0",
|
"version": "0.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"docusaurus": "docusaurus",
|
"docusaurus": "docusaurus",
|
||||||
"start": "docusaurus start",
|
"start": "docusaurus start",
|
||||||
"build": "docusaurus build",
|
"build": "docusaurus build",
|
||||||
"swizzle": "docusaurus swizzle",
|
"swizzle": "docusaurus swizzle",
|
||||||
"deploy": "docusaurus deploy",
|
"deploy": "docusaurus deploy",
|
||||||
"clear": "docusaurus clear",
|
"clear": "docusaurus clear",
|
||||||
"serve": "docusaurus serve",
|
"serve": "docusaurus serve",
|
||||||
"write-translations": "docusaurus write-translations",
|
"write-translations": "docusaurus write-translations",
|
||||||
"write-heading-ids": "docusaurus write-heading-ids"
|
"write-heading-ids": "docusaurus write-heading-ids",
|
||||||
},
|
"prettier": "npx prettier . --write"
|
||||||
"dependencies": {
|
},
|
||||||
"@docusaurus/core": "^3.2.0",
|
"dependencies": {
|
||||||
"@docusaurus/preset-classic": "^3.2.0",
|
"@docusaurus/core": "^3.2.0",
|
||||||
"@docusaurus/theme-mermaid": "^3.2.0",
|
"@docusaurus/preset-classic": "^3.2.0",
|
||||||
"@mdx-js/react": "^3.0.0",
|
"@docusaurus/theme-mermaid": "^3.2.0",
|
||||||
"clsx": "^2.0.0",
|
"@mdx-js/react": "^3.0.0",
|
||||||
"prism-react-renderer": "^2.3.0",
|
"clsx": "^2.0.0",
|
||||||
"react": "^18.0.0",
|
"docusaurus-lunr-search": "^3.4.0",
|
||||||
"react-dom": "^18.0.0"
|
"prism-react-renderer": "^2.3.0",
|
||||||
},
|
"react": "^18.0.0",
|
||||||
"devDependencies": {
|
"react-dom": "^18.0.0"
|
||||||
"@docusaurus/module-type-aliases": "^3.2.0",
|
},
|
||||||
"@docusaurus/types": "^3.2.0",
|
"devDependencies": {
|
||||||
"autoprefixer": "^10.4.19",
|
"@docusaurus/module-type-aliases": "^3.2.0",
|
||||||
"postcss": "^8.4.38",
|
"@docusaurus/types": "^3.2.0",
|
||||||
"tailwindcss": "^3.4.3"
|
"autoprefixer": "^10.4.19",
|
||||||
},
|
"postcss": "^8.4.38",
|
||||||
"browserslist": {
|
"tailwindcss": "^3.4.3"
|
||||||
"production": [
|
},
|
||||||
">0.5%",
|
"browserslist": {
|
||||||
"not dead",
|
"production": [
|
||||||
"not op_mini all"
|
">0.5%",
|
||||||
],
|
"not dead",
|
||||||
"development": [
|
"not op_mini all"
|
||||||
"last 3 chrome version",
|
],
|
||||||
"last 3 firefox version",
|
"development": [
|
||||||
"last 5 safari version"
|
"last 3 chrome version",
|
||||||
]
|
"last 3 firefox version",
|
||||||
},
|
"last 5 safari version"
|
||||||
"engines": {
|
]
|
||||||
"node": ">=18.0"
|
},
|
||||||
}
|
"engines": {
|
||||||
|
"node": ">=18.0"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user