vipulgupta2048 / jsdoc-partials-tutorial

Short tutorial on using jsdoc partials

Jsdoc-partials-tutorial

An example repository to demonstrate how to use partials in Jsdoc for the Notes on building docs with JsDoc custom partials post on Mixster.

How to use?

Assuming you have a version of nodeJS and NPM pre-installed.

Start with a clone of this repository

git clone https://github.com/vipulgupta2048/jsdoc-partials-tutorial 

Navigate to the cloned repository.

cd jsdoc-partials-tutorial

Install the dependencies.

npm install

Running the examples

According to the blog post,

To checkout the overwritten example, run the following command:

npm run docs

The generated file will be called DOCUMENTATION.md

To checkout the custom partial example, run the following command:

npm run docs-partial

The generated file will be called partial-docs.md

License

Do What The F*ck You Want To license.