Skip to content

Automatically parse JSDoc to markdown

Cerbrus edited this page Mar 21, 2017 · 1 revision

The project is set up to automatically generate markdown files for your scripts' JSDoc, on save.

This requires jsdco2md to be installed on your system, together with the Atom "on-save" package.
Once you have this installed, copy an existing command in .on-save.json to a new entry in the array, and specify the required file name in files.

You can customize the output file name if you desire. See the "on-save" page for variables you can use.

Once configured, yourScript.md will automatically be generated when you save yourScript.js.

Clone this wiki locally