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 Zettelkasten. 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 in my own Zettelkasten. 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.3.0.tar.gz (862.0 kB view details)

Uploaded Source

Built Distribution

tzk-0.3.0-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tzk-0.3.0.tar.gz
  • Upload date:
  • Size: 862.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.5

File hashes

Hashes for tzk-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f919be46732060b7a4db469b0f045f9ac897aba9fa415e68ea18b9d5761a7512
MD5 446dc2ea016dba15906dcb80f590ddff
BLAKE2b-256 f14e52ec02735891e5f475042706e74420023bea06d3b877297df57d49d54192

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tzk-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.5

File hashes

Hashes for tzk-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a7fa8d927776072a6b2c50cf937e4f896d8a23cc6a8cc0f48fb92e655dd3599
MD5 ef1a92cc825ad20e92f9776f0796ff6c
BLAKE2b-256 c05057682e4dde3889c3bcce83a51fc9315fa568eaa26f401c26bb091073eedc

See more details on using hashes here.

Supported by

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