diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js new file mode 100644 index 0000000..bf660a6 --- /dev/null +++ b/docs/.vuepress/config.js @@ -0,0 +1,10 @@ +module.exports = { + title: 'Nonebot HK Reporter', + description: 'Docs for Nonebot HK Reporter', + themeConfig: { + nav: [ + { text: '部署与使用', link: '/usage/' }, + { text: '开发', link: '/dev/' } + ] + } +} diff --git a/docs/README.md b/docs/README.md index 7731962..a7efb63 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,12 @@ -# Hello Vue +--- +home: true +heroText: Nonebot HK Reporter +actionText: 快速部署 +actionLink: /usage/ +features: +- title: KISS + details: 作为插件可以Simple和Stupid,作为插件可以Simple和Stupid,作为Bot提供适用的功能 +- title: 拓展性强 + details: 可以快速的添加新的网站 +footer: MIT Licensed +--- diff --git a/docs/usage/README.md b/docs/usage/README.md new file mode 100644 index 0000000..b531a73 --- /dev/null +++ b/docs/usage/README.md @@ -0,0 +1,7 @@ +--- +sidebar: auto +--- +# 部署和使用 +本节将教你快速部署和使用一个nonebot-hk-reporter + +## 快速上手 diff --git a/docs/usage/quick-start.md b/docs/usage/quick-start.md new file mode 100644 index 0000000..b8be99b --- /dev/null +++ b/docs/usage/quick-start.md @@ -0,0 +1 @@ +# 快速入门