jsdoc-to-markdown
Advanced tools
jsdoc-to-markdown - npm Package Compare versions
Comparing version 3.0.0 to 3.0.1
@@ -22,5 +22,2 @@ <a name="module_jsdoc-to-markdown"></a> | ||
| - | ||
| <a name="exp_module_jsdoc-to-markdown--JsdocToMarkdown"></a> | ||
@@ -30,5 +27,2 @@ | ||
| **Kind**: Exported class | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+render"></a> | ||
@@ -50,5 +44,5 @@ | ||
| | [options.example-lang] | <code>string</code> | Specifies the default language used in @example blocks (for [syntax-highlighting](https://help.github.com/articles/github-flavored-markdown/#syntax-highlighting) purposes). In gfm mode, each @example is wrapped in a fenced-code block. Example usage: `--example-lang js`. Use the special value `none` for no specific language. While using this option, you can override the supplied language for any @example by specifying the `@lang` subtag, e.g `@example @lang hbs`. Specifying `@example @lang off` will disable code blocks for that example. | | ||
| | [options.plugin] | <code>string</code> | <code>Array.<string></code> | Use an installed package containing helper and/or partial overrides. | | ||
| | [options.helper] | <code>string</code> | <code>Array.<string></code> | handlebars helper files to override or extend the default set. | | ||
| | [options.partial] | <code>string</code> | <code>Array.<string></code> | handlebars partial files to override or extend the default set. | | ||
| | [options.plugin] | <code>string</code> \| <code>Array.<string></code> | Use an installed package containing helper and/or partial overrides. | | ||
| | [options.helper] | <code>string</code> \| <code>Array.<string></code> | handlebars helper files to override or extend the default set. | | ||
| | [options.partial] | <code>string</code> \| <code>Array.<string></code> | handlebars partial files to override or extend the default set. | | ||
| | [options.name-format] | <code>string</code> | Format identifier names in the [code](http://daringfireball.net/projects/markdown/syntax#code) style, (i.e. format using backticks or `<code></code>`). | | ||
@@ -68,5 +62,2 @@ | [options.no-gfm] | <code>boolean</code> | 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. | | ||
| ``` | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateData"></a> | ||
@@ -85,5 +76,2 @@ | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocData"></a> | ||
@@ -102,3 +90,3 @@ | ||
| | [options.no-cache] | <code>boolean</code> | By default results are cached to speed up repeat invocations. Set to true to disable this. | | ||
| | [options.files] | <code>string</code> | <code>Array.<string></code> | One or more filenames to process. Accepts globs (e.g. `*.js`). Either `files`, `source` or `data` must be supplied. | | ||
| | [options.files] | <code>string</code> \| <code>Array.<string></code> | One or more filenames to process. Accepts globs (e.g. `*.js`). Either `files`, `source` or `data` must be supplied. | | ||
| | [options.source] | <code>string</code> | A string containing source code to process. Either `files`, `source` or `data` must be supplied. | | ||
@@ -108,5 +96,2 @@ | [options.configure] | <code>string</code> | The path to the [jsdoc configuration file](http://usejsdoc.org/about-configuring-jsdoc.html). Default: path/to/jsdoc/conf.json. | | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+clear"></a> | ||
@@ -119,5 +104,2 @@ | ||
| **Category**: async | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+getNamepaths"></a> | ||
@@ -135,5 +117,2 @@ | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+renderSync"></a> | ||
@@ -156,5 +135,2 @@ | ||
| ``` | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+getTemplateDataSync"></a> | ||
@@ -172,5 +148,2 @@ | ||
| - | ||
| <a name="module_jsdoc-to-markdown--JsdocToMarkdown+getJsdocDataSync"></a> | ||
@@ -189,4 +162,1 @@ | ||
| - | ||
| { | ||
| "name": "jsdoc-to-markdown", | ||
| "author": "Lloyd Brookes", | ||
| "version": "3.0.0", | ||
| "version": "3.0.1", | ||
| "description": "Generates markdown API documentation from jsdoc annotated source code", | ||
@@ -17,3 +17,3 @@ "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown", | ||
| "test": "test-runner test/*.js", | ||
| "docs": "node bin/cli.js --separators lib/*.js --heading-depth 1 --template jsdoc2md/API.hbs > docs/API.md; echo ", | ||
| "docs": "node bin/cli.js lib/*.js --heading-depth 1 --template jsdoc2md/API.hbs > docs/API.md; echo ", | ||
| "cover": "istanbul cover ./node_modules/.bin/test-runner test/*.js && cat coverage/lcov.info | ./node_modules/.bin/coveralls && rm -rf coverage; echo" | ||
@@ -31,14 +31,14 @@ }, | ||
| "dependencies": { | ||
| "array-back": "^1.0.4", | ||
| "array-back": "^2.0.0", | ||
| "command-line-tool": "^0.7.0", | ||
| "config-master": "^3.0.0", | ||
| "dmd": "^3.0.0", | ||
| "config-master": "^3.1.0", | ||
| "dmd": "^3.0.6", | ||
| "jsdoc-api": "^3.0.0", | ||
| "jsdoc-parse": "^3.0.0", | ||
| "jsdoc2md-stats": "^2.0.0", | ||
| "walk-back": "^2.0.1" | ||
| "jsdoc2md-stats": "^2.0.1", | ||
| "walk-back": "^3.0.0" | ||
| }, | ||
| "devDependencies": { | ||
| "coveralls": "^2.11.16", | ||
| "test-runner": "^0.3.0" | ||
| "coveralls": "^3.0.0", | ||
| "test-runner": "^0.4.1" | ||
| }, | ||
@@ -45,0 +45,0 @@ "standard": { |
New alerts
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
Fixed alerts
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
Worsened metrics
- Total package byte prevSize
- decreased by-0.27%
40418
- Number of package files
- decreased by-5.56%
17
Dependency changes
Updatedarray-back@^2.0.0
Updatedconfig-master@^3.1.0
Updateddmd@^3.0.6
Updatedjsdoc2md-stats@^2.0.1
Updatedwalk-back@^3.0.0