Skip to content

0.4.3

Compare
Choose a tag to compare
@kmaasrud kmaasrud released this 01 Nov 14:11
· 329 commits to main since this release
Changelog

New features

  • New generate-summary key at the [mdzk] section in mdzk.toml that controls whether mdzk will generate your summary file automatically or not. The default value is true.

  • New preprocessors field under the [build] section in mdzk.toml. This lets you define mdBook preprocessors to be run after the default preprocessors. Order is preserved.

  • New draft option in the front matter. Setting this to true will skip rendering for that note.

    NOTE: Beware that the note will still show up in the index, as that is how mdBook handles draft chapters. We will probably change this behaviour as soon as we release our custom renderer. If you want to hide a note completely from your vault, use the ignore field in mdzk.toml.

Enhancements

  • Removed several dangerous unwraps, to make the codebase more robust.
  • The Nix build now supports Apple Silicon as well.
  • Dependencies have been cleaned up, leading to a slightly smaller binary size.
  • New version of mdbook-wiklinks (0.4.0), that replaces regexes in favor of a combination of pulldown-cmark's iteration and a custom Pest parser. This should decrease build times drastically.
  • Math delimiters are now converted into spans/divs on build. This will hopefully make KaTeX support more robust, and ignore math rendering within code and links.

Bug fixes

  • #38: User-defined preprocessors (through the mdBook-style preprocessor.<name> pattern in the config file) would sometimes interfere with mdzk's default preprocessors. This fix converts all of these preprocessor-statements into the preprocessors field mentioned above, which mdzk can handle the order of.

    NOTE: To simplify compatibility between mdzk and mdbook, we assume the preprocessor has a command on the form mdbook-<name>. Other preprocessors are simply not supported yet. Fields are ignored, so you can only turn preprocessors on or off.

  • #24: mdzk.backlinks-header in the config had no defuault value, which made mdzk panic when it was not set. This is now fixed.