701 B
701 B
如何编写开发手册
开发手册基于docsify,采用简洁的markdown格式编写。
其目录结构如下:
- 开发手册入口文件:
./public/wiki/index.html - 封面文件:
./public/wiki/_coverpage.md - 顶部菜单:
./public/wiki/_navbar.md - 左侧菜单配置:
./public/wiki/_sidebar.md - 手册首页:
./public/wiki/README.md
更多请继续阅读下一节:文档编写规范。
如果不希望外网可以访问此开发手册,可以在正式环境禁止访问wiki目录,参考Nginx配置:
# 禁止访问开发手册
location ^~ /wiki/ {
deny all;
}
然后改为访问内网测试环境。