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.1.4.tar.gz (846.9 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tzk-0.1.4.tar.gz
  • Upload date:
  • Size: 846.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for tzk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d13fe07173c2dc3c29f86ac5b478d7d7453f0141fe90093b9e2afbd73f8e3ecb
MD5 114fc9278c547164bdfeb710d9c8d92e
BLAKE2b-256 a71dc46860ba1dbd5e752aaf5b830763e8e4c0003057b91fd8d2be412f4ec748

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tzk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 1.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.7.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for tzk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 99e6fd24a819a0332b8d0fb0563fce953d2561bc3c9a7e0bcf231d2d5b2e04f9
MD5 3846506b9b857d3c8168e0b82fe92bd8
BLAKE2b-256 e1e2163087941d5df58e8b854bc4b3fcd78f5d54de420dbd4485ebb5c0aa3372

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