doxstrap

JavaScript documentation generator based on JSDoc syntax, Dox parser, Twitter Bootstrap CSS, and Prism syntax highlighter.

Usage no npm install needed!

<script type="module">
  import doxstrap from 'https://cdn.skypack.dev/doxstrap';
</script>

JavaScript documentation generator based on JSDoc syntax, Dox parser, Twitter Bootstrap CSS, and Prism syntax highlighter.

npm install -g doxstrap

Parse the JSDoc in all source files in src/**/*.js, and write the output to the doc folder:

doxstrap --title "My Docs" --output doc

You can also install it local to your project:

npm install doxstrap --save-dev

./node_modules/doxstrap/bin/doxstrap.js --title "My Docs" --output doc