You can install mdzk with Cargo by running

cargo install mdzk

mdzk will soon also be available as a pre-built binary for quicker installation.

Support for backlinks.

Docs here

We support the following syntaxes for internal links:

  • <span class="missing-link" style="color:darkred;">File</span> to link to a file;
  • <span class="missing-link" style="color:darkred;">File</span> to link to a file and put a custom title in-place;
  • <span class="missing-link" style="color:darkred;">File#Header</span> to link to a specific header inside a file;

Docs here

Docs here

Docs here

Docs here

GitHub Pages workflow

...

!assets/logo.png

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.

mdzk is a prototype of a plain text Zettelkasten system and static site generator on top of the mdBook API. Currently, mdzk extends mdBook's functionalities with some 2. Features.