Skip to main content

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.

Metadata

Release files for tzk 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tzk 0.5.1
File Size Uploaded
tzk-0.5.1.tar.gz 1.0 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for tzk 0.5.1
File Interpreter ABI Platform
tzk-0.5.1-py3-none-any.whl Python 3 none any Details

Total release size: 2.5 MB

Release files / tzk-0.5.1.tar.gz

Download URL tzk-0.5.1.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
3d147950eb6d7d1c3506ad409413da5f6777342f29c073303d0cd2cad473d536
BLAKE2b-256 checksum
How to use checksums
12bfbb22006db1f7b7abbf94c9be31f80681507dd5084c178b79defad89d3e41
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / tzk-0.5.1-py3-none-any.whl

Download URL tzk-0.5.1-py3-none-any.whl
Size 1.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
83b3aef931da419afce148833818bad30b3bbdece89c8a694aabfc600213f80c
BLAKE2b-256 checksum
How to use checksums
63f996cc1ca6b781ec27a5f0fd08f1573464ae4946beef8dff25493a932dc922
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release history Release notifications | RSS feed

This release

0.5.1 This release

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page