MkDocs Zettelkasten

This is a reference guide and a demo of MkDocs Zettelkasten features. If you are new to Zettelkasten method, then check zettelkasten.de - Getting Started.

The purpose of MkDocs is documentation generation. However, Zettelkasten is a method for smartly organizing your notes. I couldn't find any elegant solution to convert my notes from markdown to something pleasant to read and navigate. That is why I built MkDocs Zettelkasten.

The documentation you are reading is created using MkDocs Zettelkasten (yes, I'm eating my own dog food 😊) only to demonstrate its features. If you are writing documentation, don't use MkDocs Zettelkasten. Material for MkDocs is better for that.

Ok, you are still here, so your goal is to turn your markdown-based Zettelkasten into a static, nicely looking HTML site packed with features every smart notes taker needs. Let's see how I can help.

Note

This site uses Zettelkasten conventions — pages are named by timestamp IDs (e.g. 20211122194827) rather than slugs. This is the intended workflow the plugin supports.

Features

Quick start

Additional information

From here you can search the entire zettelkasten. Enter your search terms below.
Keys Action
? Open this help
n / → Next page
p / ← Previous page
s Search
Color Scheme
Light Dark
Code Theme
def greet(name: str) -> str:
    """Return a greeting."""
    return f"Hello, {name}!"

print(greet("Zettelkasten"))