nimdoc
Generate and view local documentation of installed nimble packages
Summary
| Latest Version | 1.1.2 |
|---|---|
| License | MIT |
| CI Status | Failing |
| Downloads | 0 |
| Last Indexed | 2026-07-21 05:27 |
Tags
Authors
- Ben Tomlin
Installation
nimble install nimdoc
choosenim install nimdoc
git clone https://github.com/WaywardWizard/nimdoc
OS Compatibility
| Platform | Linux | macOS | Windows | FreeBSD | OpenBSD | NetBSD | Android | iOS | WASM | Embedded |
|---|---|---|---|---|---|---|---|---|---|---|
| nimdoc | ✓ | ✓ | ✓ | - | - | - | - | - | - | - |
Dependencies
| Package | Version | Optional |
|---|---|---|
| nim >= | 2.2.6 | No |
| https://github.com/WaywardWizard/nim-argparse >= | 4.1.2 | No |
Source
| Repository | https://github.com/WaywardWizard/nimdoc |
|---|---|
| Homepage | https://github.com/WaywardWizard/nimdoc |
| Registry Source | nimble_official |
README
Intro
View local nim package documentation. Indexed in browser. Generates docs from local source on demand, starts a web server to serve them on demand.
Install
nimble install nimdoc
Dependencies
Live Server, preferred, but if not installed will use python -m http.server
So, you need python at least
Use
nimdoc -h # show help
nimdoc <pkg> # open docs for <pkg>
nimdoc # open listing of all generated packages
nimdoc -c fish | source # add nimdoc completions to fish shell
nimdoc -r cueconfig # force generate and view cueconfig docs
nimdoc -R cueconfig # force reload web server and view cueconfig docs
nimdoc -d cueconfig # dry run
nimdoc -p cueconfig # generate docs with private symbols
nimdoc -Rrp cueconfig # do it all