From 90fe69b6f2f6f5012d3809d9f429d9d551b933e2 Mon Sep 17 00:00:00 2001 From: Karlatemp Date: Wed, 15 Jun 2022 12:50:13 +0800 Subject: [PATCH] Update docs --- docs/.conf/nav.js | 40 ++++++++++++++++++++++++++++ docs/Bots.md | 4 +-- mirai-console/docs/.conf/nav.js | 46 +++++++++++++++++++++++++++++++++ 3 files changed, 88 insertions(+), 2 deletions(-) create mode 100644 docs/.conf/nav.js create mode 100644 mirai-console/docs/.conf/nav.js diff --git a/docs/.conf/nav.js b/docs/.conf/nav.js new file mode 100644 index 000000000..bf90555c0 --- /dev/null +++ b/docs/.conf/nav.js @@ -0,0 +1,40 @@ +/* + * Copyright 2019-2022 Mamoe Technologies and contributors. + * + * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证. + * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link. + * + * https://github.com/mamoe/mirai/blob/dev/LICENSE + */ + +module.exports = { + text: "mirai-core", + link: "/", + items: [ + {text: "Index", link: "/"}, + {text: "Mirai 生态概览", link: "/mirai-ecology.html"}, + {text: "从 1.x 迁移", link: "/MigrationFrom1x.html"}, + {text: '用户手册', link: '/UserManual.html'}, + {text: 'JVM 环境和开发准备工作', link: '/Preparations.html'}, + {text: "配置项目", link: "/ConfiguringProjects.html"}, + { + text: "CoreAPI", items: [ + {text: "CoreAPI", link: "/CoreAPI.html"}, + {text: "机器人", link: "/Bots.html"}, + {text: "联系人", link: "/Contacts.html"}, + {text: "事件", link: "/Events.html"}, + {text: "消息", link: "/Messages.html"}, + ] + }, + { + text: "Misc", items: [ + {text: '主要API', link: '/ConciseAPI.html'}, + {text: 'Mirai - Evolution', link: '/Evolution.html'}, + {text: 'Kotlin & Java', link: '/KotlinAndJava.html'}, + {text: "事件列表", link: "/EventList.html"}, + {text: "Debugging Network", link: "/DebuggingNetwork.html"}, + {text: "Using Dev Snapshots", link: "/UsingSnapshots.html"}, + ] + }, + ], +}; \ No newline at end of file diff --git a/docs/Bots.md b/docs/Bots.md index 60e814ed8..bdcdea4af 100644 --- a/docs/Bots.md +++ b/docs/Bots.md @@ -289,7 +289,7 @@ contactListCache.setSaveIntervalMillis(60000) // 可选设置有更新时的保 > [回到 Mirai 文档索引](CoreAPI.md) - +END DROP A --> diff --git a/mirai-console/docs/.conf/nav.js b/mirai-console/docs/.conf/nav.js new file mode 100644 index 000000000..cb864a3c4 --- /dev/null +++ b/mirai-console/docs/.conf/nav.js @@ -0,0 +1,46 @@ +/* + * Copyright 2019-2022 Mamoe Technologies and contributors. + * + * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证. + * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link. + * + * https://github.com/mamoe/mirai/blob/dev/LICENSE + */ + +module.exports = { + text: "mirai-console", + link: "/", + items: [ + {text: "Index", link: "/"}, + {text: "配置项目", link: "/ConfiguringProjects.html"}, + {text: "启动 Console", link: "/Run.html"}, + { + text: "后端插件开发基础", items: [ + {text: "插件 - Plugin 模块", link: "/plugin/Plugins.html"}, + {text: "插件 - JVM Plugin", link: "/plugin/JVMPlugin.html"}, + {text: "指令 - Command 模块", link: "/Commands.html"}, + {text: "存储 - PluginData 模块", link: "/PluginData.html"}, + {text: "权限 - Permission 模块", link: "/Permissions.html"}, + ] + }, + { + text: "后端插件开发进阶", items: [ + {text: "扩展 - Extension 模块和扩展点", link: "/Extensions.html"}, + ] + }, + { + text: "实现前端", items: [ + {text: "FrontEnd", link: "/FrontEnd.html"}, + ] + }, + { + text: "Misc", items: [ + {text: 'Q & A', link: '/QA.html'}, + {text: '日志配置', link: '/Logging.html'}, + {text: '内置命令', link: '/BuiltInCommands.html'}, + {text: 'Mirai Console 附录', link: '/Appendix.html'}, + {text: "插件 - JVM Plugin - 附录", link: "/plugin/JVMPlugin-Appendix.html"}, + ] + }, + ] +} \ No newline at end of file