Skip to content

Latest commit

 

History

History
155 lines (81 loc) · 6.82 KB

CHANGELOG.md

File metadata and controls

155 lines (81 loc) · 6.82 KB

Changelog

0.4.3 (Unreleased)

Enhancements

  • Removed unwraps to make the codebase more robust.

0.4.2 (2020-09-24)

This is a quick update that should make compiling mdzk easier (and even possible) for Windows users.

We have also experienced some trouble with Windows Defender flagging pre-compiled mdzk binaries as a trojan. This is a false positive. A report is submitted to Microsoft, and we have removed all previously released Windows binaries. We suspect the warning is related to the amount of embedded JavaScript that is contained in mdzk. Hopefully, you will not get any warnings from this version and onwards. If you do, please leave a comment with a screenshot of the warning in this issue.

New features

  • When naming a file the same name as it's parent directory, this file will work as the content of that directory. Namely, the directory will itself function as a note.

Bug fixes

  • Our dependency on mdbook-katex, and subsequently QuickJS, did not work well with most Windows computers. To circumvent this, KaTeX is now loaded from a CDN and handles the rendering client-side. This shouldn't lead to any significant increases in load time, but it is not ideal for offline usage. We are working on embedding KaTeX locally in the generated output, which hopefully will be included soon.

0.4.1 (2020-09-23)

Enhancements

  • The mdzk renderer now converts .md into .html in links/images during rendering.

Bug fixes

  • Fixed init command. It did not produce a correctly formatted config file, and a subsequent build failed.

0.4.0 (2021-09-20)

Breaking changes

  • The [book] table header in mdzk.toml is now changed to [mdzk]. You will need to change this in your own configuration, or else the values will be ignored.
  • The disable-default-processors configuration option is now placed under the [build] table.

New features

  • An ignore field is added under the [mdzk] table. This is a list of gitignore-style patterns that specify files or directories which mdzk should ignore when building.
  • The header above the backlinks can now also be configured under the [mdzk] table, with the backlinks-header field. Both this and the previous preprocessor.backlinks.header field are supported, but you are recommended to use the former, in case we might remove the latter.
  • You can now choose a renderer with the --renderer or -r flag when running build or serve. The choices are between mdbook, markdown or mdzk, the latter being our own work in progress custom renderer. This feature is mostly for debugging purposes.

Enhancements

  • We now use our own configuration struct. This will allow us to more easily expand mdzk with more options and configuration.
  • The mdzk renderer now copies over KaTeX locally in the output, to ensure speedy math rendering.
  • The mdzk renderer now uses the Inter font.

0.3.7 (2021-09-05)

0.3.7 moves mdzk to a monorepo structure. No other changes.

0.3.6 (2021-09-03)

Enhancements

  • The binary's size is now a lot smaller. (f5e6ca4b4bc98e98a3f28a5859665a332ff10262)
  • Sorting now works with non-ASCII characters. (16bb74d62314c4bdaa75809b64caae3e9b2ec7dc)

0.3.5 (2021-08-31)

Enhancements

  • Summary is now sorted by directories first. (78f98d040fe4674c34571d115d8e7de10c14eb97)

Bug fixed

  • Added *.hbs files to Cargo.toml. (3b4bcd98374b4463143fd81cf621b97c198bafae)

0.3.4 (2021-08-27)

Enhancements

  • Moved to lazy_regex for lazy evaluation of regexes instead of doing this manually with lazy_static. This hopefully brings some minor speed improvements.

Bug fixes

  • ' and " threw errors when compiling, because these characters were escaped in their filename, meaning mdzk could not find the source.
  • The URLs produced by our preprocessors did not escape special characters properly. This is now fixed, meaning URLs should all work properly again. Unsupported characters are documented in the README, but repeated here: =, \``, ^, #, |, :, /, [and]. $` is supported, but not recommended, as it might intefere with the KaTeX math delimiters.

0.3.3 (2021-08-24)

New features

  • New front matter field: Use the date (string) field to add a date to the note. The datestring must comply with ISO 8601, with seconds and timezone being optional. If no timezone is specified, the local timezone will be used, though the timezone information is not utilized at the moment.

Enhancements

  • You are now able to use TOML in the front matter, if that suits your fancy.
  • The IndexPreprocessor bundled with mdBook is improved for mdzk and now replaces all links to README.md into index.md. This means you can use the Markdown convention of naming the main page README without having broken links/backlinks.

0.3.2 (2021-08-13)

Bug fixes

  • Once again fixed a hot-reloading loop caused by tracking changes on the summmary file.

0.3.1 (2021-08-13)

Enhancements

  • Prettier log messages. There should be a lot less verbosity when running mdzk now.

0.3.0 (2021-08-12)

Breaking changes

  • mdzk now has a set of defined global variables for the directory tree:

    • Source directory: notes
    • Build directory: html
    • (!) Config file: mdzk.toml
    • (!) Summary file: .mdzk_summary.md (located within the source directory)

    You will (sadly) have to change the files marked with (!) manually for the new version of mdzk to work.

    The advantage of hiding the summary file is that Obsidian users can enjoy their graph view without it being ruined by one monolithic SUMMARY.md node.

Enhancements

  • mdzk init produces a directory tree completely according to the above specification. It does not pollute this tree with any default files like mdBook's chapter_1.md.
  • We (hopefully) now use better HTML escaping, which means characters like ", ' and & should be safer to use.

Bug fixes

  • Both wikilinks and backlinks now use relative paths, which means they should be completely functional regardless of how nested your notes are or how the vault is published.

0.2.4 (2021-08-10)

Sporting the newest additions to mdbook-wikilink and mdbook-backlinks.

New features

  • Disable default processors with the disable_default_processors option.

0.2.3 (2021-08-09)

Bug fixes

  • mdzk serve did not load the correct config, nor update the SUMMARY.md file on file changes. This is now fixed.

0.2.2 (2021-08-06)

New features