About docoGen

功能

• 與其他大部分的文件產生器不同，不使用編寫在註解內的資訊！

  • 使用編寫腳本 (JSON/Markdown 格式)，生成多個不同的說明文件格式。
     

• 目前支援 2 種格式

  • LaTeX (pdf 格式)

  • WebUI (靜態網頁)
     

• 隨意在專案各個資料夾下編寫該資料夾或是該檔案的敘述！

  • 透過 docoGen 來合併所有檔案格式，產生最後的說明文件。
     

• Base on node.js - 讓後端編寫者容易使用！

腳本 (.docogen)

• 副檔名是 .docogen！

  • 實際上是以 JSON 格式進行編輯

  • 目前也支援 Markdown 格式 ！

• 目前支援 8 種型態
  none, text, list, table, formula, code, figure, restful-api
   

• 參照格式：docoGen Wiki

docoGen LaTeX

直接轉換

• 不需學習 LaTeX 的語法與規則，便能夠生成具有強度的文件格式！

  • 文章、IEEETran 論文 etc.
     

• 未來會有更多彈性！

多種格式

• text, figure, table, code, formula 甚至 restful-api 的格式都可以提供
   
• 可修改原始碼內的 docogen engine 來新增新的格式！

Demo

• 產生的 LaTeX pdf (IEEEtran)

• 產生的 LaTeX pdf (proc)

• 產生的 LaTeX pdf (report)

• 產生的 LaTeX pdf (article)

• 產生的 LaTeX pdf (from markdown，格式與上面4個不同)

Know More?

• docoGen GitHub

• docoGen Wiki

docoGen WebUI

直接轉換

• 使用同份腳本檔案

多種格式

• 編寫完文件的同時，即可生成一份文件說明的網站

.docogen 文件

Demo

• 產生 Website

Know More?

• docoGen-WebUI GitHub

• docoGen-WebUI Wiki

目前進行中專案

正在進行

• Module 3 - docoGen-fromgit

• 編輯器/GUI Tool - docoGen-editor-qt

• CLI Tool - docoGen-cli

docoGen-fromgit

• 從 .git/ 裡頭的歷史資料變革來追蹤該專案的變化

• 目前預計以 file/function 為單位做追蹤

docoGen-editor-qt

• 一樣基於 node.js 的 CLI 工具
• 讓使用者不需要編寫 JavaScript 直接呼叫工具來產生文件/ 網站

docoGen-cli

• 從 .git/ 裡頭的歷史資料變革來追蹤該專案的變化

• 目前預計以 file/function 為單位做追蹤

About Us

ToolBuddy

• GitHub Org - https://github.com/toolbuddy

• 有什麼好玩的、想做的就馬上動手做吧！

• 歡迎有興趣的人加入我們！

Join Us!

Yung-Sheng Lu

yungshenglu1994@gmail.com

Kevin Cyu

kevinbird61@gmail.com