Docnado

一個讓你驚豔的快速文件工具！！！

Docnado 使開始和維護 Markdown 文件專案變得容易。

功能

Docnado 呈現改編後的 Markdown，以提供

• 嵌入圖片、影片、YouTube 連結、外部 CSV 表格和 PDF。
• 程式碼高亮顯示。
• 檔案下載區塊。
• 列表、檢查表、表格和詞彙表。
• 文件定義的模板選擇。
• 文件元數據。
• 自動產生的導覽側邊欄。
• 內建命令列選項，可尋找文件中損壞的連結和孤立的圖片。

存取選項

• 在 localhost 上輸出不安全的 HTML 文件。
• 透過 HTML 伺服器輸出 PDF 文件。
• 建立一組包含文件和相關資源的靜態 HTML 檔案。

下載

請確保您已安裝 Python 3.6。

python3 -m pip install docnado --upgrade	# install it
docnado										# run it

開始使用

python docnado.py                       # start a server on localhost:5000

python docnado.py --html                # freeze the server into a static site as a set of HTML files
                                         # this will exit with -1 if there was a problem parsing any file

python docnado.py --port                # specify a port for docnado to accept requests on

python docnado.py --pdf                 # generate a set of pdf files for each .md file - won't pull through
                                         # static resource files like with the --html command

python docnado.py --new                 # copy default templates and sample docs into the working directory
                                         # and update the config too, only if they don't already exist

python docnado.py --new-force           # copy default templates and sample docs into the working directory
                                         # and update the config too, this will overwrite any existing docs or
                                         # configs.


python docnado.py --dirs                # display all the different directories docnado will use to generate
                                         # the documentation

python docnado.py --find-orphans        # display unreferenced media assets in the documentation
python docnado.py --find-broken-links   # display external broken links in the documentation