Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 536 Bytes

README.md

File metadata and controls

26 lines (16 loc) · 536 Bytes

mddoc

nimble install mddoc

Github Actions

API reference

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