Skip to main content

Build tool for TiddlyWiki Zettelkasten

Project description

Documentation Status

tzk (TiddlyZettelKasten) is a TiddlyWiki edition and associated CLI for maintaining personal notes in something approaching the Zettelkasten method. It’s updated periodically from whatever tooling I’m currently using in my own thinking workspace. As such, it’s currently considered alpha-quality; while it ought to be very stable and there’s no meaningful risk of data loss, updating to a newer version might be difficult and I’m unlikely to accept patches unless they’re something I want for myself. This is intended primarily as a nice starting platform on which to build your own tooling.

Some basic knowledge of TiddlyWiki is necessary and assumed.

Documentation / Installation

Find a live version of the edition on the web with further instructions at https://sobjornstad.github.io/tzk/. You can find the documentation for the CLI (which handles creating the wiki, versioning with Git, and creating public and other derivative versions of the wiki) at https://tzk.readthedocs.io/en/latest/.

Video walkthrough

Since tzk is still in an alpha state, general instructions on how to use it are somewhat lacking at the moment. To fill in the gap in the meantime, I recorded an hour-long walkthrough showing how you might take notes using tzk; you can select individual sections to watch if that's longer than you want. Watch the video on YouTube.

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

tzk-0.5.1.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

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

tzk-0.5.1-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file tzk-0.5.1.tar.gz.

File metadata

  • Download URL: tzk-0.5.1.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for tzk-0.5.1.tar.gz
Algorithm Hash digest
SHA256 3d147950eb6d7d1c3506ad409413da5f6777342f29c073303d0cd2cad473d536
MD5 6f028504f6a02687bc0c44a0114bb45a
BLAKE2b-256 12bfbb22006db1f7b7abbf94c9be31f80681507dd5084c178b79defad89d3e41

See more details on using hashes here.

File details

Details for the file tzk-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: tzk-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for tzk-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83b3aef931da419afce148833818bad30b3bbdece89c8a694aabfc600213f80c
MD5 a9ec08add1acb11299c1a00c4e7293fe
BLAKE2b-256 63f996cc1ca6b781ec27a5f0fd08f1573464ae4946beef8dff25493a932dc922

See more details on using hashes here.

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