ire4ever1190/Nim documentation generator
Automatically builds documentation with a few extra niceties that I like
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| main-file | Main Nim file which to build documentation with (relative to root of `project-dir`) | yes | — |
| out-dir | Where to put the files (Relative to `project-dir`) | yes | site/ |
| project-dir | Folder containing the .nimble file | yes | ./ |
| build-index | Whether to build indexes first or not (Can be disabled if you don't use importdoc) | yes | true |
| deploy | Automatically deploy the site. Currently only supports Github pages | no | none |
| devel-branch | Development branch to link to in the `edit` button. Defaults to the default branch in git | no | "" |
| extra-files | Extra documentation files to render. Can either be markdown or Nim files | no | "" |
| versions | Space separated list of versions to build documentation for. `HEAD` builds latest commit and `stable` builds latest published version | no | stable |
Outputs
| name | description |
|---|---|
| site-dir | Path to built documentation |