Skip to content
/ mddoc Public

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

License

Notifications You must be signed in to change notification settings

treeform/mddoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages