Skip to content

Latest commit

 

History

History
197 lines (140 loc) · 11.3 KB

CHANGELOG.md

File metadata and controls

197 lines (140 loc) · 11.3 KB
Raw

antsibull-docs -- TypeScript library for processing Ansible documentation markup Release Notes

Topics

v1.1.0

Release Summary

Bugfix and feature release that improves markup parsing and generation with respect to whitespace handling and escaping.

Minor Changes

  • Allow to determine how to handle whitespace during parsing with the new whitespace option (#295).
  • Always remove some whitespace around HORIZONTALLINE (#295).
  • Apply postprocessing to RST and MarkDown to avoid generating invalid markup when input contains whitespace at potentially dangerous places (#296).

Bugfixes

  • Do not apply URI encoding to visible URL (#286).
  • Fix RST escaping to handle other whitespace than spaces correctly (#296).
  • Improve handling of empty URL for links (#286).

v1.0.2

Release Summary

Bugfix release.

Bugfixes

  • Fix handling of empty markup parameters for RST (#262).

v1.0.1

Release Summary

Maintenance release.

Bugfixes

  • Properly escape MarkDown link targets (#197).

v1.0.0

Release Summary

First stable release. This package is using semantic versioning, so there will be no more breaking changes until the release of 2.0.0.

v0.4.0

Release Summary

New major release that increases compatibility with the Python code in antsibull-docs-parser.

Minor Changes

  • Also escape . in MarkDown (#51).

Breaking Changes / Porting Guide

  • Rename current_plugin options of various functions to currentPlugin, and the role_entrypoint option of parse to roleEntrypoint (#49).

Bugfixes

  • Fix URL escaping in MarkDown (#51).

v0.3.0

Release Summary

Feature release.

Minor Changes

  • Add support for plain RST rendering (#42).

v0.2.0

Release Summary

New major release that increases compatibility with the Python code in antsibull-docs-parser.

Minor Changes

  • Add support for ansible-doc like text output (#36).
  • Add support for semantic markup in roles (#31).
  • Allow to add markup source to every paragraph part (#37).
  • Can switch between error messages containing a shortened version of the faulty markup or the full faulty markup command (#38).
  • Improve error messages by removing superfluous second Error: (#22).
  • Make parsing of P(...) more similar to Python code with respect to error reporting (#22).

Breaking Changes / Porting Guide

  • All DOM parts have a new source property, which must be a string or undefined (#37).
  • By default, the error messages now contain the full faulty markup command (#38).
  • Extend OptionNamePart and ReturnValuePart interfaces by adding entrypoint (ansible-community/antsibull-docs-parser#9).
  • Modify pluginOptionLikeLink signature to include a new argument entrypoint after plugin (#31).
  • Rename only_classic_markup parser option to onlyClassicMarkup (#22).

Bugfixes

  • HTML and MarkDown code: quote HTML command arguments correctly; make sure URLs are correctly quoted (#22).

v0.1.0

Release Summary

First usable version, including semantic markup support.

Minor Changes

  • Add support for semantic markup (#1).
  • Added MarkDown support (#5).
  • Allow to adjust formatting for HTML, RST, and MarkDown output by allowing to provide formatting functions for every part type (#12).
  • Allow to chose between antsibull-docs like formatting (for Sphinx targets) and plain formatting for HTML (#12).
  • Build both ESM and CommonJS modules for easier consumption in both webpack and node.js projects (#14).
  • Mention paragraph number in error messages when not processing single strings (#11).

Breaking Changes / Porting Guide

  • The package was renamed on npmjs.com from antsibull_docs to antsibull-docs (#15).

Bugfixes

  • Fix error message output for MarkDown. Make sure error message is escaped in RST. Fix error messages when parsing escaped parameters (#8).
  • The parse() option errors's default was exception, and not message as documented. The default is now message (#6).

v0.0.1

Release Summary

Initial release.