jsdoc-to-markdown
Advanced tools
Comparing version 9.0.0-0 to 9.0.0-1
@@ -36,2 +36,4 @@ const jsdocApi = require('jsdoc-api') | ||
* @param [options.member-index-format] {} - grouped, list | ||
* @param [options.clever-links] {boolean} - If true, then implements jsdoc 'cleverLinks' algorithm; `{@link}` tags captions with a URL link are rendered in plain text and captions with non-URL links are rendered in monospace. | ||
* @param [options.monospace-links] {boolean} - If true, then `{@link}` tags are rendered in monospace. This option is ignored if `clever-links` is true. | ||
* @return {Promise} | ||
@@ -38,0 +40,0 @@ * @fulfil {string} - the rendered docs |
@@ -153,2 +153,12 @@ /* generation options */ | ||
description: 'Two options to render member lists: [bold]{list} or [bold]{grouped} (default). The [bold]{list} view is loosely-based on the nodejs docs.' | ||
}, | ||
{ | ||
name: 'clever-links', | ||
type: Boolean, | ||
description: 'If true, [bold]{{@link XXX}} tags are rendered in normal text if XXX is a URL and monospace (code) format otherwise.' | ||
}, | ||
{ | ||
name: 'monospace-links', | ||
type: Boolean, | ||
description: 'If true, all [bold]{{@link}} tags are rendered in monospace (code) format. This setting is ignored in [bold]{--clever-links} is true.' | ||
} | ||
@@ -155,0 +165,0 @@ ] |
{ | ||
"name": "jsdoc-to-markdown", | ||
"author": "Lloyd Brookes", | ||
"version": "9.0.0-0", | ||
"version": "9.0.0-1", | ||
"description": "Generates markdown API documentation from jsdoc annotated source code", | ||
@@ -6,0 +6,0 @@ "repository": { |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
22258
467