Skip to content
This repository was archived by the owner on Dec 20, 2019. It is now read-only.

Conversation

@dependabot-preview
Copy link
Contributor

Updates the requirements on docma to permit the latest version.

Release notes

Sourced from docma's releases.

Docma v3.2.2

See changes here and documentation for a live demo.

If you're migrating from Docma v.2.x, please read the CHANGELOG thoroughly before updating your Docma configuration.

Changelog

Sourced from docma's changelog.

3.2.2 (2019-01-08)

Fixed

  • An issue where enumeration value would be incorrectly displayed as undefined in docs parsed from ES5 code.
  • An issue where jsdoc.predicate (or jsdoc.filter) option would not be taken into account.
  • An issue where favicon would not be copied over to the output dir.
  • (Zebra Template) An issue where some special characters within the location hash would cause an error.
  • Invalid assignment error due to ES2015 syntax.

Added

Changed

  • Improved / cleaner symbol names and long names. This also fixes a JSDoc bug that unnecessarily and incorrectly wraps the last level of the notation in quotes and brackets.
  • Updated dependencies to their latest versions.

3.1.0 (2018-12-04)

Fixed

  • An issue with "path" routing which led to 404 page, occurred when a (deep) route was refreshed or loaded directly. (Due to a bug in core dependency.) Fixes #62.
  • An issue where a (harmless) TypeError was thrown when debug is enabled.
  • An issue with $docmaLink due to missing trailing slash, when routing method is "path".

Added

  • (Zebra Template) Added JSDoc [**default**](https://github.com/default) tag support for symbols. Fixes #60.
  • (Zebra Template) Added option contentView.faLibs that defines FontAwesome libraries to be included, such as solid, regular, brands. Set to null to completely exclude FontAwesome from the output. See Zebra documentation. Fixes #63.
  • (Zebra Template) Added option contentView.faVersion that defines FontAwesome icon library version to be included.

Changed

  • Improved SPA route handling.
  • Updated dependencies to latest versions.

3.0.0 (2018-11-18)

Changed

  • BREAKING: Dropped support for Node.js versions 6 & 7. Requires Node.js v8 and later. This change is due to updates to the core dependencies such as fs-extra, jsdoc-x and jsdom.
  • Improved path/query routing.
  • BREAKING: Linking logic has some changes.
  • (Zebra template) Improved support for constant symbols.

Added

  • Ability to force parser type on defined files/paths; by appending a suffix. For Markdown, append :md or :markdown. For HTML, append :htm or html. For example, LICENSE:md will force-parse LICENSE file as markdown. file.partial:html will force-parse file.partial as HTML.
  • Ability to create deeper paths for named groups/routes. e.g. mylib/latest
  • Support for favicon. Set app.favicon to your ICO file's local path.
  • Support for collapsable markdown (i.e. with <details> and <summary> tags). This is great for generating styled collapsable lists (such as F.A.Q.) from your markdown files. If a bookmark (id) is passed in the location hash, that item will auto-expand. See [Docma F.A.Q.][faq] for an example. Note that Edge does not support details/summary tags yet. All other modern browsers have support.
  • Ability to hide or remove specific, partial content from Docma output. For example if you want some part of your README to be visible in GitHub repo but not in your Docma generated documentation... See this for details.
  • New CLI option (-b or --base) for docma serve command to override/set the base path.
  • (Zebra Template) Added support for collapsable markdown (i.e. with <details> and <summary> tags).

Fixed

... (truncated)
Commits

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot ignore this [patch|minor|major] version will close this PR and stop Dependabot creating any more for this minor/major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Pull request limits (per update run and/or open at any time)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Finally, you can contact us by mentioning @dependabot.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants