ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-28 08:12:14 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
8db70dbb0c
nonebot2/docs/.vuepress/config.js

174 lines
4.5 KiB
JavaScript
Raw Normal View History

do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
const path = require("path");
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
module.exports = context => ({
add autodoc support
2020-06-30 12:10:57 +08:00
title: "NoneBot",
description: "基于 酷Q 的 Python 异步 QQ 机器人框架",
markdown: {
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
lineNumbers: true
add autodoc support
2020-06-30 12:10:57 +08: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" }],
["meta", { name: "theme-color", content: "#d32f2f" }],
["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-18 02:30:01 +08:00
{ name: "apple-mobile-web-app-status-bar-style", content: "black" }
:memo: add creating project
2020-09-17 13:12:48 +08:00
],
[
"link",
{
rel: "stylesheet",
href:
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
"https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5/css/all.min.css"
}
]
add autodoc support
2020-06-30 12:10:57 +08:00
],
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
locales: {
"/": {
lang: "zh-CN",
title: "NoneBot",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
description: "基于 酷Q 的 Python 异步 QQ 机器人框架"
}
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
},
add autodoc support
2020-06-30 12:10:57 +08:00
:heavy_plus_sign: use custom theme
2020-10-18 01:39:34 +08:00
theme: "nonebot",
add autodoc support
2020-06-30 12:10:57 +08:00
themeConfig: {
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
logo: "/logo.png",
:alien: update repo link
2020-10-11 14:51:37 +08:00
repo: "nonebot/nonebot2",
add auth check and config docs
2020-08-20 16:34:07 +08:00
docsDir: "docs",
:alien: update repo link
2020-10-11 14:51:37 +08:00
docsBranch: "dev",
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
docsDirVersioned: "archive",
docsDirPages: "pages",
add autodoc support
2020-06-30 12:10:57 +08:00
editLinks: true,
add auth check and config docs
2020-08-20 16:34:07 +08:00
smoothScroll: true,
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
locales: {
"/": {
label: "简体中文",
selectText: "Languages",
editLinkText: "在 GitHub 上编辑此页",
lastUpdated: "上次更新",
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
nav: [
{ text: "主页", link: "/" },
{ text: "指南", link: "/guide/" },
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
{ text: "API", link: "/api/" }
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
],
:memo: add priority and block
2020-09-22 15:41:56 +08:00
sidebarDepth: 2,
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
sidebar: {
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
"/guide/": [
{
title: "指南",
path: "",
collapsable: false,
sidebar: "auto",
:memo: add creating project
2020-09-17 13:12:48 +08:00
children: [
"",
"installation",
"getting-started",
:memo: add config guide
2020-09-17 18:23:41 +08:00
"creating-a-project",
:memo: add plugin guide
2020-09-19 22:08:06 +08:00
"basic-configuration",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
"writing-a-plugin"
]
}
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
],
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
"/api/": [
add log and config docs
2020-08-20 15:07:05 +08:00
{
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
title: "NoneBot Api Reference",
path: "",
collapsable: false,
children: [
{
title: "nonebot 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "nonebot"
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
},
:bulb: add scheduler docstring
2020-09-13 00:18:31 +08:00
{
title: "nonebot.config 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "config"
:bulb: add scheduler docstring
2020-09-13 00:18:31 +08:00
},
{
:bulb: update docstring for several modules
2020-10-06 02:08:48 +08:00
title: "nonebot.matcher 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "matcher"
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
},
:bulb: add rule utils docstring
2020-09-13 13:01:23 +08:00
{
title: "nonebot.rule 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "rule"
:bulb: add rule utils docstring
2020-09-13 13:01:23 +08:00
},
:bulb: add permission docstring
2020-09-14 20:48:03 +08:00
{
title: "nonebot.permission 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "permission"
:bulb: add permission docstring
2020-09-14 20:48:03 +08:00
},
:bulb: update docstring for several modules
2020-10-06 02:08:48 +08:00
{
title: "nonebot.sched 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "sched"
:bulb: update docstring for several modules
2020-10-06 02:08:48 +08:00
},
{
title: "nonebot.log 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "log"
:bulb: update docstring for several modules
2020-10-06 02:08:48 +08:00
},
:bulb: add utils docstring
2020-09-13 00:43:31 +08:00
{
title: "nonebot.utils 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "utils"
:bulb: add utils docstring
2020-09-13 00:43:31 +08:00
},
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
{
:bulb: update docstring for several modules
2020-10-06 02:08:48 +08:00
title: "nonebot.typing 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "typing"
:bulb: update docstring for several modules
2020-10-06 02:08:48 +08:00
},
{
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
title: "nonebot.exception 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "exception"
:bulb: add cqhttp docstring
2020-09-29 22:33:08 +08:00
},
:memo: Update docs
2020-10-11 13:17:40 +08:00
{
title: "nonebot.drivers 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "drivers/"
:memo: Update docs
2020-10-11 13:17:40 +08:00
},
{
title: "nonebot.drivers.fastapi 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "drivers/fastapi"
:memo: Update docs
2020-10-11 13:17:40 +08:00
},
:bulb: add cqhttp event
2020-09-29 23:10:29 +08:00
{
title: "nonebot.adapters 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "adapters/"
:bulb: add cqhttp event
2020-09-29 23:10:29 +08:00
},
:bulb: add cqhttp docstring
2020-09-29 22:33:08 +08:00
{
title: "nonebot.adapters.cqhttp 模块",
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
path: "adapters/cqhttp"
}
]
}
]
}
}
}
add autodoc support
2020-06-30 12:10:57 +08:00
},
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
plugins: [
"@vuepress/plugin-back-to-top",
"@vuepress/plugin-medium-zoom",
[
"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-18 02:30:01 +08:00
}
}
:memo: add creating project
2020-09-17 13:12:48 +08:00
],
[
"container",
{
type: "vue",
before: '<pre class="vue-container"><code>',
:alien: fix theme smooth scroll
2020-10-18 02:30:01 +08:00
after: "</code></pre>"
}
]
]
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
});
Reference in New Issue Copy Permalink