EasyDoc,簡單、快速生成文檔的工具。

EasyDoc,簡單、快速生成文檔的工具。css

EasyDoc 讀音 [ˈiziˈdɑk] 語音文件html

互動·交流

軟件更新和下載

從這下載軟件 (壓縮包須要解壓出軟件文件。)git

僅一個軟件文件搞定,不用安裝,更不用其它依賴,支持微軟系統電腦,蘋果系統電腦,Linux系統電腦。github

如何更新軟件:請將下載後的新軟件文件覆蓋舊的軟件文件便可。web

EasyDoc 使用 Go 語言開發,是開源軟件,你能夠自行使用源碼進行編譯。其實你可沒必要這麼作,咱們已經有編譯並優化好的軟件來下載。數組

命令行的使用

確保 easydoc 軟件文件有可執行權限!

軟件文件在當前目錄下時:
Windows系統 $ easydoc -version
類Unix系統(如Mac,Linux系統。注意前面有 ./ ) $ ./easydoc -version
你能夠將 easydoc 軟件文件放在全局環境目錄下(推薦此作法),任何地方直接使用$ easydoc -version進行使用。app

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 的網站,方便咱們收錄。

相關文章
相關標籤/搜索