nonebot2/docs/.vuepress/config.js

const path = require("path");

module.exports = context => ({
  base: process.env.VUEPRESS_BASE || "/",
  title: "NoneBot",
  description: "基于 酷Q 的 Python 异步 QQ 机器人框架",
  markdown: {
    lineNumbers: true
  },
  /**
   * Extra tags to be injected to the page HTML `<head>`
   *
   * ref：https://v1.vuepress.vuejs.org/config/#head
   */
  head: [
    ["link", { rel: "icon", href: "/logo.png" }],
    ["link", { rel: "manifest", href: "/manifest.json" }],
    ["meta", { name: "theme-color", content: "#ea5252" }],
    ["meta", { name: "application-name", content: "NoneBot" }],
    ["meta", { name: "apple-mobile-web-app-title", content: "NoneBot" }],
    ["meta", { name: "apple-mobile-web-app-capable", content: "yes" }],
    [
      "meta",
      { name: "apple-mobile-web-app-status-bar-style", content: "black" }
    ],
    [
      "link",
      { rel: "apple-touch-icon", href: "/icons/apple-touch-icon-180x180.png" }
    ],
    [
      "link",
      {
        rel: "mask-icon",
        href: "/icons/safari-pinned-tab.svg",
        color: "#ea5252"
      }
    ],
    [
      "meta",
      {
        name: "msapplication-TileImage",
        content: "/icons/mstile-150x150.png"
      }
    ],
    ["meta", { name: "msapplication-TileColor", content: "#ea5252" }],
    [
      "link",
      {
        rel: "stylesheet",
        href:
          "https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5/css/all.min.css"
      }
    ]
  ],
  locales: {
    "/": {
      lang: "zh-CN",
      title: "NoneBot",
      description: "基于 酷Q 的 Python 异步 QQ 机器人框架"
    }
  },

  theme: "nonebot",
  themeConfig: {
    logo: "/logo.png",
    repo: "nonebot/nonebot2",
    docsDir: "docs",
    docsBranch: "dev",
    docsDirVersioned: "archive",
    docsDirPages: "pages",
    editLinks: true,
    smoothScroll: true,

    locales: {
      "/": {
        label: "简体中文",
        selectText: "Languages",
        editLinkText: "在 GitHub 上编辑此页",
        lastUpdated: "上次更新",
        nav: [
          { text: "主页", link: "/" },
          { text: "指南", link: "/guide/" },
          { text: "进阶", link: "/advanced/" },
          { text: "API", link: "/api/" },
          { text: "插件广场", link: "/plugin-store" },
          { text: "更新日志", link: "/changelog" }
        ],
        sidebarDepth: 2,
        sidebar: {
          "/guide/": [
            {
              title: "开始",
              collapsable: false,
              sidebar: "auto",
              children: [
                "",
                "installation",
                "getting-started",
                "creating-a-project",
                "basic-configuration"
              ]
            },
            {
              title: "编写插件",
              collapsable: false,
              sidebar: "auto",
              children: [
                "loading-a-plugin",
                "creating-a-plugin",
                "creating-a-matcher",
                "creating-a-handler",
                "end-or-start"
              ]
            }
          ],
          "/advanced/": [
            {
              title: "进阶",
              collapsable: false,
              sidebar: "auto",
              children: [
                "",
                "scheduler",
                "permission",
                "runtime-hook",
                "export-and-require"
              ]
            }
          ],
          "/api/": [
            {
              title: "NoneBot Api Reference",
              path: "",
              collapsable: false,
              children: [
                {
                  title: "nonebot 模块",
                  path: "nonebot"
                },
                {
                  title: "nonebot.config 模块",
                  path: "config"
                },
                {
                  title: "nonebot.plugin 模块",
                  path: "plugin"
                },
                {
                  title: "nonebot.message 模块",
                  path: "message"
                },
                {
                  title: "nonebot.matcher 模块",
                  path: "matcher"
                },
                {
                  title: "nonebot.rule 模块",
                  path: "rule"
                },
                {
                  title: "nonebot.permission 模块",
                  path: "permission"
                },
                {
                  title: "nonebot.sched 模块",
                  path: "sched"
                },
                {
                  title: "nonebot.log 模块",
                  path: "log"
                },
                {
                  title: "nonebot.utils 模块",
                  path: "utils"
                },
                {
                  title: "nonebot.typing 模块",
                  path: "typing"
                },
                {
                  title: "nonebot.exception 模块",
                  path: "exception"
                },
                {
                  title: "nonebot.drivers 模块",
                  path: "drivers/"
                },
                {
                  title: "nonebot.drivers.fastapi 模块",
                  path: "drivers/fastapi"
                },
                {
                  title: "nonebot.adapters 模块",
                  path: "adapters/"
                },
                {
                  title: "nonebot.adapters.cqhttp 模块",
                  path: "adapters/cqhttp"
                }
              ]
            }
          ]
        }
      }
    }
  },

  plugins: [
    "@vuepress/plugin-back-to-top",
    "@vuepress/plugin-medium-zoom",
    [
      "@vuepress/pwa",
      {
        serviceWorker: true,
        updatePopup: {
          message: "发现新内容",
          buttonText: "刷新"
        }
      }
    ],
    [
      "versioning",
      {
        versionedSourceDir: path.resolve(context.sourceDir, "..", "archive"),
        pagesSourceDir: path.resolve(context.sourceDir, "..", "pages"),
        onNewVersion(version, versionDestPath) {
          console.log(`Created version ${version} in ${versionDestPath}`);
        }
      }
    ],
    [
      "container",
      {
        type: "vue",
        before: '<pre class="vue-container"><code>',
        after: "</code></pre>"
      }
    ]
  ]
});
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								const path = require("path");
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								module.exports = context => ({
-												:alien: update vuepress base

											
										
										
											2020-11-21 17:51:23 +00:00
+								  base: process.env.VUEPRESS_BASE || "/",
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								  title: "NoneBot",
 								  description: "基于 酷Q 的 Python 异步 QQ 机器人框架",
 								  markdown: {
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								    lineNumbers: true
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								  },
 								  /**
 								   * Extra tags to be injected to the page HTML `<head>`
 								   *
 								   * ref：https://v1.vuepress.vuejs.org/config/#head
 								   */
 								  head: [
 								    ["link", { rel: "icon", href: "/logo.png" }],
-												:zap: add site cache to improve performance #29

											
										
										
											2020-10-19 07:49:18 +00:00
+								    ["link", { rel: "manifest", href: "/manifest.json" }],
 								    ["meta", { name: "theme-color", content: "#ea5252" }],
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								    ["meta", { name: "application-name", content: "NoneBot" }],
 								    ["meta", { name: "apple-mobile-web-app-title", content: "NoneBot" }],
 								    ["meta", { name: "apple-mobile-web-app-capable", content: "yes" }],
 								    [
 								      "meta",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								      { name: "apple-mobile-web-app-status-bar-style", content: "black" }
-												:memo: add creating project

											
										
										
											2020-09-17 05:12:48 +00:00
+								    ],
-												:zap: add site cache to improve performance #29

											
										
										
											2020-10-19 07:49:18 +00:00
+								    [
 								      "link",
 								      { rel: "apple-touch-icon", href: "/icons/apple-touch-icon-180x180.png" }
 								    ],
 								    [
 								      "link",
 								      {
 								        rel: "mask-icon",
 								        href: "/icons/safari-pinned-tab.svg",
 								        color: "#ea5252"
 								      }
 								    ],
 								    [
 								      "meta",
 								      {
 								        name: "msapplication-TileImage",
 								        content: "/icons/mstile-150x150.png"
 								      }
 								    ],
 								    ["meta", { name: "msapplication-TileColor", content: "#ea5252" }],
-												:memo: add creating project

											
										
										
											2020-09-17 05:12:48 +00:00
+								    [
 								      "link",
 								      {
 								        rel: "stylesheet",
 								        href:
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								          "https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5/css/all.min.css"
 								      }
 								    ]
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								  ],
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								  locales: {
 								    "/": {
 								      lang: "zh-CN",
 								      title: "NoneBot",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								      description: "基于 酷Q 的 Python 异步 QQ 机器人框架"
 								    }
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								  },
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
-												:heavy_plus_sign: use custom theme

											
										
										
											2020-10-17 17:39:34 +00:00
+								  theme: "nonebot",
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								  themeConfig: {
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								    logo: "/logo.png",
-												:alien: update repo link

											
										
										
											2020-10-11 06:51:37 +00:00
+								    repo: "nonebot/nonebot2",
-												add auth check and config docs

											
										
										
											2020-08-20 08:34:07 +00:00
+								    docsDir: "docs",
-												:alien: update repo link

											
										
										
											2020-10-11 06:51:37 +00:00
+								    docsBranch: "dev",
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								    docsDirVersioned: "archive",
 								    docsDirPages: "pages",
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								    editLinks: true,
-												add auth check and config docs

											
										
										
											2020-08-20 08:34:07 +00:00
+								    smoothScroll: true,
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
 								    locales: {
 								      "/": {
 								        label: "简体中文",
 								        selectText: "Languages",
 								        editLinkText: "在 GitHub 上编辑此页",
 								        lastUpdated: "上次更新",
-												:memo: docs: guide, installation

											
										
										
											2020-09-12 05:45:03 +00:00
+								        nav: [
 								          { text: "主页", link: "/" },
 								          { text: "指南", link: "/guide/" },
-												:memo: add advanced and changelog

											
										
										
											2020-11-18 00:48:23 +00:00
+								          { text: "进阶", link: "/advanced/" },
-												:construction: add plugin store page

											
										
										
											2020-10-20 16:55:23 +00:00
+								          { text: "API", link: "/api/" },
-												:memo: add advanced and changelog

											
										
										
											2020-11-18 00:48:23 +00:00
+								          { text: "插件广场", link: "/plugin-store" },
 								          { text: "更新日志", link: "/changelog" }
-												:memo: docs: guide, installation

											
										
										
											2020-09-12 05:45:03 +00:00
+								        ],
-												:memo: add priority and block

											
										
										
											2020-09-22 07:41:56 +00:00
+								        sidebarDepth: 2,
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								        sidebar: {
-												:memo: docs: guide, installation

											
										
										
											2020-09-12 05:45:03 +00:00
+								          "/guide/": [
 								            {
-												:memo: add plugin load doc

											
										
										
											2020-11-07 04:36:47 +00:00
+								              title: "开始",
-												:memo: docs: guide, installation

											
										
										
											2020-09-12 05:45:03 +00:00
+								              collapsable: false,
 								              sidebar: "auto",
-												:memo: add creating project

											
										
										
											2020-09-17 05:12:48 +00:00
+								              children: [
 								                "",
 								                "installation",
 								                "getting-started",
-												:memo: add config guide

											
										
										
											2020-09-17 10:23:41 +00:00
+								                "creating-a-project",
-												:memo: add plugin load doc

											
										
										
											2020-11-07 04:36:47 +00:00
+								                "basic-configuration"
 								              ]
 								            },
 								            {
 								              title: "编写插件",
 								              collapsable: false,
 								              sidebar: "auto",
 								              children: [
 								                "loading-a-plugin",
-												:memo: add create matcher guide

											
										
										
											2020-11-09 04:47:59 +00:00
+								                "creating-a-plugin",
-												:memo: add create handler guide

											
										
										
											2020-11-10 06:30:18 +00:00
+								                "creating-a-matcher",
-												:memo: finish plugin guide

											
										
										
											2020-11-12 01:32:35 +00:00
+								                "creating-a-handler",
 								                "end-or-start"
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								              ]
 								            }
-												:memo: docs: guide, installation

											
										
										
											2020-09-12 05:45:03 +00:00
+								          ],
-												:memo: add advanced and changelog

											
										
										
											2020-11-18 00:48:23 +00:00
+								          "/advanced/": [
 								            {
 								              title: "进阶",
 								              collapsable: false,
 								              sidebar: "auto",
-												:memo: add cross plugin guide

											
										
										
											2020-11-23 05:41:57 +00:00
+								              children: [
 								                "",
 								                "scheduler",
 								                "permission",
 								                "runtime-hook",
 								                "export-and-require"
 								              ]
-												:memo: add advanced and changelog

											
										
										
											2020-11-18 00:48:23 +00:00
+								            }
 								          ],
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								          "/api/": [
-												add log and config docs

											
										
										
											2020-08-20 07:07:05 +00:00
+								            {
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								              title: "NoneBot Api Reference",
 								              path: "",
 								              collapsable: false,
 								              children: [
 								                {
 								                  title: "nonebot 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "nonebot"
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								                },
-												:bulb: add scheduler docstring

											
										
										
											2020-09-12 16:18:31 +00:00
+								                {
 								                  title: "nonebot.config 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "config"
-												:bulb: add scheduler docstring

											
										
										
											2020-09-12 16:18:31 +00:00
+								                },
-												:bulb: add plugin docstring

											
										
										
											2020-10-18 07:04:45 +00:00
+								                {
 								                  title: "nonebot.plugin 模块",
 								                  path: "plugin"
 								                },
-												:bulb: add message docstring

											
										
										
											2020-11-13 09:15:45 +00:00
+								                {
 								                  title: "nonebot.message 模块",
 								                  path: "message"
 								                },
-												:bulb: add scheduler docstring

											
										
										
											2020-09-12 16:18:31 +00:00
+								                {
-												:bulb: update docstring for several modules

											
										
										
											2020-10-05 18:08:48 +00:00
+								                  title: "nonebot.matcher 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "matcher"
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								                },
-												:bulb: add rule utils docstring

											
										
										
											2020-09-13 05:01:23 +00:00
+								                {
 								                  title: "nonebot.rule 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "rule"
-												:bulb: add rule utils docstring

											
										
										
											2020-09-13 05:01:23 +00:00
+								                },
-												:bulb: add permission docstring

											
										
										
											2020-09-14 12:48:03 +00:00
+								                {
 								                  title: "nonebot.permission 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "permission"
-												:bulb: add permission docstring

											
										
										
											2020-09-14 12:48:03 +00:00
+								                },
-												:bulb: update docstring for several modules

											
										
										
											2020-10-05 18:08:48 +00:00
+								                {
 								                  title: "nonebot.sched 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "sched"
-												:bulb: update docstring for several modules

											
										
										
											2020-10-05 18:08:48 +00:00
+								                },
 								                {
 								                  title: "nonebot.log 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "log"
-												:bulb: update docstring for several modules

											
										
										
											2020-10-05 18:08:48 +00:00
+								                },
-												:bulb: add utils docstring

											
										
										
											2020-09-12 16:43:31 +00:00
+								                {
 								                  title: "nonebot.utils 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "utils"
-												:bulb: add utils docstring

											
										
										
											2020-09-12 16:43:31 +00:00
+								                },
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								                {
-												:bulb: update docstring for several modules

											
										
										
											2020-10-05 18:08:48 +00:00
+								                  title: "nonebot.typing 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "typing"
-												:bulb: update docstring for several modules

											
										
										
											2020-10-05 18:08:48 +00:00
+								                },
 								                {
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								                  title: "nonebot.exception 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "exception"
-												:bulb: add cqhttp docstring

											
										
										
											2020-09-29 14:33:08 +00:00
+								                },
-												:memo: Update docs

											
										
										
											2020-10-11 05:17:40 +00:00
+								                {
 								                  title: "nonebot.drivers 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "drivers/"
-												:memo: Update docs

											
										
										
											2020-10-11 05:17:40 +00:00
+								                },
 								                {
 								                  title: "nonebot.drivers.fastapi 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "drivers/fastapi"
-												:memo: Update docs

											
										
										
											2020-10-11 05:17:40 +00:00
+								                },
-												:bulb: add cqhttp event

											
										
										
											2020-09-29 15:10:29 +00:00
+								                {
 								                  title: "nonebot.adapters 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "adapters/"
-												:bulb: add cqhttp event

											
										
										
											2020-09-29 15:10:29 +00:00
+								                },
-												:bulb: add cqhttp docstring

											
										
										
											2020-09-29 14:33:08 +00:00
+								                {
 								                  title: "nonebot.adapters.cqhttp 模块",
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								                  path: "adapters/cqhttp"
 								                }
 								              ]
 								            }
 								          ]
 								        }
 								      }
 								    }
-												add autodoc support

											
										
										
											2020-06-30 04:10:57 +00:00
+								  },
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								  plugins: [
 								    "@vuepress/plugin-back-to-top",
 								    "@vuepress/plugin-medium-zoom",
-												:zap: add site cache to improve performance #29

											
										
										
											2020-10-19 07:49:18 +00:00
+								    [
 								      "@vuepress/pwa",
 								      {
 								        serviceWorker: true,
 								        updatePopup: {
 								          message: "发现新内容",
 								          buttonText: "刷新"
 								        }
 								      }
 								    ],
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								    [
 								      "versioning",
 								      {
 								        versionedSourceDir: path.resolve(context.sourceDir, "..", "archive"),
 								        pagesSourceDir: path.resolve(context.sourceDir, "..", "pages"),
 								        onNewVersion(version, versionDestPath) {
 								          console.log(`Created version ${version} in ${versionDestPath}`);
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								        }
 								      }
-												:memo: add creating project

											
										
										
											2020-09-17 05:12:48 +00:00
+								    ],
 								    [
 								      "container",
 								      {
 								        type: "vue",
 								        before: '<pre class="vue-container"><code>',
-												:alien: fix theme smooth scroll

											
										
										
											2020-10-17 18:30:01 +00:00
+								        after: "</code></pre>"
 								      }
 								    ]
 								  ]
-												do some changes to vuepress docs

											
										
										
											2020-08-23 09:03:59 +00:00
+								});