Skip to content

Latest commit

 

History

History
296 lines (160 loc) · 11.5 KB

CHANGELOG.md

File metadata and controls

296 lines (160 loc) · 11.5 KB
Raw

Changelog

v1.18.0

Changed

  • Add ARIA attributes to generated blocks. Thanks to @toastal for suggesting this feature! (#195)
    • Note: This subtly alters the emitted HTML, and could cause additional styles applied to blocks to break. Native mdbook-admonish styles are not affected.

Fixed

  • Fixed some valid configurations producing TOML serialization errors. Thanks to @DianaNites for reporting this! (#197)

v1.17.1

Fixed

  • Removed a stray debug statement (#186)

v1.17.0

Changed

Fixed

  • Titles contining = will now render correctly. Thanks to @s00500 for the bug report! (#181)

v1.16.0

Changed

  • MSRV (minimum supported rust version) is now 1.74.0 (#175)
  • custom directives should now be configured under the directive.custom option. Existing custom configurations are supported for back compatibility (#179)

Added

  • Make blocks collapsible on a per-directive basis. Thanks to @yannickseurin for contributing this feature! (#174)

Fixed

  • The css_id_prefix option now uses snake case for consistency (kebab case remains supported for back compatibility). Thanks to @yannickseurin for fixing this! (#173)

1.15.0

Added

Fixed

  • additional-css unix style path normalization. Thanks to @carlocorradini for reporting and fixing! (#163)

1.14.0

Changed

  • Styles version updated to 3.0.1. Run mdbook-admonish install to update.

Added

  • You can now set custom CSS ids for admonition blocks with the id field. Thanks to @Sky9x for contributing this feature! (#144)
    • You can also now customize the CSS id prefix with the config option default.css_id_prefix

Fixed

  • Improve rendering of blocks in print/PDF view. Thanks to @csk111165 for the report (#152)
  • Fix the default titles for tldr and faq directives looking bad. They now render as TL;DR and FAQ by default. Thanks @joshka for fixing this! (#154)

1.13.1

Changed

  • Bumped internal mdbook version to 0.4.35 (#142)

Fixed

  • Relaxed clap dependency to fix compilation error when using other mdbook-* plugins. Thanks to @joshka for the report! (#142)

1.13.0

Changed

  • Required styles version is now ^3.0.0 (release 1.13.0). Run mdbook-admonish install to update.
  • Internal CSS classnames for directives are now prefixed with admonish-, so warning is now admonish-warning. This avoids a conflict with upstream classnames introduced in mdbook 0.4.35. Thanks to @phoenixr-codes for the report and fix! (#139)

Fixed

  • Some minor inconsistencies in SCSS (and downstream CSS) styles were fixed by adopting Prettier linting (#138)

1.12.1

Fixed

  • Panic when searching for an indent in non-ASCII content. Thanks to @CoralPink for the report! (#128)

1.12.0

Added

  • Admonitions are now supported when indented inside other elements, such as a list. Thanks to @mattburgess for the report! (#124)

1.11.1

Fixed

  • Reverted internal dependency upgrades that unintentionally increased MSRV from 1.66.0 in 1.11.0

1.11.0 (yanked)

Note: This release has been yanked.

It unintentionally increased the MSRV from 1.66.0

Changed

  • gnu prebuilt binaries are now built on ubuntu-20.04 to match mdbook binaries. Thanks to @eitsupi for the fix! (#118)

Added

  • aarch64-unknown-linux-musl prebuilt binary now available (#119)

1.10.2

Fixed

  • Fixed cargo install mdbook-admonish failing due to an internal dependency mismatch with mdbook (#115)

1.10.1

Fixed

  • Only restyle summary elements generated by mdbook-admonish. Thanks to @ImUrX for the report and fix! (#112)

1.10.0

Changed

  • MSRV (minimum supported rust version) is now 1.66.0 for mdbook v0.4.32 (#109)

Added

  • Support mdbook test running doctests inside admonish blocks. Opt-in to this by setting renderer.test.action_mode = "strip" (#109)
  • Log a warning when an invalid admonish block is encountered (#109)

Fixed

  • Document all book.toml configuration options in the reference, some of which were previously undocumened (#109)

1.9.0

Changed

  • Styles version updated to 2.0.1. Run mdbook-admonish install to update.
  • MSRV (minimum supported rust version) is now 1.64.0 for clap v4 (#79)
  • More verbose error messages for invalid TOML configurations (#79)

Added

  • User can set book-wide default for title and collapsible properties (#84), thanks to @ShaunSHamilton

Fixed

  • Custom installation and CSS directories are now normalized (#49)
  • Fix title bars with no text rendering badly (#83), thanks to @ShaunSHamilton
  • Better error message display on crash (#48)
  • Better support for commonmark code fence syntax (#88, #89)

1.8.0

Changed

  • MSRV (minimum supported rust version) is now 1.60.0 for clap v4

1.7.0

Changed

  • Required styles version is now ^2.0.0 (release 1.7.0). Run mdbook-admonish install to update.

Added

  • Support key/value configuration (#24, thanks @gggto and @schungx for design input)
  • Support collapsible admonition bodies (#26, thanks @gggto for the suggestion and implementation!)
  • Make anchor links hoverable (#27)
  • Better handling for misconfigured admonitions (#25)
    • Nicer in-book error messages
    • Option to fail the build instead

1.6.0

Please note: If updating from an older version, this release requires mdboook-admonish install to be rerun after installation.

This behaviour is documented in the readme here, and may appear in any future minor version release.

Changed

  • Required styles version is now ^1.0.0 (release 1.6.0). Run mdbook-admonish install to update.

Added

  • Enforce updating installed styles when required for new features (#19
  • Each admonition has a unique id. Click the header bar to navigate to the anchor link (#19, thanks @schungx for the suggestion)

Fixed

  • Header bar overflow at some zoom levels on Firefox (#21, thanks to @sgoudham for the report)

1.5.0

Added

  • Admonitions now have an autogenerated id, to support anchor links (#16, thanks @schungx for the suggestion)

1.4.1

Changed

  • Bumped locked dependency versions (mdbook v0.4.18)

Packaging

  • Support building and releasing binary artefacts.

1.4.0

Added

  • Additional classnames can be specified using directive.classname syntax
  • Support removing the title bar entirely

Fixed

  • Removed superfluous empty <p> tags in output

1.3.3

Fixed

  • Fixed compilation failure with no default features
  • MSRV (minimum supported rust version) documented as 1.58.0

1.3.2

Fixed

  • Fixed incorrect admonition title/panic when terminating with non-ascii characters
  • Updated readme to note double-JSON string escapes

1.3.1

Fixed

  • Flattened indentation of generated HTML, otherwise it's styled as a markdown code block
  • Fixed edge cases where the info string changes length when parsed, causing title/body to be incorrectly split

1.3.0 (yanked)

Note: This release has been yanked.

It unintentionally introduced a serious parsing bug.

Added

  • Add additional examples and images in readme
  • Allow markdown styling in title content

Fixed

  • Fix HTML being stripping from body content

1.2.0

Added

  • Support custom title text

1.1.0

Added

  • CSS rules for the builtin mdbook themes, to adjust card background color

1.0.1

Fixed

  • Crate metadata and README wording

1.0.0

Added

  • admonish <admonition type> support for code fences
  • Admonition type support is parity with mkdocs as of release