docma - npm Package Versions

1.5.0 (2017-03-10)

Docma (Builder)

Added

• config.jsdoc.ignored:Boolean option which specifies whether to include documentation symbols marked with @ignore tag.

Docma Web Core

Fixed

• An issue where empty lines would be stripped out from @example content.

Changed

• Improved auto-indention for code in comments.
• Improved $val filter.

Default Template

Added

• Template option outline, which determines the outline style of the sidebar symbols list. ("flat" or "tree"). See documentation and this example for outline set to "tree".
• Template option symbolMeta which specifies whether to add meta information at the end of each symbol documentation such as code file name and line number. Default is false.
• static badge for static members, deprecated badge for deprecated symbols.

Changed

• Improved sidebar design.
• Type.<T> is now represented as Type<T>.
• Default string values are now represented in quotes.

<br />

1.4.7 (2017-03-09)

Docma (Builder)

Fixed

• An issue where build config config.jsdoc.includePattern would not be respected when filtering files.
• An issue where sorting would change when config.jsdoc.hierarchy option is enabled.

<br />

1.4.5 (2017-03-05)

Docma (Builder)

Added

• Build config options: config.jsdoc.allowUnknownTags, config.jsdoc.dictionaries, config.jsdoc.includePattern, config.jsdoc.excludePattern (jsdoc-x feature).
• JSDoc plugin support via the new config.jsdoc.plugins option (jsdoc-x feature).

<br />

1.4.0 (2017-02-13)

Docma (Builder)

Fixed

• Incorrect routing when routing method is set to "path".

Changed

• If config.app.entrance is not set in build configuration, it now defaults to "api".
• If config.app.server is not set in build configuration, it now defaults to "static". ("static" is similar to "github" which generates static HTML files.)

Docma CLI

Changed

• Respecting debug option in config file. If no debug options are set in the command-line arguments (such as --debug, --quiet, --nomin, --jd-out, --verbose, --web-logs); the bitwise debug value from the config file is used, if set.

Docma Web Core

Fixed

• .split() error for null (404) routes.

Changed

• Updated web dependencies to latest versions.

Default Template

Fixed

• A style issue where sidebar would not scroll all the way to the bottom in Firefox. Fixes issue #8.

Changed

• If config.template.title is omitted, config.app.title is used. (Defaults to "Documentation" if not set).

<br />

1.3.0 (2016-11-23)

Docma (Builder)

Added

• Case-sensitive routing option. config.app.routing accepts either a String ("query" or "path" as before) or now, an Object. e.g. { type: "query", caseSensitive: true }. This also fixes issue #3.

Changed

• Updated dependencies to their latest versions.
• Minor code revisions.

Docma Web Core

Added

• Extended support for parsing back-ticks in documentation. Added triple back-tick support for multiline code blocks (<code>```</code>).

Changed

• Improved docma.utils.normalizeTabs() method. Deep indents in JSDoc comments/descriptions are also normalized.
• Improved support for <pre></pre> tags within JSDoc descriptions.

Default Template

Fixed

• An issue where symbols with return type parameters (such as Promise<Array>) would not be escaped and parsed properly. Fixes issue #4.
• An issue where boolean symbol parameters' default values would not be parsed properly. Fixes issue #5.

<br />

1.2.0 (2016-10-31)

Docma CLI

Added

• CLI (command-line interface). Supports config, src, dest and all debug options.

Default Template

Changed

• Updated (one-dark) highlighting styles.

<br />

1.1.1 (2016-08-13)

Default Template

Fixed

• An anchor/linking issue which prevented some browsers (such as Safari) to navigate properly.

<br />

1.1.0 (2016-08-12)

Docma (Builder)

Fixed

• An issue where constructors would still show up in the documentation even though @private is set. Fixed by jsdoc-x.

Changed

• Updated dependencies to their latest versions.
• Minor revisions.

Default Template

Fixed

• Fixed sidebar header/search position when sidebar is collapsed.

Changed

• An access badge is shown next to symbol name, if symbol has private or protected access.
  • Clean up.

<br />

1.0.3 (2016-06-27)

Docma (Builder)

Added

• HTML source file support. You can include HTML files together with JS and markdown files while building your documentation.

Default Template

Changed

• Removed YAML syntax highlighting support because of incorrect auto-detection. Opened an issue here.

<br />

1.0.1 (2016-06-11)

Docma Web Core

[David][david] considers [marked][marked] as [insecure dependency][docma-david]. This is already reported.

Fixed

• Missing web components.

<br />