apidoc - npm Package Versions

CLI

• Bugfix: Multiple bin parameters. 244

Template

• Update template vendor lib path-to-regexp.
• Bugfix: Example overlaps navigation. 240

Parser

• Update dependencies.

CLI

• Add some version information for verbose / debug output.

Parser

• Bugfix: Parse blocks with unknown parameters (before the block was skipped).
• Bugfix: show correct block index.
• Update dependencies.

• Unindent strings in description fields. Mulitlines start with the same leading whitespaces. 173

CLI

• Add parameter --parse-languages for custom language regex.

Parser

• Add Clojure parser for .clj files.
• Extend parser to transfer own language regex.
• Update apidoc-core interface (replace arguments with setters).

Template

• Add chinese and dutch translations files.

Split apidoc code

• apidoc is now only the CLI-Tool with UI-Template and file creation (as you know it). You can use apidoc without change anything.

• apidoc-core (for developers) is the parser and response the api-data.

• apidoc-example (for developers) are the test files for the apidoc-spec.

CLI

• Replace optimist (not maintained anymore) with nomnom: true / false parameters can now be used, e.g. enable markdown (default) --markdown or disable --no-markdown.
• Add parameter --markdown.
• Replace the custom Logger with winston.

Parser

• Bugfix: Settings to enable / disable markdown (marked-gfm was previously used).

Template

• Add generator.url and generator.name to the footer generator information (for custom ui-generators).
• Move handlebars_helper.js to utils/

Common

• Remove grunt dependencies (test run with npm run test).
• Change grunt-apidoc (0.10.0) to use always the latest version of apiDoc.

Parser

• Allow overwrite of packageInfo e.g. from grunt task (https://github.com/apidoc/apidoc/pull/177)

Bugfix: Extend parser regexp to allow inline comment-code (https://github.com/apidoc/apidoc/pull/180)

Bugfix: Slash only path in api triggered error (https://github.com/apidoc/apidoc/pull/159)

Bugfix: Scrollspy offset (https://github.com/apidoc/apidoc/pull/176)

Bugfix: Get package infos from package.json or apidoc.json (https://github.com/apidoc/apidoc/pull/169)

CLI

• Allow to include an external file which can set the markdown settings. (https://github.com/apidoc/apidoc/pull/166)

Template

• Add custom order in apidoc.json Append apiName or apiGroup in the order list:

  "order": [
    "MyGroupName",
    "MyParameterName",
    "MyOtherParameterName"
  ]
  

• Speed up rendering of subtemplates (https://github.com/apidoc/apidoc/issues/164)

• Bugfix: Special char doesn't show in @apiGroup. (https://github.com/apidoc/apidoc/issues/163)