EasyDoc，简单、快速生成文档的工具。

EasyDoc，简单、快速生成文档的工具。

EasyDoc 读音 [ˈiziˈdɑk] 语音文件

互动·交流

• QQ交流群：群号码 80998448 加入QQ群
• GitHub: https://github.com/wuyumin/ea... 欢迎 star 它

软件更新和下载

从这下载软件 (压缩包须要解压出软件文件。)

仅一个软件文件搞定，不用安装，更不用其它依赖，支持微软系统电脑，苹果系统电脑，Linux系统电脑。

如何更新软件：请将下载后的新软件文件覆盖旧的软件文件便可。

EasyDoc 使用 Go 语言开发，是开源软件，你能够自行使用源码进行编译。其实你可没必要这么作，咱们已经有编译并优化好的软件来下载。

命令行的使用

确保 easydoc 软件文件有可执行权限！

软件文件在当前目录下时：
Windows系统 $ easydoc -version
类Unix系统(如Mac，Linux系统。注意前面有 ./ ) $ ./easydoc -version
你能够将 easydoc 软件文件放在全局环境目录下(推荐此作法)，任何地方直接使用$ easydoc -version进行使用。

EasyDoc 目前支持的命令：

别忘了命令前面是有小横线的！

-init 初始化文档结构
-build 生成文档
-server 启动 web 服务(能够配合[或不配合]端口-port和路径-path一块儿使用，默认端口是 80 -port 80，默认路径是 dist 目录-path ./dist)
-emptydist 清空 dist 目录
-help 帮助文档
-version 查看 EasyDoc 版本

生成的静态文件都放在dist目录，直接使用或复制该目录当网站目录。

基本目录结构

使用 -init 命令自动生成

├── dist  //发布目录
├── config
│   └── config.toml  //配置文件,使用toml语法
├── src  //写做目录: 存放 .md 源文件(必须,支持多级子目录写做)
│   ├── index.md  //首页(非必须,但推荐)
│   ├── NO-asset-folder.txt  //避免冲突,提示src目录慎用asset和static子目录
│   └── NO-static-folder.txt
├── static  //静态文件目录,此目录会完整地复制到发布目录(能够灵活使用它进行文件布局)
└── theme  //模板目录(支持多套模板)
    └── default  //default这套默认模板
        ├── css
        │   └── style.css //模板中的css文件(没有则使用软件默认)
        ├── js
        │   └── app.js //模板中的js文件(没有则使用软件默认)
        ├── doc.tpl  //文档模板(没有则使用软件默认)
        └── menu.tpl //菜单模板(菜单生成有顺序，见下面说明)
├── easydoc.exe  //软件文件(必须，推荐放在全局环境目录下)

• 源文件使用 Markdown 语法编写。写做都是在 src 目录下，支持多级子目录写做(提示：src 目录慎用 asset 和 static 子目录)。
• 生成网页连接路径不对，能够使用 config.toml 的 fixLink 项进行修正(绝对路径更好)。
• 菜单生成依据顺序：menu.tpl菜单模板内容不为空 > config.toml的 scanFile 数组不为空(连接标题为设置的标题) > 自动扫描 src 目录下的 .md 文件生成(连接标题为无后缀的文件名)。
• 文档生成依据顺序：config.toml的 scanFile 数组不为空(文档标题为设置的标题) > 自动扫描 src 目录下的 .md 文件生成(文档标题为无后缀的文件名)。
• config.toml 的 scanFile 数组填写格式：

scanFile = [
    ["连接标题", "以src目录为基准的src开头的对应.md文件路径(支持外链)"],
    ["首页", "src/index.md"],
    ["XXX页", "src/sub/XXX.md"],
]

贡献

GitHub: https://github.com/wuyumin/ea... 欢迎star它
建议或帮咱们改进：提交 issue 给咱们 或者 提交 pull request 给咱们。

命令操做示例动图

谁在使用 EasyDoc

欢迎你提供使用 EasyDoc 的网站，方便咱们收录。

• EasyDoc 文档中心