{"id":35264431,"url":"https://github.com/zhangkaizhao/quick-doc-viewer","last_synced_at":"2026-04-05T01:33:35.458Z","repository":{"id":57697816,"uuid":"497566865","full_name":"zhangkaizhao/quick-doc-viewer","owner":"zhangkaizhao","description":"A quick documentation viewer for developers to preview documentations","archived":false,"fork":false,"pushed_at":"2022-05-29T12:48:00.000Z","size":29,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-02T19:13:09.618Z","etag":null,"topics":["documentation","markdown","rust"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhangkaizhao.png","metadata":{"files":{"readme":"README.txt","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-05-29T11:11:20.000Z","updated_at":"2022-05-30T06:54:42.000Z","dependencies_parsed_at":"2022-09-26T21:01:54.239Z","dependency_job_id":null,"html_url":"https://github.com/zhangkaizhao/quick-doc-viewer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/zhangkaizhao/quick-doc-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangkaizhao%2Fquick-doc-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangkaizhao%2Fquick-doc-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangkaizhao%2Fquick-doc-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangkaizhao%2Fquick-doc-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhangkaizhao","download_url":"https://codeload.github.com/zhangkaizhao/quick-doc-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhangkaizhao%2Fquick-doc-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31421869,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T00:25:07.052Z","status":"ssl_error","status_checked_at":"2026-04-05T00:25:05.923Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","markdown","rust"],"created_at":"2025-12-30T09:53:18.961Z","updated_at":"2026-04-05T01:33:35.445Z","avatar_url":"https://github.com/zhangkaizhao.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quick doc viewer\n\nA quick documentation viewer for developers to preview documentations.\n\n## Features:\n\n* Sorted all file listing powered by [walkdir]\n* Special files, e.g. README.*, SUMMARY.*, etc. as navigation\n* Preview of Lightweight Markup documentations, currently supports Markdown\n* Support some additional Markdown features e.g. GFM table, etc. powered by [comrak]\n* Files can be previewed by selected format\n* Some directories e.g. `.git`, etc. useless for preview are ignored\n* Support encodings powered by [chardetng] and [encodings_rs]\n\n[chardetng]: https://github.com/hsivonen/chardetng\n[comrak]: https://github.com/kivikakk/comrak\n[encodings_rs]: https://github.com/hsivonen/encoding_rs\n[walkdir]: https://github.com/BurntSushi/walkdir\n\n### Usage:\n\n0. Build the `quick-doc-viewer` command line program:\n\n    git clone https://github.com/zhangkaizhao/quick-doc-viewer.git\n    cd quick-doc-viewer/\n    cargo build --release\n\n1. Run the built `quick-doc-viewer` command line program under the directory of documentations:\n\n    cd /path/to/documentations/\n    /path/to/quick-doc-viewer\n\n2. Open the URL as follow in the web browser to start preview:\n\n    http://127.0.0.1:8080/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhangkaizhao%2Fquick-doc-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhangkaizhao%2Fquick-doc-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhangkaizhao%2Fquick-doc-viewer/lists"}