mdzk

A lovingly designed system and static publishing tool for your plain text Zettelkasten

mdzk is a plain text Zettelkasten system that is based on the mdBook API. It consists of specialized preprocessors for handling key features such as wikilinks, backlinks and front matter, all tied together in the mdzk CLI. mdzk allows you to use whatever text editor you prefer - be it Obsidian, Vim, Visual Studio Code or even Notepad. You can view your notes with live updating as you edit them, have them automatically published to GitHub Pages on push and much more.

Installation

Cargo

You can install mdzk with Cargo by running.

$ cargo install mdzk

Nix

You can use without installing with Nix. Note: This will compile it from source and make it available from your nix store.

$ nix run github:mdzk-rs/mdzk help

Pre-compiled binaries

On the Releases page, you can find pre-compiled binaries for Windows and Linux (x86).

Getting started

We are still figuring out the exact user interface, so there would not be much help in a "getting started" guide just yet. mdzk works very much like mdBook, so you can use their guide for the time being. We hope to provide a full documentation very soon...

Important notes

• Supported characters:

  These characters are disallowed in note filenames: =, `, ^, #, |, :, /, [ and ]. $ is supported, but not recommended, as it might intefere with the KaTeX math delimiters. If you want to use $ in code snippets you would need to escape it with \ first. Example: echo \$HOME.