Skip to main content

Add Zettelkasten features to MkDocs

Project description

MkDocs Zettelkasten

This is a Zettelkasten theme and plugin for MkDocs. It renders the MkDocs pages as cards (zettels).

For more information, head on over to the documentation

Install

pip install mkdocs-zettelkasten

Development

uv sync
uv run pytest
uv run mkdocs serve --livereload

Release

release patch|minor|major              # tag and push -> CI publishes to PyPI
release --pre rc1                      # pre-release current version to TestPyPI
release --pre rc1 minor                # bump + pre-release to TestPyPI
release                                # after rc: strip suffix, release stable to PyPI
release --dry-run patch                # preview without doing anything

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_zettelkasten-0.4.3.tar.gz (782.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_zettelkasten-0.4.3-py3-none-any.whl (755.9 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_zettelkasten-0.4.3.tar.gz.

File metadata

  • Download URL: mkdocs_zettelkasten-0.4.3.tar.gz
  • Upload date:
  • Size: 782.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_zettelkasten-0.4.3.tar.gz
Algorithm Hash digest
SHA256 e54f0876dbacbb0261a7c472ca382d11c5953f2bc4d33aa04689af1a320e6038
MD5 125d3d10306352980725424b9f4d0ef4
BLAKE2b-256 3a4581e853b4dd971b577af94e5e09b76295887ac2437b7be2fdf09aa5edf6e7

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_zettelkasten-0.4.3.tar.gz:

Publisher: publish.yml on buvis/mkdocs-zettelkasten

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_zettelkasten-0.4.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_zettelkasten-0.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 85d9a8e2bba5862a341f1fa503116e327b5918140a99de8ddf4ca08cc2ccb4fe
MD5 7752d87e9bd7810b3005ce1a26a5adf7
BLAKE2b-256 f3fa353b2d14950739921b644ace36047b7467a51c303c614b53061043b31a89

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_zettelkasten-0.4.3-py3-none-any.whl:

Publisher: publish.yml on buvis/mkdocs-zettelkasten

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page