mirror of
https://github.com/nonebot/nonebot2.git
synced 2024-12-01 01:25:07 +08:00
do some changes to vuepress docs
This commit is contained in:
parent
599844d3ca
commit
93e06ec266
@ -1,4 +1,6 @@
|
|||||||
module.exports = {
|
const path = require("path");
|
||||||
|
|
||||||
|
module.exports = context => ({
|
||||||
title: "NoneBot",
|
title: "NoneBot",
|
||||||
description: "基于 酷Q 的 Python 异步 QQ 机器人框架",
|
description: "基于 酷Q 的 Python 异步 QQ 机器人框架",
|
||||||
markdown: {
|
markdown: {
|
||||||
@ -20,54 +22,79 @@ module.exports = {
|
|||||||
{ name: "apple-mobile-web-app-status-bar-style", content: "black" }
|
{ name: "apple-mobile-web-app-status-bar-style", content: "black" }
|
||||||
]
|
]
|
||||||
],
|
],
|
||||||
|
locales: {
|
||||||
themeConfig: {
|
"/": {
|
||||||
repo: "nonebot/nonebot",
|
lang: "zh-CN",
|
||||||
docsDir: "docs",
|
title: "NoneBot",
|
||||||
docsBranch: "dev2",
|
description: "基于 酷Q 的 Python 异步 QQ 机器人框架"
|
||||||
editLinks: true,
|
|
||||||
editLinkText: "在 GitHub 上编辑此页",
|
|
||||||
lastUpdated: "上次更新",
|
|
||||||
smoothScroll: true,
|
|
||||||
nav: [{ text: "API", link: "/api/" }],
|
|
||||||
sidebar: {
|
|
||||||
"/api/": [
|
|
||||||
{
|
|
||||||
title: "NoneBot Api Reference",
|
|
||||||
path: "",
|
|
||||||
collapsable: false,
|
|
||||||
sidebarDepth: 3,
|
|
||||||
children: [
|
|
||||||
{
|
|
||||||
title: "nonebot 模块",
|
|
||||||
path: "nonebot",
|
|
||||||
sidebar: "auto"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: "nonebot.typing 模块",
|
|
||||||
path: "typing",
|
|
||||||
sidebar: "auto"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: "nonebot.log 模块",
|
|
||||||
path: "log",
|
|
||||||
sidebar: "auto"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: "nonebot.exception 模块",
|
|
||||||
path: "exception",
|
|
||||||
sidebar: "auto"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
title: "nonebot.config 模块",
|
|
||||||
path: "config",
|
|
||||||
sidebar: "auto"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
plugins: ["@vuepress/plugin-back-to-top", "@vuepress/plugin-medium-zoom"]
|
theme: "titanium",
|
||||||
};
|
themeConfig: {
|
||||||
|
logo: "/logo.png",
|
||||||
|
repo: "nonebot/nonebot",
|
||||||
|
docsDir: "docs",
|
||||||
|
docsBranch: "dev2",
|
||||||
|
docsDirVersioned: "archive",
|
||||||
|
docsDirPages: "pages",
|
||||||
|
editLinks: true,
|
||||||
|
smoothScroll: true,
|
||||||
|
|
||||||
|
locales: {
|
||||||
|
"/": {
|
||||||
|
label: "简体中文",
|
||||||
|
selectText: "Languages",
|
||||||
|
editLinkText: "在 GitHub 上编辑此页",
|
||||||
|
lastUpdated: "上次更新",
|
||||||
|
nav: [{ text: "API", link: "/api/" }],
|
||||||
|
sidebar: {
|
||||||
|
"/api/": [
|
||||||
|
{
|
||||||
|
title: "NoneBot Api Reference",
|
||||||
|
path: "",
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
{
|
||||||
|
title: "nonebot 模块",
|
||||||
|
path: "nonebot"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "nonebot.typing 模块",
|
||||||
|
path: "typing"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "nonebot.log 模块",
|
||||||
|
path: "log"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "nonebot.exception 模块",
|
||||||
|
path: "exception"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "nonebot.config 模块",
|
||||||
|
path: "config"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
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}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
]
|
||||||
|
});
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
# NoneBot.config 模块
|
# NoneBot.config 模块
|
||||||
|
|
||||||
## 配置
|
## 配置
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
# NoneBot.exception 模块
|
# NoneBot.exception 模块
|
||||||
|
|
||||||
## 异常
|
## 异常
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
# NoneBot.log 模块
|
# NoneBot.log 模块
|
||||||
|
|
||||||
## 日志
|
## 日志
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
# NoneBot 模块
|
# NoneBot 模块
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
# NoneBot.typing 模块
|
# NoneBot.typing 模块
|
||||||
|
|
||||||
## 类型
|
## 类型
|
||||||
|
@ -10,9 +10,9 @@
|
|||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
#
|
#
|
||||||
# import os
|
import os
|
||||||
# import sys
|
import sys
|
||||||
# sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
|
sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(__file__))))
|
||||||
|
|
||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
NoneBot.config 模块
|
NoneBot.config 模块
|
||||||
===================
|
===================
|
||||||
|
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
NoneBot.exception 模块
|
NoneBot.exception 模块
|
||||||
======================
|
======================
|
||||||
|
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
NoneBot.log 模块
|
NoneBot.log 模块
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
NoneBot 模块
|
NoneBot 模块
|
||||||
===============
|
===============
|
||||||
|
|
||||||
|
@ -1,3 +1,8 @@
|
|||||||
|
---
|
||||||
|
contentSidebar: true
|
||||||
|
sidebarDepth: 0
|
||||||
|
---
|
||||||
|
|
||||||
NoneBot.typing 模块
|
NoneBot.typing 模块
|
||||||
===================
|
===================
|
||||||
|
|
||||||
|
50
package-lock.json
generated
50
package-lock.json
generated
@ -10157,6 +10157,56 @@
|
|||||||
"smoothscroll-polyfill": "^0.4.3"
|
"smoothscroll-polyfill": "^0.4.3"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"vuepress-plugin-versioning": {
|
||||||
|
"version": "4.5.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/vuepress-plugin-versioning/-/vuepress-plugin-versioning-4.5.0.tgz",
|
||||||
|
"integrity": "sha512-tnth/oXq5yqTHvfbSfl1GaPIQcr8ckSDX+wyecnm3tS/FSaZH55Fb8wPwhdM2jEEXWPe6DpQCh9O7fvsthIvRQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"@vuepress/shared-utils": "^1.5.2",
|
||||||
|
"fs-extra": "^8.1.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"fs-extra": {
|
||||||
|
"version": "8.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz",
|
||||||
|
"integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"graceful-fs": "^4.2.0",
|
||||||
|
"jsonfile": "^4.0.0",
|
||||||
|
"universalify": "^0.1.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"vuepress-theme-titanium": {
|
||||||
|
"version": "4.5.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/vuepress-theme-titanium/-/vuepress-theme-titanium-4.5.1.tgz",
|
||||||
|
"integrity": "sha512-yWDbv4Omwk611ftN0WEAf30n4dE0TbyH7ROPYTt3u185hhE8qRiba9HJBwm8CU2CKfp+Yjv5y24V/OHGfSqJzQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"@vuepress/plugin-nprogress": "^1.5.2",
|
||||||
|
"@vuepress/plugin-search": "^1.5.2",
|
||||||
|
"docsearch.js": "^2.6.3",
|
||||||
|
"lodash": "^4.17.15",
|
||||||
|
"stylus": "^0.54.5",
|
||||||
|
"stylus-loader": "^3.0.2",
|
||||||
|
"vuepress-plugin-container": "^2.0.2",
|
||||||
|
"vuepress-plugin-smooth-scroll": "^0.0.9"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"vuepress-plugin-smooth-scroll": {
|
||||||
|
"version": "0.0.9",
|
||||||
|
"resolved": "https://registry.npmjs.org/vuepress-plugin-smooth-scroll/-/vuepress-plugin-smooth-scroll-0.0.9.tgz",
|
||||||
|
"integrity": "sha512-UXX+HLZO1NKVwyiOJlj0smh8F9dKnwybjEi7w/Mj9EYLhKrNYr5uXs+N+OTt8VwKCn3f0vZ1XAwFIjsPlD7GJA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"smoothscroll-polyfill": "^0.4.4"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"watchpack": {
|
"watchpack": {
|
||||||
"version": "1.7.4",
|
"version": "1.7.4",
|
||||||
"resolved": "https://registry.npmjs.org/watchpack/-/watchpack-1.7.4.tgz",
|
"resolved": "https://registry.npmjs.org/watchpack/-/watchpack-1.7.4.tgz",
|
||||||
|
@ -24,8 +24,10 @@
|
|||||||
},
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"vuepress": "^1.3.1",
|
|
||||||
"@vuepress/plugin-back-to-top": "^1.3.1",
|
"@vuepress/plugin-back-to-top": "^1.3.1",
|
||||||
"@vuepress/plugin-medium-zoom": "^1.3.1"
|
"@vuepress/plugin-medium-zoom": "^1.3.1",
|
||||||
|
"vuepress": "^1.3.1",
|
||||||
|
"vuepress-plugin-versioning": "^4.5.0",
|
||||||
|
"vuepress-theme-titanium": "^4.5.1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user