Docnado

一个闪电般的文档工具，让你大吃一惊!!!

Docnado 使得启动和维护 Markdown 文档项目轻而易举。

功能

Docnado 呈现经过改编的 Markdown 来提供

• 嵌入图像、视频、YouTube 链接、外部 CSV 表格和 PDF。
• 代码高亮显示。
• 文件下载模块。
• 列表、清单、表格和词汇表。
• 文档定义的模板选择。
• 文档元数据。
• 自动生成的导航侧边栏。
• 内置命令行选项，用于在你的文档中查找损坏的链接和孤立的图像。

获取选项

• 在本地主机上以不安全的 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