mddoc
Generate Nim API docs in markdown for GitHub's README.md files.
Summary
| Latest Version | 0.1.0 |
|---|---|
| License | MIT |
| CI Status | Failing |
| Downloads | 0 |
| Last Indexed | 2026-08-27 06:49 |
Tags
Authors
- Andre von Houck
Installation
nimble install mddoc
choosenim install mddoc
git clone https://github.com/treeform/mddoc
OS Compatibility
| Platform | Linux | macOS | Windows | FreeBSD | OpenBSD | NetBSD | Android | iOS | WASM | Embedded |
|---|---|---|---|---|---|---|---|---|---|---|
| mddoc | ✓ | ✓ | ✓ | - | - | - | - | - | - | - |
Dependencies
| Package | Version | Optional |
|---|---|---|
| nim >= | 1.4.0 | No |
Source
| Repository | https://github.com/treeform/mddoc |
|---|---|
| Homepage | https://github.com/treeform/mddoc |
| Documentation | View Documentation |
| Registry Source | nimble_official |
README
mddoc
nimble install mddoc
This library has no dependencies other than the Nim standard libarary.
About
A tool to generate Nim API docs in markdown for GitHub's README.md files. Great for small libraries with simple APIs.
Run this in the same folder as the README.md file:
mddoc
Your README.md should now have an API section.
API: mddoc
import mddoc