From 93e06ec266bbe9a424bdca64c74700ddb1451017 Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Sun, 23 Aug 2020 17:03:59 +0800 Subject: [PATCH] do some changes to vuepress docs --- docs/.vuepress/config.js | 125 ++++++++++++++++++++++++--------------- docs/api/config.md | 5 ++ docs/api/exception.md | 5 ++ docs/api/log.md | 5 ++ docs/api/nonebot.md | 5 ++ docs/api/typing.md | 5 ++ docs_build/conf.py | 6 +- docs_build/config.rst | 5 ++ docs_build/exception.rst | 5 ++ docs_build/log.rst | 5 ++ docs_build/nonebot.rst | 5 ++ docs_build/typing.rst | 5 ++ package-lock.json | 50 ++++++++++++++++ package.json | 6 +- 14 files changed, 183 insertions(+), 54 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 9c60473c..8f76a704 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,4 +1,6 @@ -module.exports = { +const path = require("path"); + +module.exports = context => ({ title: "NoneBot", description: "基于 酷Q 的 Python 异步 QQ 机器人框架", markdown: { @@ -20,54 +22,79 @@ module.exports = { { name: "apple-mobile-web-app-status-bar-style", content: "black" } ] ], - - themeConfig: { - repo: "nonebot/nonebot", - docsDir: "docs", - docsBranch: "dev2", - 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" - } - ] - } - ] + locales: { + "/": { + lang: "zh-CN", + title: "NoneBot", + description: "基于 酷Q 的 Python 异步 QQ 机器人框架" } }, - 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}`); + } + } + ] + ] +}); diff --git a/docs/api/config.md b/docs/api/config.md index 2d971fe3..9fe3464e 100644 --- a/docs/api/config.md +++ b/docs/api/config.md @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + # NoneBot.config 模块 ## 配置 diff --git a/docs/api/exception.md b/docs/api/exception.md index dd8bf049..2c7abad1 100644 --- a/docs/api/exception.md +++ b/docs/api/exception.md @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + # NoneBot.exception 模块 ## 异常 diff --git a/docs/api/log.md b/docs/api/log.md index d6f6048d..ecc3bdc3 100644 --- a/docs/api/log.md +++ b/docs/api/log.md @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + # NoneBot.log 模块 ## 日志 diff --git a/docs/api/nonebot.md b/docs/api/nonebot.md index 77a17cff..8dcd0c20 100644 --- a/docs/api/nonebot.md +++ b/docs/api/nonebot.md @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + # NoneBot 模块 diff --git a/docs/api/typing.md b/docs/api/typing.md index 71833b7a..92eb4fe4 100644 --- a/docs/api/typing.md +++ b/docs/api/typing.md @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + # NoneBot.typing 模块 ## 类型 diff --git a/docs_build/conf.py b/docs_build/conf.py index 3f440fc7..5ac18b11 100644 --- a/docs_build/conf.py +++ b/docs_build/conf.py @@ -10,9 +10,9 @@ # 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. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(__file__)))) +import os +import sys +sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(__file__)))) # -- Project information ----------------------------------------------------- diff --git a/docs_build/config.rst b/docs_build/config.rst index a9e7bc21..7354a565 100644 --- a/docs_build/config.rst +++ b/docs_build/config.rst @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + NoneBot.config 模块 =================== diff --git a/docs_build/exception.rst b/docs_build/exception.rst index 443d4ec4..7b643758 100644 --- a/docs_build/exception.rst +++ b/docs_build/exception.rst @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + NoneBot.exception 模块 ====================== diff --git a/docs_build/log.rst b/docs_build/log.rst index d6839fc6..49799128 100644 --- a/docs_build/log.rst +++ b/docs_build/log.rst @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + NoneBot.log 模块 ================= diff --git a/docs_build/nonebot.rst b/docs_build/nonebot.rst index f921b3a5..1e8f5107 100644 --- a/docs_build/nonebot.rst +++ b/docs_build/nonebot.rst @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + NoneBot 模块 =============== diff --git a/docs_build/typing.rst b/docs_build/typing.rst index 8b927eaa..211cb6fa 100644 --- a/docs_build/typing.rst +++ b/docs_build/typing.rst @@ -1,3 +1,8 @@ +--- +contentSidebar: true +sidebarDepth: 0 +--- + NoneBot.typing 模块 =================== diff --git a/package-lock.json b/package-lock.json index 73b801e1..f6a0c4db 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10157,6 +10157,56 @@ "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": { "version": "1.7.4", "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-1.7.4.tgz", diff --git a/package.json b/package.json index c2a0698a..571e6731 100644 --- a/package.json +++ b/package.json @@ -24,8 +24,10 @@ }, "license": "MIT", "devDependencies": { - "vuepress": "^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" } }