add autodoc support

2025-07-28 00:31:14 +00:00 · 2020-06-30 12:10:57 +08:00
parent 7529559d24
commit 1e632d5f10
14 changed files with 817 additions and 5 deletions
--- a/docs/.vuepress/config.js
+++ b/docs/.vuepress/config.js
@ -0,0 +1,38 @@
+module.exports = {
+  title: "NoneBot",
+  description: "基于 酷Q 的 Python 异步 QQ 机器人框架",
+  markdown: {
+    lineNumbers: true
+  },
+  /**
+   * 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" }],
+    ["meta", { name: "theme-color", content: "#d32f2f" }],
+    ["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",
+      { name: "apple-mobile-web-app-status-bar-style", content: "black" }
+    ]
+  ],
+
+  themeConfig: {
+    repo: "nonebot/nonebot",
+    editLinks: true,
+    editLinkText: "在 GitHub 上编辑此页",
+    docsDir: "docs",
+    lastUpdated: "上次更新",
+    nav: [{ text: "API", link: "/api.md" }],
+    sidebar: {}
+  },
+
+  /**
+   * Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/
+   */
+  plugins: ["@vuepress/plugin-back-to-top", "@vuepress/plugin-medium-zoom"]
+};
--- a/docs/.vuepress/enhanceApp.js
+++ b/docs/.vuepress/enhanceApp.js
@ -0,0 +1,14 @@
+/**
+ * Client app enhancement file.
+ *
+ * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements
+ */
+
+export default ({
+  Vue, // the version of Vue being used in the VuePress app
+  options, // the options for the root Vue instance
+  router, // the router instance for the app
+  siteData // site metadata
+}) => {
+  // ...apply enhancements for the site.
+}
--- a/docs/.vuepress/public/logo.png
+++ b/docs/.vuepress/public/logo.png
--- a/docs/.vuepress/styles/index.styl
+++ b/docs/.vuepress/styles/index.styl
@ -0,0 +1,8 @@
+/**
+ * Custom Styles here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/config/#index-styl
+ */
+
+.home .hero img
+  max-width 450px!important
--- a/docs/.vuepress/styles/palette.styl
+++ b/docs/.vuepress/styles/palette.styl
@ -0,0 +1,10 @@
+/**
+ * Custom palette here.
+ *
+ * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl
+ */
+
+$accentColor = #d32f2f
+$textColor = #2c3e50
+$borderColor = #eaecef
+$codeBgColor = #282c34
--- a/docs/README.md
+++ b/docs/README.md
@ -0,0 +1,15 @@
+---
+home: true
+heroImage: /logo.png
+tagline: An asynchronous QQ bot framework.
+actionText: 开始使用
+actionLink: /guide/
+features:
+  - title: 简洁
+    details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。
+  - title: 易于扩展
+    details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。
+  - title: 高性能
+    details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。
+footer: MIT Licensed | Copyright © 2020 NoneBot Team
+---