yejingx / docs

UPYUN Docs

又拍云文档中心

又拍云的文档中心基于 MkDocs 制作。所有文档的源文件全部位于 sources/ 目录下，并都为 Markdown 格式。

所有生成的文档页面全部托管于 http://docs.upyun.com，并与本项目仓库保持实时同步。

帮助完善 UPYUN 的文档

如果想要帮助 UPYUN 完善文档，请查看：CONTRIBUTING.md。

本地运行

1. 安装所需的 MkDocs

$ pip install 'mkdocs==0.9'

注意 因为 0.10 以上版本的 mkdocs，修改了相对路径的生成策略，暂时请用 0.9 版本

2. 进入本项目仓库根目录，并执行 mkdocs serve

$ cd /path/to/this
$ mkdocs serve

3. 使用浏览器访问：

http://127.0.0.1:8000/

License

所有 source/ 目录中的内容，授权方式均为 CC:BY-NC-SA