The API of your Zettelkasten

$ mdzk '"notes"|{"id","title","path","links"}'

[
  {
    "id": "7caaf8918e5c38e4",
    "title": "How to install mdzk",
    "path": "path/note1",
    "links": {
      "incoming": ["1fh553bc8e8c7864", "e9f5b6d155hab7ab"],
      "outgoing: []
    }
  },
  {
    "id": "1fh553bc8e8c7864",
    "title": "Documentation",
    "path": "path/to/note2"
    "links": {
      "incoming": ["e9f5b6d155hab7ab"],
      "outgoing: ["7caaf8918e5c38e4"]
    }
  },
  {
    "id": "e9f5b6d155hab7ab",
    "title": "Manual",
    "path": "path/to/note3"
    "links": {
      "incoming": [],
      "outgoing: ["1fh553bc8e8c7864", "7caaf8918e5c38e4"]
    }
  }
]

What is mdzk?

mdzk is your one-stop tool for connected texts. It is built with interoperability, speed and simplicity in mind. With it, you can build powerful workflows, like generating a static site, producing automatic backlinks, extending your editor's features, diagnosing links, hosting a language server, making a graph and much more.

mdzk aims at providing a general interface that bridges the gap between your tools for note-taking.

Markdown-based

mdzk works with plain text files in an extended variant of the well-defined and widely supported CommonMark Markdown specification.

Using CommonMark ensures that your notes are future-proof, beyond the lifetime of mdzk itself. They remain human-readable, can be version controlled and are editable in close to every text editor there is. Tasked with publishing your notes, you have the choice of using any one of a plethora of static site generators, or you can use mdzk's built-in generator.

Connected notes

The core data structure of an mdzk vault is a non-simple directed graph, which presents a whole new way of thinking about your knowledge-base. Similar to the way wikis work, this model is based on the popular Zettelkasten system, which will help you discover connections you might never have found otherwise. Forget filesystem hierarchies; connected texts are much closer to how our brains actually work.