docs/sidebars.js

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
module.exports = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

  tutorialSidebar: [
    "intro",
    {
      type: "category",
      label: "入门",
      link: {
        type: "generated-index",
      },
      collapsed: false,
      items: [
        "getting-started/prepare",
        {
          type: "category",
          label: "安装指南",
          link: {
            type: "generated-index",
          },
          items: [
            "getting-started/install/docker-compose",
            "getting-started/install/docker",
            "getting-started/install/1panel",
            "getting-started/install/helm",
            "getting-started/install/podman",
            {
              type: "category",
              label: "其他指南",
              link: {
                type: "generated-index",
              },
              items: [
                "getting-started/install/other/nginxproxymanager",
                "getting-started/install/other/traefik",
              ],
            },
          ],
        },
        "getting-started/migrate-from-1.x",
        "getting-started/first-post",
        // "getting-started/config",
        // "getting-started/upgrade",
        // "getting-started/downloads",
      ],
    },
    {
      type: "category",
      label: "用户指南",
      link: {
        type: "generated-index",
      },
      items: [
        "user-guide/common",
        "user-guide/posts",
        "user-guide/pages",
        "user-guide/attachments",
        "user-guide/themes",
        "user-guide/plugins",
        "user-guide/users",
        "user-guide/settings",
        "user-guide/backup",
        "user-guide/faq",
      ],
    },
    {
      type: "category",
      label: "开发者指南",
      link: {
        type: "generated-index",
      },
      items: [
        {
          type: "category",
          label: "系统开发",
          link: {
            type: "generated-index",
          },
          items: [
            // "developer-guide/core/structure",
            "developer-guide/core/prepare",
            "developer-guide/core/run",
            "developer-guide/core/build",
            // "developer-guide/core/code-style",
          ],
        },
        {
          type: "category",
          label: "插件开发",
          link: {
            type: "generated-index",
          },
          items: [
            "developer-guide/plugin/introduction",
            "developer-guide/plugin/prepare",
            "developer-guide/plugin/hello-world",
            "developer-guide/plugin/publish",
            {
              type: "category",
              label: "基础",
              link: {
                type: "doc",
                id: "developer-guide/plugin/structure",
              },
              items: [
                "developer-guide/plugin/structure",
                "developer-guide/plugin/runtime-mode",
                "developer-guide/plugin/lifecycle",
                "developer-guide/plugin/manifest",
                "developer-guide/plugin/object-management",
              ],
            },
            {
              type: "category",
              label: "示例",
              link: {
                type: "doc",
                id: "developer-guide/plugin/examples/todolist",
              },
              items: ["developer-guide/plugin/examples/todolist"],
            },
            {
              type: "category",
              label: "API 参考",
              link: {
                type: "doc",
                id: "developer-guide/plugin/api-reference/extension",
              },
              items: [
                "developer-guide/plugin/api-reference/extension",
                "developer-guide/plugin/api-reference/role-template",
                "developer-guide/plugin/api-reference/extension-client",
                "developer-guide/plugin/api-reference/reverseproxy",
              ],
            },
          ],
        },
        {
          type: "category",
          label: "主题开发",
          link: {
            type: "generated-index",
          },
          items: [
            "developer-guide/theme/prepare",
            "developer-guide/theme/config",
            "developer-guide/theme/structure",
            "developer-guide/theme/template-route-mapping",
            "developer-guide/theme/static-resources",
            "developer-guide/theme/settings",
            "developer-guide/theme/annotations",
            {
              type: "category",
              label: "模板变量",
              link: {
                type: "doc",
                id: "developer-guide/theme/template-variables",
              },
              items: [
                "developer-guide/theme/template-variables/index_",
                "developer-guide/theme/template-variables/post",
                "developer-guide/theme/template-variables/page",
                "developer-guide/theme/template-variables/archives",
                "developer-guide/theme/template-variables/tags",
                "developer-guide/theme/template-variables/tag",
                "developer-guide/theme/template-variables/categories",
                "developer-guide/theme/template-variables/category",
                "developer-guide/theme/template-variables/author",
              ],
            },
            {
              type: "category",
              label: "Finder API",
              link: {
                type: "doc",
                id: "developer-guide/theme/finder-apis",
              },
              items: [
                "developer-guide/theme/finder-apis/category",
                "developer-guide/theme/finder-apis/tag",
                "developer-guide/theme/finder-apis/post",
                "developer-guide/theme/finder-apis/single-page",
                "developer-guide/theme/finder-apis/comment",
                "developer-guide/theme/finder-apis/contributor",
                "developer-guide/theme/finder-apis/menu",
                "developer-guide/theme/finder-apis/site-stats",
                "developer-guide/theme/finder-apis/theme",
                "developer-guide/theme/finder-apis/plugin",
              ],
            },
            "developer-guide/theme/global-variables",
            "developer-guide/theme/template-tag",
            "developer-guide/theme/code-snippets",
          ],
        },
        "developer-guide/form-schema",
        "developer-guide/annotations-form",
        // {
        //   type: "link",
        //   label: "REST API",
        //   href: "https://api.halo.run",
        // },
      ],
    },
    {
      type: "category",
      label: "参与贡献",
      link: {
        type: "generated-index",
      },
      items: ["contribution/issue", "contribution/pr", "contribution/sponsor"],
    },
    "about",
  ],
};