nonebot2/docs/.vuepress/config.js
2021-07-31 12:24:11 +08:00

287 lines
7.7 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

const path = require("path");
module.exports = (context) => ({
base: process.env.VUEPRESS_BASE || "/",
title: "NoneBot",
description: "跨平台 Python 异步 QQ 机器人框架",
markdown: {
lineNumbers: true,
},
/**
* 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" }],
["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: "跨平台 Python 异步 QQ 机器人框架",
},
},
theme: "nonebot",
themeConfig: {
logo: "/logo.png",
repo: "nonebot/nonebot2",
docsDir: "docs",
docsBranch: "dev",
docsDirVersioned: "archive",
docsDirPages: "pages",
editLinks: true,
smoothScroll: true,
algolia: {
apiKey: "ef449608d0ad6e81b9efd05db6367040",
indexName: "nonebot",
algoliaOptions: {
facetFilters: ["lang:zh-CN"],
},
},
locales: {
"/": {
label: "简体中文",
selectText: "Languages",
editLinkText: "在 GitHub 上编辑此页",
lastUpdated: "上次更新",
nav: [
{ text: "主页", link: "/" },
{ text: "指南", link: "/guide/" },
{ text: "进阶", link: "/advanced/" },
{ text: "API", link: "/api/" },
{ text: "商店", link: "/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",
],
},
{
title: "协议适配",
collapsable: false,
sidebar: "auto",
children: [
"cqhttp-guide",
"ding-guide",
"mirai-guide",
"feishu-guide",
],
},
],
"/advanced/": [
{
title: "进阶",
collapsable: false,
sidebar: "auto",
children: [
"",
"scheduler",
"permission",
"runtime-hook",
"export-and-require",
"overloaded-handlers",
],
},
{
title: "发布",
collapsable: false,
sidebar: "auto",
children: ["publish-plugin"],
},
],
"/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.handler 模块",
path: "handler",
},
{
title: "nonebot.rule 模块",
path: "rule",
},
{
title: "nonebot.permission 模块",
path: "permission",
},
{
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.drivers.quart 模块",
path: "drivers/quart",
},
{
title: "nonebot.drivers.aiohttp 模块",
path: "drivers/aiohttp",
},
{
title: "nonebot.adapters 模块",
path: "adapters/",
},
{
title: "nonebot.adapters.cqhttp 模块",
path: "adapters/cqhttp",
},
{
title: "nonebot.adapters.ding 模块",
path: "adapters/ding",
},
{
title: "nonebot.adapters.mirai 模块",
path: "adapters/mirai",
},
{
title: "nonebot.adapters.feishu 模块",
path: "adapters/feishu",
},
],
},
],
},
},
},
},
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>",
},
],
],
});