快速文档查看器

开发者快速预览文档的文档查看器。

功能

• 由 walkdir 提供的排序文件列表
• 特殊文件，例如 README.*，SUMMARY.* 等，用作导航
• 轻量级标记文档预览，目前支持 Markdown
• 支持一些额外的 Markdown 功能，例如 GFM 表格等，由 comrak 提供
• 可以通过选定的格式预览文件
• 忽略一些无用的目录，例如 .git 等
• 支持由 chardetng 和 encoding_rs 提供的编码

用法

0. 构建 quick-doc-viewer 命令行程序

   git clone https://github.com/zhangkaizhao/quick-doc-viewer.git cd quick-doc-viewer/ cargo build --release

1. 在文档目录下运行构建的 quick-doc-viewer 命令行程序

   cd /path/to/documentations/ /path/to/quick-doc-viewer

2. 在网页浏览器中按照以下方式打开URL以开始预览

   http://127.0.0.1:8080/