jsdoc-to-markdown
Advanced tools
Comparing version 5.0.1 to 5.0.2
@@ -28,3 +28,3 @@ const jsdocApi = require('jsdoc-api') | ||
* @param [options.partial] {string|string[]} - handlebars partial files to override or extend the default set. | ||
* @param [options.name-format] {string} - Format identifier names in the [code](http://daringfireball.net/projects/markdown/syntax#code) style, (i.e. format using backticks or `<code></code>`). | ||
* @param [options.name-format] {string} - Format identifier names as code (i.e. wrap function/property/class etc names in backticks). | ||
* @param [options.no-gfm] {boolean} - By default, dmd generates github-flavoured markdown. Not all markdown parsers render gfm correctly. If your generated docs look incorrect on sites other than Github (e.g. npmjs.org) try enabling this option to disable Github-specific syntax. | ||
@@ -31,0 +31,0 @@ * @param [options.separators] {boolean} - Put `<hr>` breaks between identifiers. Improves readability on bulky docs. |
@@ -114,3 +114,3 @@ /* generation options */ | ||
}, | ||
{ name: 'name-format', type: Boolean, description: 'Format identifier names as code' }, | ||
{ name: 'name-format', type: Boolean, description: 'Format identifier names as code (i.e. wrap function/property/class etc names in backticks).' }, | ||
{ | ||
@@ -117,0 +117,0 @@ name: 'no-gfm', |
{ | ||
"name": "jsdoc-to-markdown", | ||
"author": "Lloyd Brookes", | ||
"version": "5.0.1", | ||
"version": "5.0.2", | ||
"description": "Generates markdown API documentation from jsdoc annotated source code", | ||
@@ -32,3 +32,3 @@ "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown", | ||
"config-master": "^3.1.0", | ||
"dmd": "^4.0.2", | ||
"dmd": "^4.0.4", | ||
"jsdoc-api": "^5.0.3", | ||
@@ -39,3 +39,3 @@ "jsdoc-parse": "^4.0.1", | ||
"devDependencies": { | ||
"coveralls": "^3.0.6", | ||
"coveralls": "^3.0.7", | ||
"test-runner": "^0.6.0" | ||
@@ -42,0 +42,0 @@ }, |
Updateddmd@^4.0.4