@omnihook/automd

Automatic markdown generator for your javascript projects

Usage no npm install needed!

<script type="module">
  import omnihookAutomd from 'https://cdn.skypack.dev/@omnihook/automd';
</script>

README

AutoMD

Installation

npm install -g @omnihook/automd

How to use?

Create automd.json which is a configuration file for your markdown file

automd init

{
    "name":"",
    "mode":"html",
    "description":"This is an auto-generated documentation created using <a href='https://github.com/anishm10/automd' target='_blank'>automd</a>",
    "sections":["header","dependencies","devDependencies"],
    "repository":{
        "type":"github",
        "url":""
    }   
}

Then use the below command to generate the markdown in either html or md format

automd generate