Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

meta-doc

META Doc is modern tool for generating rich project documentations using Markdown or HTML with support of various visual styles and custom templates.

See official META Doc documentation for more info and user guide.

Getting started

Install via NPM:

npm install meta-doc -g

Create new documentation project using default skeleton:

meta-doc -i ./my-doc

Start local server and automatically recompile when content change:

meta-doc -w -s ./my-doc

Congratulations, you have running documentation. Open it at http://127.0.0.1:8080/ and check out Writer's Guide.

To compile documentation once without server just execute:

meta-doc ./my-doc

Self-documentation

Documentation of META Doc is included in repository and generated by META Doc itself.

To open documentation clone repository then run following command and open http://127.0.0.1:8080/.

npm install
npm run doc

Testing

npm install --dev
npm test

License

META Doc is published under Apache License 2.0.

About

Project documentation generator with support of HTML and Markdown pages.

Resources

License

Releases

No releases published

Packages

No packages published