首頁

回中文 wiki 文檔首頁

docoGen 是什麼 ?

docoGen 是個開源專案，主要讓使用者更加便利、廣泛的使用於產生說明文件。只要透過編寫腳本於 JSON 或是 markdown 格式，再透過 docoGen 來產生對應的文檔格式，像是 LaTeX 的 PDF、以及靜態網頁。

docoGen 能做什麼呢?

• 使用者只需要編寫腳本（副檔名為 .docogen 的是使用 JSON 格式做編寫、另外也支援 markdown 格式），接著 docoGen 的程式就會蒐集目標資料夾底下所有的 .docogen （只有 .docogen 格式支援多個檔案合併！），並且把他們轉換為目標的 latex 或是 靜態網站，給你的專案做使用。
• 由於 .docogen 腳本是跟 .json 格式相同，所以可以先編輯 .json 檔案後，再把副檔名改成 .docogen 即可
• docoGen 腳本中 .docogen 支援多個檔案合併！多個檔案中，只需要有一個具有主要結構即可，而次要結構（內文）部份則可以分在其他檔案(詳情請見"腳本架構篇")，這樣做的好處是讓原本的 json 格式文件變得不會太長，大幅增加可讀性！
• 另外在新版本中，docoGen 也支援更平易近人的 markdown 格式！
• 而產生的方法只需要指定你放置這些 .docogen 的資料夾後就可以讓 docoGen 為你產生對應的說明文件囉！（詳情請看"範例篇"）

如何使用？

• 你可以放置多個 docogen 腳本於你的專案底下（放哪裡都可以）
• 接著使用 README.md 上的程式碼來做使用即可產生美美的說明文件囉！
• 更進一步可以參考 測試環境 這裡的程式碼做更進一步、更完整的操作！
• 幾乎不需要懂 LaTeX 語法就可以生成 LaTeX 文件！ 耶！