docusaurus.config.ts 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. import { Config } from "@docusaurus/types";
  2. import type * as Preset from "@docusaurus/preset-classic";
  3. import { themes as prismThemes } from "prism-react-renderer";
  4. const config: Config = {
  5. title: "Open WebUI",
  6. tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
  7. favicon: "img/favicon.png",
  8. // Set the production url of your site here
  9. url: "https://openwebui.com",
  10. // Set the /<baseUrl>/ pathname under which your site is served
  11. // For GitHub pages deployment, it is often '/<projectName>/'
  12. baseUrl: "/",
  13. // GitHub pages deployment config.
  14. // If you aren't using GitHub pages, you don't need these.
  15. organizationName: "open-webui", // Usually your GitHub org/user name.
  16. projectName: "docs", // Usually your repo name.
  17. onBrokenLinks: "throw",
  18. onBrokenMarkdownLinks: "warn",
  19. // Even if you don't use internationalization, you can use this field to set
  20. // useful metadata like html lang. For example, if your site is Chinese, you
  21. // may want to replace "en" with "zh-Hans".
  22. i18n: {
  23. defaultLocale: "en",
  24. locales: ["en"],
  25. },
  26. // Enable Mermaid for diagrams
  27. markdown: {
  28. mermaid: true,
  29. },
  30. themes: ["@docusaurus/theme-mermaid"],
  31. presets: [
  32. [
  33. "classic",
  34. {
  35. docs: {
  36. sidebarPath: "./sidebars.ts",
  37. routeBasePath: "/",
  38. // Please change this to your repo.
  39. // Remove this to remove the "edit this page" links.
  40. editUrl: "https://github.com/open-webui/docs/blob/main",
  41. exclude: ["**/tab-**/**"],
  42. },
  43. // blog: false,
  44. blog: {
  45. showReadingTime: true,
  46. // Please change this to your repo.
  47. // Remove this to remove the "edit this page" links.
  48. // editUrl:
  49. // "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
  50. },
  51. theme: {
  52. customCss: "./src/css/custom.css",
  53. },
  54. } satisfies Preset.Options,
  55. ],
  56. ],
  57. themeConfig: {
  58. // Replace with your project's social card
  59. // image: "img/docusaurus-social-card.jpg",
  60. navbar: {
  61. title: "Open WebUI",
  62. logo: {
  63. src: "img/logo.png",
  64. srcDark: "img/logo-dark.png",
  65. },
  66. items: [
  67. // {
  68. // type: "docSidebar",
  69. // position: "left",
  70. // sidebarId: "pipelines",
  71. // label: "Pipelines",
  72. // },
  73. // {
  74. // type: "docSidebar",
  75. // sidebarId: "blog",
  76. // position: "left",
  77. // label: "Blog",
  78. // },
  79. // {
  80. // href: "/blog",
  81. // label: "Blog",
  82. // position: "left",
  83. // },
  84. {
  85. href: "https://github.com/open-webui/open-webui",
  86. position: "right",
  87. className: "header-github-link",
  88. "aria-label": "GitHub repository",
  89. },
  90. {
  91. href: "https://discord.com/invite/5rJgQTnV4s",
  92. position: "right",
  93. className: "header-discord-link",
  94. "aria-label": "Discord server",
  95. },
  96. ],
  97. },
  98. footer: {
  99. logo: {
  100. src: "img/logo-dark.png",
  101. height: 100,
  102. },
  103. style: "light",
  104. links: [
  105. {
  106. title: "Docs",
  107. items: [
  108. {
  109. label: "Getting Started",
  110. to: "getting-started",
  111. },
  112. {
  113. label: "FAQ",
  114. to: "faq",
  115. },
  116. ],
  117. },
  118. {
  119. title: "Community",
  120. items: [
  121. {
  122. label: "GitHub",
  123. href: "https://github.com/open-webui/open-webui",
  124. },
  125. {
  126. label: "Discord",
  127. href: "https://discord.gg/5rJgQTnV4s",
  128. },
  129. {
  130. label: "𝕏",
  131. href: "https://x.com/OpenWebUI",
  132. },
  133. ],
  134. },
  135. {
  136. title: "More",
  137. items: [
  138. {
  139. label: "Release Notes",
  140. to: "https://github.com/open-webui/open-webui/blob/main/CHANGELOG.md",
  141. },
  142. {
  143. label: "About",
  144. to: "https://openwebui.com",
  145. },
  146. ],
  147. },
  148. ],
  149. // copyright: `Copyright © ${new Date().getFullYear()} OpenWebUI`,
  150. },
  151. prism: {
  152. theme: prismThemes.github,
  153. darkTheme: prismThemes.dracula,
  154. },
  155. } satisfies Preset.ThemeConfig,
  156. plugins: [require.resolve("docusaurus-lunr-search")],
  157. };
  158. export default config;