Add docs skeleton

.gitignore

@@ -165,6 +165,82 @@ venv.bak/
 # mypy
 .mypy_cache/
 
+# ----- Node -----
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless
+
 # ----- Project -----
 
 .idea/deployment.xml

README.md

@@ -3,8 +3,8 @@
 [![License](https://img.shields.io/pypi/l/none-bot.svg)](LICENSE)
 [![PyPI](https://img.shields.io/pypi/v/none-bot.svg)](https://pypi.python.org/pypi/none-bot)
 
-None Bot 是一个基于 [酷 Q](https://cqp.cc/) 的 Python 异步 QQ 机器人框架，框架与酷 Q 交互的部分使用 [aiocqhttp](https://github.com/richardchien/python-aiocqhttp)，后者是 [CoolQ HTTP API 插件](https://github.com/richardchien/coolq-http-api) 的一个 Python 异步 SDK。
+NoneBot 是一个基于 [酷 Q](https://cqp.cc/) 的 Python 异步 QQ 机器人框架，框架与酷 Q 交互的部分使用 [aiocqhttp](https://github.com/richardchien/python-aiocqhttp)，后者是 [CoolQ HTTP API 插件](https://github.com/richardchien/coolq-http-api) 的一个 Python 异步 SDK。NoneBot 仅支持 Python 3.6+ 及 CoolQ HTTP API 插件 v4.2+。
 
 NoneBot 本身不包含任何实际功能，仅仅提供处理消息、解析命令等核心功能，框架的使用者需要使用框架提供的接口，以插件的形式来编写具体功能。
 
-文档暂时还没写，请先参考 [none.plugins](none/plugins)、[none_demo](none_demo) 模块和 [richardchien/maruko](https://github.com/richardchien/maruko) 项目中的使用方式。
+文档暂时还没完成，请先参考 [none.plugins](none/plugins)、[demo](demo) 模块和 [richardchien/maruko](https://github.com/richardchien/maruko) 项目中的使用方式。

docs/.vuepress/config.js

@@ -0,0 +1,21 @@
+module.exports = {
+    title: 'NoneBot',
+    description: '基于酷 Q 的 Python 异步 QQ 机器人框架',
+    themeConfig: {
+        repo: 'richardchien/none-bot',
+        docsDir: 'docs',
+        editLinks: true,
+        editLinkText: '编辑页面',
+        lastUpdated: '上次更新',
+        nav: [
+            { text: '指南', link: '/guide/' },
+        ],
+        sidebar: {
+            '/guide/': [
+                '',
+                'installation',
+                'getting-started',
+            ]
+        },
+    }
+}

docs/README.md

@@ -0,0 +1,13 @@
+---
+home: true
+actionText: 即刻开始
+actionLink: /guide/
+features:
+- title: 简洁的 API
+  details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码。
+- title: 易于扩展
+  details: 精心设计的消息和事件处理流程及强大的 API 使得你可以很方便地从原型扩展出具有丰富功能的聊天机器人。
+- title: 高性能
+  details: 基于时下最流行的 asyncio 模块，使用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多个机器人账号来负载均衡用户消息，减少业务宕机的可能。
+footer: MIT Licensed | Copyright © 2018 Richard Chien
+---

docs/guide/README.md

@@ -0,0 +1,7 @@
+# 介绍
+
+NoneBot 是一个基于 [酷 Q](https://cqp.cc/) 的 Python 异步 QQ 机器人框架，框架与酷 Q 交互的部分使用 [aiocqhttp](https://github.com/richardchien/python-aiocqhttp)，后者是 [CoolQ HTTP API 插件](https://github.com/richardchien/coolq-http-api) 的一个 Python 异步 SDK。NoneBot 仅支持 Python 3.6+ 及 CoolQ HTTP API 插件 v4.2+。
+
+## NoneBot 如何工作？
+
+## 特性

docs/guide/getting-started.md

@@ -0,0 +1,3 @@
+# 开始使用
+
+一切都安装成功后，你就已经做好了进行简单配置以运行一个最小的 NoneBot 实例的准备。

docs/guide/installation.md

@@ -0,0 +1,37 @@
+# 安装
+
+## NoneBot
+
+::: warning 注意
+请确保你的 Python 版本 >= 3.6。
+:::
+
+可以使用 pip 安装已发布的最新版本：
+
+```bash
+pip install none-bot
+```
+
+如果你需要使用最新的（可能还没发布的）特性，可以克隆 Git 仓库后手动安装：
+
+```bash
+git clone https://github.com/richardchien/none-bot.git
+cd none-bot
+python setup.py install
+```
+
+以上命令中的 `pip`、`python` 可能需要根据情况换成 `pip3`、`python3`。
+
+## 酷 Q
+
+前往酷 Q 官方论坛的 [版本发布](https://cqp.cc/b/news) 页面根据需要下载最新版本的酷 Q Air 或 Pro，解压后启动 `CQA.exe` 或 `CQP.exe` 完成新手教程。
+
+如果你使用 Linux 或 macOS，可以使用版本发布页中酷 Q 官方提供的 Docker 镜像，或直接跳至下一个标题，使用 CoolQ HTTP API 插件官方提供的 Docker 镜像。
+
+## CoolQ HTTP API 插件
+
+前往 [CoolQ HTTP API 插件官方文档](https://cqhttp.cc/docs/)，按照其教程安装插件。安装后，请先使用默认配置运行，查看酷 Q 日至窗口的输出，以确定插件的加载、配置的生成和读取、插件版本符合预期。
+
+::: warning 注意
+请确保你安装的插件版本 >= 4.2，通常建议插件在大版本内尽量及时升级至最新版本。
+:::

package.json

@@ -0,0 +1,9 @@
+{
+  "scripts": {
+    "docs:dev": "vuepress dev docs",
+    "docs:build": "vuepress build docs"
+  },
+  "devDependencies": {
+    "vuepress": "^0.14.1"
+  }
+}