EasyDoc,简单、快速生成文档的工具。
可执行文件下载
仅一个可执行软件搞定,不用安装,更不用其它依赖,支持微软系统电脑,苹果系统电脑,Linux系统电脑。
模板目录基本结构
├─dist //发布目录
├─src //存放 .md 源文件及模板文件(必须,支持存放在此目录及其子目录)
│ ├─static //静态文件目录,此目录会完整地复制到发布目录
│ ├─theme
│ │ ├─template
│ │ │ ├─doc.tpl //文档模板文件(非必须,没有则使用软件默认模板)
│ ├─index.md //首页(非必须)
│ ├─SUMMARY.md //生成菜单使用(必须)
├─easydoc //可执行文件。如 Windows 系统下的 easydoc.exe
建议将 .md 源文件仅放在 src 根目录下,避免忘记模板修改而生成的网页链接路径不对,造成无法访问。
命令行使用
确保 easydoc 可执行文件有可执行权限!
可执行文件在当前目录下时:
Windows系统 $ easydoc -version
类Unix系统(如Mac,Linux系统。注意前面有 ./ ) $ ./easydoc -version
你可以将 easydoc 可执行文件放在全局环境目录下,直接使用$ easydoc -version进行使用,更加方便。
EasyDoc 目前支持的命令:
-init 初始文档结构
-build 生成文档
-help 帮助文档
-version 查看 EasyDoc 版本
生成的静态文件都放在dist目录,直接复制该目录到适当地方当作网站目录来使用。
注意:再次生成时dist目录都会被清空,请不要将重要文件放在里面。
贡献
命令操作示例动图
谁使用 EasyDoc
欢迎你提供使用 EasyDoc 的网站,方便我们收录。
有疑问加站长微信联系(非本文作者)