簡單、快速產生文檔工具 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 文檔中心
• 吳育民網站
• 蒙秋菊網站
• 阿好好
• 互海網