EasyDoc，簡單、快速產生文檔的工具。

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

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目錄都會被清空，請不要將重要檔案放在裡面。

貢獻

幫我們改進：提交 issue 給我們 或者 提交 pull request 給我們。

命令操作樣本動圖

誰使用 EasyDoc

歡迎你提供使用 EasyDoc 的網站，方便我們收錄。

• EasyDoc 文檔中心