ProjectHentai/nonebot2
6
0
Fork 0
mirror of https://github.com/nonebot/nonebot2.git synced 2024-11-24 17:15:05 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
cda1ad093f
nonebot2/docs/.vuepress/config.js

287 lines
7.7 KiB
JavaScript
Raw Normal View History

do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
const path = require("path");
📝 update index
2021-07-14 10:42:47 +08:00
module.exports = (context) => ({
:alien: update vuepress base
2020-11-22 01:51:23 +08:00
base: process.env.VUEPRESS_BASE || "/",
add autodoc support
2020-06-30 12:10:57 +08:00
title: "NoneBot",
:memo: update doc
2021-02-02 21:55:18 +08:00
description: "跨平台 Python 异步 QQ 机器人框架",
add autodoc support
2020-06-30 12:10:57 +08:00
markdown: {
📝 update index
2021-07-14 10:42:47 +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" }],
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
["link", { rel: "manifest", href: "/manifest.json" }],
["meta", { name: "theme-color", content: "#ea5252" }],
add autodoc support
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",
📝 update index
2021-07-14 10:42:47 +08:00
{ name: "apple-mobile-web-app-status-bar-style", content: "black" },
:memo: add creating project
2020-09-17 13:12:48 +08:00
],
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
[
"link",
📝 update index
2021-07-14 10:42:47 +08:00
{ rel: "apple-touch-icon", href: "/icons/apple-touch-icon-180x180.png" },
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
],
[
"link",
{
rel: "mask-icon",
href: "/icons/safari-pinned-tab.svg",
📝 update index
2021-07-14 10:42:47 +08:00
color: "#ea5252",
},
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
],
[
"meta",
{
name: "msapplication-TileImage",
📝 update index
2021-07-14 10:42:47 +08:00
content: "/icons/mstile-150x150.png",
},
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
],
["meta", { name: "msapplication-TileColor", content: "#ea5252" }],
:memo: add creating project
2020-09-17 13:12:48 +08:00
[
"link",
{
rel: "stylesheet",
:art: format and update lock file
2021-07-18 15:07:30 +08:00
href:
"https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@5/css/all.min.css",
📝 update index
2021-07-14 10:42:47 +08:00
},
],
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",
📝 update index
2021-07-14 10:42:47 +08:00
description: "跨平台 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
📝 add algolia search
2021-07-21 17:23:16 +08:00
algolia: {
apiKey: "ef449608d0ad6e81b9efd05db6367040",
indexName: "nonebot",
algoliaOptions: {
facetFilters: ["lang:zh-CN"],
},
},
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/" },
:memo: add advanced and changelog
2020-11-18 08:48:23 +08:00
{ text: "进阶", link: "/advanced/" },
:construction: add plugin store page
2020-10-21 00:55:23 +08:00
{ text: "API", link: "/api/" },
:sparkles: change publish and issue
2021-03-05 16:27:43 +08:00
{ text: "商店", link: "/store" },
📝 update index
2021-07-14 10:42:47 +08:00
{ text: "更新日志", link: "/changelog" },
: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/": [
{
:memo: add plugin load doc
2020-11-07 12:36:47 +08:00
title: "开始",
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
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",
📝 update index
2021-07-14 10:42:47 +08:00
"basic-configuration",
],
:memo: add plugin load doc
2020-11-07 12:36:47 +08:00
},
{
title: "编写插件",
collapsable: false,
sidebar: "auto",
children: [
"loading-a-plugin",
:memo: add create matcher guide
2020-11-09 12:47:59 +08:00
"creating-a-plugin",
:memo: add create handler guide
2020-11-10 14:30:18 +08:00
"creating-a-matcher",
:memo: finish plugin guide
2020-11-12 09:32:35 +08:00
"creating-a-handler",
📝 update index
2021-07-14 10:42:47 +08:00
"end-or-start",
],
:memo: update doc
2020-12-31 17:58:09 +08:00
},
{
title: "协议适配",
collapsable: false,
sidebar: "auto",
📝 update index
2021-07-14 10:42:47 +08:00
children: [
"cqhttp-guide",
"ding-guide",
"mirai-guide",
"feishu-guide",
],
},
:memo: docs: guide, installation
2020-09-12 13:45:03 +08:00
],
:memo: add advanced and changelog
2020-11-18 08:48:23 +08:00
"/advanced/": [
{
title: "进阶",
collapsable: false,
sidebar: "auto",
:memo: add cross plugin guide
2020-11-23 13:41:57 +08:00
children: [
"",
"scheduler",
"permission",
"runtime-hook",
:memo: update docs
2020-12-22 09:59:48 +08:00
"export-and-require",
📝 update index
2021-07-14 10:42:47 +08:00
"overloaded-handlers",
],
:memo: add plugin publish guide
2020-11-23 13:46:36 +08:00
},
{
title: "发布",
collapsable: false,
sidebar: "auto",
📝 update index
2021-07-14 10:42:47 +08:00
children: ["publish-plugin"],
},
:memo: add advanced and changelog
2020-11-18 08:48:23 +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 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "config",
:bulb: add scheduler docstring
2020-09-13 00:18:31 +08:00
},
:bulb: add plugin docstring
2020-10-18 15:04:45 +08:00
{
title: "nonebot.plugin 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "plugin",
:bulb: add plugin docstring
2020-10-18 15:04:45 +08:00
},
:bulb: add message docstring
2020-11-13 17:15:45 +08:00
{
title: "nonebot.message 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "message",
:bulb: add message docstring
2020-11-13 17:15:45 +08:00
},
: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 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "matcher",
do some changes to vuepress docs
2020-08-23 17:03:59 +08:00
},
:bulb: update handler docstring
2021-03-20 15:41:50 +08:00
{
title: "nonebot.handler 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "handler",
:bulb: update handler docstring
2021-03-20 15:41:50 +08:00
},
:bulb: add rule utils docstring
2020-09-13 13:01:23 +08:00
{
title: "nonebot.rule 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +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.log 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "drivers/",
:memo: Update docs
2020-10-11 13:17:40 +08:00
},
{
title: "nonebot.drivers.fastapi 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "drivers/fastapi",
:memo: Update docs
2020-10-11 13:17:40 +08:00
},
:memo: add index in document for quart driver
2021-02-06 10:58:58 +08:00
{
title: "nonebot.drivers.quart 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "drivers/quart",
:memo: add index in document for quart driver
2021-02-06 10:58:58 +08:00
},
:boom: change forward setup api
2021-07-31 12:24:11 +08:00
{
title: "nonebot.drivers.aiohttp 模块",
path: "drivers/aiohttp",
},
:bulb: add cqhttp event
2020-09-29 23:10:29 +08:00
{
title: "nonebot.adapters 模块",
📝 update index
2021-07-14 10:42:47 +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 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "adapters/cqhttp",
:art: improve cqhttp
2020-12-03 16:04:14 +08:00
},
{
title: "nonebot.adapters.ding 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "adapters/ding",
:memo: update document building struct to fit changes in mirai adapter
2021-02-01 13:20:09 +08:00
},
{
title: "nonebot.adapters.mirai 模块",
📝 update index
2021-07-14 10:42:47 +08:00
path: "adapters/mirai",
},
{
title: "nonebot.adapters.feishu 模块",
path: "adapters/feishu",
},
],
},
],
},
},
},
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",
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
[
"@vuepress/pwa",
{
serviceWorker: true,
updatePopup: {
message: "发现新内容",
📝 update index
2021-07-14 10:42:47 +08:00
buttonText: "刷新",
},
},
:zap: add site cache to improve performance #29
2020-10-19 15:49:18 +08:00
],
do some changes to vuepress docs
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}`);
📝 update index
2021-07-14 10:42:47 +08:00
},
},
:memo: add creating project
2020-09-17 13:12:48 +08:00
],
[
"container",
{
type: "vue",
before: '<pre class="vue-container"><code>',
📝 update index
2021-07-14 10:42:47 +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