docs/docusaurus.config.js - main - githubmirror/Open-Assistant

docs/docusaurus.config.js
149 строк4 KB
Andrew Maguire
Add inference api docs (#3059)
07 май 2023, 17:07
07 май 2023, 17:0762b6a92
// @ts-check
// Note: type annotations allow type checking and IDEs autocompletion

const lightCodeTheme = require("prism-react-renderer/themes/github");
const darkCodeTheme = require("prism-react-renderer/themes/dracula");

/** @type {import('@docusaurus/types').Config} */
const config = {
  title: "Open Assistant",
  tagline: "Build the assistant of the future!",
  url: "https://LAION-AI.github.io",
  trailingSlash: false,
  baseUrl: "/Open-Assistant/",
  onBrokenLinks: "throw",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/logo.svg",
  staticDirectories: ["public", "static", "docs/data/img"],

  // GitHub pages deployment config.
  // If you aren't using GitHub pages, you don't need these.
  organizationName: "LAION-AI", // Usually your GitHub org/user name.
  projectName: "Open-Assistant", // Usually your repo name.
  deploymentBranch: "main",

  // Even if you don't use internalization, 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"],
  },
  markdown: {
    mermaid: true,
  },
  themes: ["@docusaurus/theme-mermaid"],

  presets: [
    [
      "docusaurus-preset-openapi",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
        },
        api: {
          path: "docs/api/",
        },
        blog: {
          routeBasePath: "/blog",
          showReadingTime: true,
          blogTitle: "OpenAssistant Blog",
          blogDescription: "Home of the OpenAssistant blog.",
          blogSidebarTitle: "Blog Posts",
          blogSidebarCount: "ALL",
          postsPerPage: "ALL",
          feedOptions: {
            type: "all",
            title: "OpenAssistant Blog",
            description: "Home of the OpenAssistant blog.",
            language: "en",
            copyright: `Copyright © ${new Date().getFullYear()} OpenAssistant.`,
          },
        },
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      navbar: {
        title: "Open Assistant",
        logo: {
          alt: "Open Assistant Logo",
          src: "img/logo.svg",
        },
        items: [
          {
            href: "https://open-assistant.io/",
            label: "App",
            position: "left",
          },
          {
            href: "https://open-assistant.io/chat",
            label: "Chat",
            position: "left",
          },
          {
            type: "doc",
            docId: "intro",
            position: "left",
            label: "Docs",
          },
          { to: "/blog", label: "Blog", position: "left" },
          { to: "/api", label: "API", position: "left" },
          {
            href: "https://github.com/LAION-AI/Open-Assistant",
            label: "GitHub",
            position: "right",
          },
        ],
      },
      footer: {
        style: "dark",
        links: [
          {
            title: "Community",
            items: [
              {
                label: "OpenAssistant Contributors Discord",
                href: "https://ykilcher.com/open-assistant-discord",
              },
              {
                label: "LAION Discord",
                href: "https://discord.com/invite/mVcgxMPD7e",
              },
              {
                label: "YK Discord",
                href: "https://ykilcher.com/discord",
              },
            ],
          },
          {
            title: "Resources",
            items: [
              {
                label: "GitHub",
                href: "https://github.com/LAION-AI/Open-Assistant",
              },
              {
                label: "FAQ",
                href: "https://projects.laion.ai/Open-Assistant/docs/faq",
              },
            ],
          },
        ],
        copyright: `Copyright © ${new Date().getFullYear()} laion.ai. Built with Docusaurus.`,
      },
      prism: {
        theme: lightCodeTheme,
        darkTheme: darkCodeTheme,
      },
    }),
};

module.exports = config;