quick-doc-viewer
| Crates.io | quick-doc-viewer |
| lib.rs | quick-doc-viewer |
| version | 0.1.0 |
| source | src |
| created_at | 2022-05-29 12:46:03.777498 |
| updated_at | 2022-05-29 12:46:03.777498 |
| description | A quick documentation viewer for developers to preview documentations |
| homepage | |
| repository | https://github.com/zhangkaizhao/quick-doc-viewer |
| max_upload_size | |
| id | 596494 |
| size | 84,874 |
Kaizhao Zhang (zhangkaizhao)
documentation
README
Quick doc viewer
A quick documentation viewer for developers to preview documentations.
Features:
- Sorted all file listing powered by walkdir
- Special files, e.g. README., SUMMARY., etc. as navigation
- Preview of Lightweight Markup documentations, currently supports Markdown
- Support some additional Markdown features e.g. GFM table, etc. powered by comrak
- Files can be previewed by selected format
- Some directories e.g.
.git, etc. useless for preview are ignored - Support encodings powered by chardetng and encodings_rs
Usage:
-
Build the
quick-doc-viewercommand line program:git clone https://github.com/zhangkaizhao/quick-doc-viewer.git cd quick-doc-viewer/ cargo build --release
-
Run the built
quick-doc-viewercommand line program under the directory of documentations:cd /path/to/documentations/ /path/to/quick-doc-viewer
-
Open the URL as follow in the web browser to start preview: