Skip to content

v2.0.0

Latest

Choose a tag to compare

@github-actions github-actions released this 14 Jan 15:51
· 1 commit to main since this release

See Full Changelog: v0.1.4...v2.0.0

Highlights

  • mdBook 0.5.x support: updated to the mdbook-preprocessor 0.5 API (mdBook 0.5 split the preprocessor interface out of the mdbook crate).

  • Plug-and-play contributors styling: contributors no longer inject raw <style> into chapter HTML. Styling is provided via an automatically managed theme CSS asset.

  • Safer contributors token rendering: {% contributors %} is now treated as a block token to avoid accidental expansion inside documentation examples.

Breaking changes

  • Requires mdBook-0.5.x (mdBook-0.4 users should remain on mdbook-gitinfo-v1.2.x).

  • Contributors token behaviour is stricter:

    • {% contributors %} is only expanded when it appears on its own line.

    • Tokens inside fenced code blocks, indented code blocks, inline code, tables, or general prose are not expanded.

Contributors styling and theme injection

  • When contributors = true:

    • The preprocessor creates theme/gitinfo.css at the book root (if missing).

    • The preprocessor adds theme/gitinfo.css to book.toml under:

      • output.html.additional-css