Skip to content

gkpty/super-easy-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Super Easy Docs

A node module that generates responsive html documentation pages with bootstrap4.

The module reads a markdown file, converts it to html, and then builds a responsive navigation bar with all the documentation sections.

Installation

npm i super-easy-docs

Usage

const superEasyDocs = require('./super-easy-docs')

//replace PATH with the path to your markdown documentatin file
superEasyDocs(PATH, function(err, data){
  if(err) console.log(err)
  else console.log('success')
})

About

generate a responsive html page for your markdown documentation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published