rex/mddoc
1
0
Fork 0
mirror of https://github.com/treeform/mddoc synced 2026-01-14 18:31:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
26 commits 1 branch 5 tags 48 KiB
Find a file
Exact
treeform b330712aa8 Fix tests
2021-09-30 17:32:57 -07:00
.github/workflows Add actoins 2021-09-30 17:27:35 -07:00
src Now walks exported modules too! 2020-11-30 00:11:12 -08:00
tests Fix tests 2021-09-30 17:32:57 -07:00
.gitignore Change to UNIX line endings. 2020-03-05 14:06:25 -08:00
LICENSE Add license 2021-09-30 12:06:18 -07:00
mddoc.nimble Update readme. 2021-09-30 16:57:18 -07:00
README.md Add tests 2021-09-30 17:28:43 -07:00

README.md

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