vigour-jsdoc2md

Converts jsdoc comment blocks to markdown

Usage no npm install needed!

<script type="module">
  import vigourJsdoc2md from 'https://cdn.skypack.dev/vigour-jsdoc2md';
</script>

README

Build Status js-standard-style npm version

jsdoc2md

Converts jsdoc comment blocks to markdown

npm i vigour-jsdoc2md

usage

var markdown = jsdoc2md(jsdoc)

Converts jsdoc comment blocks to markdown

  • jsdoc (string) - the jsdoc comment block to convert

example

var jsdoc2md = require('vigour-jsdoc2md')
jsdoc2md(`
/**
 * @id jsdoc2md
 * @function jsdoc2md
 * Converts jsdoc comment blocks to markdown
 * @param {string} jsdoc - the jsdoc comment block to convert
 * @param {object} [options] - an object full of options
 * @returns {string} markdown - the resulting markdown
 */`)

↓

var markdown = jsdoc2md(jsdoc, [options])

Converts jsdoc comment blocks to markdown

  • jsdoc (string) - the jsdoc comment block to convert

  • [options] (object) - an object full of options

  • returns (string) markdown - the resulting markdown