nonebot2/docs/.vuepress/config.js

258 lines
6.8 KiB
JavaScript
Raw Normal View History

2020-08-23 17:03:59 +08:00
const path = require("path");
2021-02-01 20:58:12 +08:00
module.exports = context => ({
2020-11-22 01:51:23 +08:00
base: process.env.VUEPRESS_BASE || "/",
2020-06-30 12:10:57 +08:00
title: "NoneBot",
2021-02-02 19:34:03 +08:00
description: "基于 OneBot 标准的 Python 异步 QQ 机器人框架",
2020-06-30 12:10:57 +08:00
markdown: {
2021-02-01 20:58:12 +08:00
lineNumbers: true
2020-06-30 12:10:57 +08:00
},
/**
* Extra tags to be injected to the page HTML `<head>`
*
* refhttps://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" }],
2020-06-30 12:10:57 +08: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",
2021-02-01 20:58:12 +08:00
{ name: "apple-mobile-web-app-status-bar-style", content: "black" }
2020-09-17 13:12:48 +08:00
],
[
"link",
2021-02-01 20:58:12 +08:00
{ rel: "apple-touch-icon", href: "/icons/apple-touch-icon-180x180.png" }
],
[
"link",
{
rel: "mask-icon",
href: "/icons/safari-pinned-tab.svg",
2021-02-01 20:58:12 +08:00
color: "#ea5252"
}
],
[
"meta",
{
name: "msapplication-TileImage",
2021-02-01 20:58:12 +08:00
content: "/icons/mstile-150x150.png"
}
],
["meta", { name: "msapplication-TileColor", content: "#ea5252" }],
2020-09-17 13:12:48 +08:00
[
"link",
{
rel: "stylesheet",
href:
2021-02-01 20:58:12 +08:00
"https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5/css/all.min.css"
}
]
2020-06-30 12:10:57 +08:00
],
2020-08-23 17:03:59 +08:00
locales: {
"/": {
lang: "zh-CN",
title: "NoneBot",
2021-02-02 19:34:03 +08:00
description: "基于 OneBot 标准的 Python 异步 QQ 机器人框架"
2021-02-01 20:58:12 +08:00
}
2020-08-23 17:03:59 +08:00
},
2020-06-30 12:10:57 +08:00
2020-10-18 01:39:34 +08:00
theme: "nonebot",
2020-06-30 12:10:57 +08:00
themeConfig: {
2020-08-23 17:03:59 +08:00
logo: "/logo.png",
2020-10-11 14:51:37 +08:00
repo: "nonebot/nonebot2",
2020-08-20 16:34:07 +08:00
docsDir: "docs",
2020-10-11 14:51:37 +08:00
docsBranch: "dev",
2020-08-23 17:03:59 +08:00
docsDirVersioned: "archive",
docsDirPages: "pages",
2020-06-30 12:10:57 +08:00
editLinks: true,
2020-08-20 16:34:07 +08:00
smoothScroll: true,
2020-08-23 17:03:59 +08:00
locales: {
"/": {
label: "简体中文",
selectText: "Languages",
editLinkText: "在 GitHub 上编辑此页",
lastUpdated: "上次更新",
2020-09-12 13:45:03 +08:00
nav: [
{ text: "主页", link: "/" },
{ text: "指南", link: "/guide/" },
2020-11-18 08:48:23 +08:00
{ text: "进阶", link: "/advanced/" },
2020-10-21 00:55:23 +08:00
{ text: "API", link: "/api/" },
2020-11-18 08:48:23 +08:00
{ text: "插件广场", link: "/plugin-store" },
2021-02-01 20:58:12 +08:00
{ text: "更新日志", link: "/changelog" }
2020-09-12 13:45:03 +08:00
],
2020-09-22 15:41:56 +08:00
sidebarDepth: 2,
2020-08-23 17:03:59 +08:00
sidebar: {
2020-09-12 13:45:03 +08:00
"/guide/": [
{
2020-11-07 12:36:47 +08:00
title: "开始",
2020-09-12 13:45:03 +08:00
collapsable: false,
sidebar: "auto",
2020-09-17 13:12:48 +08:00
children: [
"",
"installation",
"getting-started",
2020-09-17 18:23:41 +08:00
"creating-a-project",
2021-02-01 20:58:12 +08:00
"basic-configuration"
]
2020-11-07 12:36:47 +08:00
},
{
title: "编写插件",
collapsable: false,
sidebar: "auto",
children: [
"loading-a-plugin",
2020-11-09 12:47:59 +08:00
"creating-a-plugin",
2020-11-10 14:30:18 +08:00
"creating-a-matcher",
2020-11-12 09:32:35 +08:00
"creating-a-handler",
2021-02-01 20:58:12 +08:00
"end-or-start"
]
2020-12-31 17:58:09 +08:00
},
{
title: "协议适配",
collapsable: false,
sidebar: "auto",
2021-02-01 20:58:12 +08:00
children: ["cqhttp-guide", "ding-guide", "mirai-guide"]
}
2020-09-12 13:45:03 +08:00
],
2020-11-18 08:48:23 +08:00
"/advanced/": [
{
title: "进阶",
collapsable: false,
sidebar: "auto",
2020-11-23 13:41:57 +08:00
children: [
"",
"scheduler",
"permission",
"runtime-hook",
2020-12-22 09:59:48 +08:00
"export-and-require",
2021-02-01 20:58:12 +08:00
"overloaded-handlers"
]
2020-11-23 13:46:36 +08:00
},
{
title: "发布",
collapsable: false,
sidebar: "auto",
2021-02-01 20:58:12 +08:00
children: ["publish-plugin"]
}
2020-11-18 08:48:23 +08:00
],
2020-08-23 17:03:59 +08:00
"/api/": [
2020-08-20 15:07:05 +08:00
{
2020-08-23 17:03:59 +08:00
title: "NoneBot Api Reference",
path: "",
collapsable: false,
children: [
{
title: "nonebot 模块",
2021-02-01 20:58:12 +08:00
path: "nonebot"
2020-08-23 17:03:59 +08:00
},
2020-09-13 00:18:31 +08:00
{
title: "nonebot.config 模块",
2021-02-01 20:58:12 +08:00
path: "config"
2020-09-13 00:18:31 +08:00
},
2020-10-18 15:04:45 +08:00
{
title: "nonebot.plugin 模块",
2021-02-01 20:58:12 +08:00
path: "plugin"
2020-10-18 15:04:45 +08:00
},
2020-11-13 17:15:45 +08:00
{
title: "nonebot.message 模块",
2021-02-01 20:58:12 +08:00
path: "message"
2020-11-13 17:15:45 +08:00
},
2020-09-13 00:18:31 +08:00
{
title: "nonebot.matcher 模块",
2021-02-01 20:58:12 +08:00
path: "matcher"
2020-08-23 17:03:59 +08:00
},
2020-09-13 13:01:23 +08:00
{
title: "nonebot.rule 模块",
2021-02-01 20:58:12 +08:00
path: "rule"
2020-09-13 13:01:23 +08:00
},
2020-09-14 20:48:03 +08:00
{
title: "nonebot.permission 模块",
2021-02-01 20:58:12 +08:00
path: "permission"
2020-09-14 20:48:03 +08:00
},
{
title: "nonebot.log 模块",
2021-02-01 20:58:12 +08:00
path: "log"
},
2020-09-13 00:43:31 +08:00
{
title: "nonebot.utils 模块",
2021-02-01 20:58:12 +08:00
path: "utils"
2020-09-13 00:43:31 +08:00
},
2020-08-23 17:03:59 +08:00
{
title: "nonebot.typing 模块",
2021-02-01 20:58:12 +08:00
path: "typing"
},
{
2020-08-23 17:03:59 +08:00
title: "nonebot.exception 模块",
2021-02-01 20:58:12 +08:00
path: "exception"
2020-09-29 22:33:08 +08:00
},
2020-10-11 13:17:40 +08:00
{
title: "nonebot.drivers 模块",
2021-02-01 20:58:12 +08:00
path: "drivers/"
2020-10-11 13:17:40 +08:00
},
{
title: "nonebot.drivers.fastapi 模块",
2021-02-01 20:58:12 +08:00
path: "drivers/fastapi"
2020-10-11 13:17:40 +08:00
},
2020-09-29 23:10:29 +08:00
{
title: "nonebot.adapters 模块",
2021-02-01 20:58:12 +08:00
path: "adapters/"
2020-09-29 23:10:29 +08:00
},
2020-09-29 22:33:08 +08:00
{
title: "nonebot.adapters.cqhttp 模块",
2021-02-01 20:58:12 +08:00
path: "adapters/cqhttp"
2020-12-03 16:04:14 +08:00
},
{
title: "nonebot.adapters.ding 模块",
2021-02-01 20:58:12 +08:00
path: "adapters/ding"
},
{
title: "nonebot.adapters.mirai 模块",
2021-02-01 20:58:12 +08:00
path: "adapters/mirai"
}
]
}
]
}
}
}
2020-06-30 12:10:57 +08:00
},
2020-08-23 17:03:59 +08:00
plugins: [
"@vuepress/plugin-back-to-top",
"@vuepress/plugin-medium-zoom",
[
"@vuepress/pwa",
{
serviceWorker: true,
updatePopup: {
message: "发现新内容",
2021-02-01 20:58:12 +08:00
buttonText: "刷新"
}
}
],
2020-08-23 17:03:59 +08:00
[
"versioning",
{
versionedSourceDir: path.resolve(context.sourceDir, "..", "archive"),
pagesSourceDir: path.resolve(context.sourceDir, "..", "pages"),
onNewVersion(version, versionDestPath) {
console.log(`Created version ${version} in ${versionDestPath}`);
2021-02-01 20:58:12 +08:00
}
}
2020-09-17 13:12:48 +08:00
],
[
"container",
{
type: "vue",
before: '<pre class="vue-container"><code>',
2021-02-01 20:58:12 +08:00
after: "</code></pre>"
}
]
]
2020-08-23 17:03:59 +08:00
});