跳转至

EasyDataAnalysis 帮助文档示例

这是一个最小可用的帮助文档站点骨架,目的是先把文档站搭起来,再逐步补充内容。

当前示例使用:

  • MkDocs
  • Material for MkDocs
  • 自定义域名 docs.easydataanalysis.top

你现在已经有了什么

仓库里已经添加了下面这些文件:

  • mkdocs.yml:文档站点配置
  • docs/index.md:首页
  • docs/deployment.md:部署路线总览
  • docs/github-pages-deployment.md:GitHub Pages 部署示例
  • docs/server-deployment.md:服务器部署示例

推荐的后续写法

后面可以继续按这个结构扩展:

  • docs/getting-started.md:快速开始
  • docs/user-guide/:用户操作说明
  • docs/faq.md:常见问题
  • docs/changelog.md:版本更新说明

本地预览

先安装文档依赖:

python -m pip install mkdocs-material

然后在项目根目录运行:

mkdocs serve

浏览器打开:

http://127.0.0.1:8000

下一步

先看部署总览,选一条适合你的路线完成第一次上线。面向中国大陆用户时,通常更适合直接看“服务器部署”。等文档站跑通以后,我们再补首页、导航、FAQ 和具体功能说明。