GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → treeform → mddoc

treeform / mddoc

Licence: MIT license
Generated Nim's API docs in markdown for github's README.md files. Great for small libraries with simple APIs.

Programming Languages

nim
578 projects

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
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].