From 1dd83314797b4087f50379b3952f1dad89a942a6 Mon Sep 17 00:00:00 2001 From: Richard Chien Date: Thu, 16 Aug 2018 00:35:56 +0800 Subject: [PATCH] Update docs --- docs/.vuepress/config.js | 18 +++++++++++++++--- docs/advanced/README.md | 7 +++++++ docs/configurations.md | 31 +++++++++++++++++++++++++++++++ docs/guide/group-management.md | 4 ++-- docs/guide/whats-next.md | 7 +++++++ 5 files changed, 62 insertions(+), 5 deletions(-) create mode 100644 docs/advanced/README.md create mode 100644 docs/configurations.md create mode 100644 docs/guide/whats-next.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index e9fdfb5c..70328d4f 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -13,13 +13,15 @@ module.exports = { lastUpdated: '上次更新', activeHeaderLinks: false, nav: [ - { text: '入门指南', link: '/guide/' }, + { text: '指南', link: '/guide/' }, + { text: '进阶', link: '/advanced/' }, + { text: '配置', link: '/configurations.md' }, { text: '术语表', link: '/glossary.md' }, ], sidebar: { '/guide/': [ { - title: '入门指南', + title: '指南', collapsable: false, children: [ '', @@ -31,9 +33,19 @@ module.exports = { 'write-nl-processors', 'tuling', 'group-management', + 'whats-next', ] } - ] + ], + '/advanced/': [ + { + title: '进阶', + collapsable: false, + children: [ + '', + ] + } + ], }, } } diff --git a/docs/advanced/README.md b/docs/advanced/README.md new file mode 100644 index 00000000..1eb424b9 --- /dev/null +++ b/docs/advanced/README.md @@ -0,0 +1,7 @@ +# 概览 + +::: warning 注意 +要使用 NoneBot 的进阶用法,请先确保你已经理解了入门指南中的内容。 +::: + +这里介绍使用进阶功能可以实现的效果。 diff --git a/docs/configurations.md b/docs/configurations.md new file mode 100644 index 00000000..dbd6152b --- /dev/null +++ b/docs/configurations.md @@ -0,0 +1,31 @@ +--- +sidebar: auto +--- + +# 配置 + +## `API_ROOT` + +## `ACCESS_TOKEN` + +## `SECRET` + +## `HOST` + +## `PORT` + +## `DEBUG` + +## `SUPERUSERS` + +## `NICKNAME` + +## `COMMAND_START` + +## `COMMAND_SEP` + +## `SESSION_EXPIRE_TIMEOUT` + +## `SESSION_RUNNING_EXPRESSION` + +## `SHORT_MESSAGE_MAX_LENGTH` diff --git a/docs/guide/group-management.md b/docs/guide/group-management.md index e6d010db..591024fa 100644 --- a/docs/guide/group-management.md +++ b/docs/guide/group-management.md @@ -1,3 +1,3 @@ -# 实现群管功能 +# 编写通知和请求处理器 -本章将教你如何使用 NoneBot 实现自动同意或拒绝入群请求、欢迎新成员、踢出不良成员等功能。 +本章将以一个具有自动同意或拒绝入群请求、欢迎新成员、禁言不良成员等功能的群管插件为例,来教你编写通知和请求处理器。 diff --git a/docs/guide/whats-next.md b/docs/guide/whats-next.md new file mode 100644 index 00000000..5dbe1139 --- /dev/null +++ b/docs/guide/whats-next.md @@ -0,0 +1,7 @@ +# 下一步做什么? + +在阅读完前面的入门指南之后,你已经具备了实现具有复杂功能的 QQ 机器人的基本知识,可以开始编写完整的作品了。 + +然而,NoneBot 并不止步于此。在使用 NoneBot 编写功能时,你可能会时常遇到一些绝佳的想法,但这些想法在已有的基本知识的基础上无法实现。幸运的是,NoneBot 已经预先考虑到了大多数这类使用场景,并提供了相应的接口来帮助实现你想要的逻辑。 + +NoneBot 的这部分用法我们称之为进阶用法,关于进阶用法的介绍,见 [进阶](/advanced/)。通常,你不需要在初次使用时就掌握进阶用法,而是建议在实际编程中发现有需要时再去查阅。