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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tzk-0.4.0.tar.gz
  • Upload date:
  • Size: 986.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for tzk-0.4.0.tar.gz
Algorithm Hash digest
SHA256 b13f1cb0ef16ec23a8665a9b950e4fb0dd4133fd8003e9aa4102efff1048d2d5
MD5 e7cf637f04c7d59b54c15d9c8afbeb50
BLAKE2b-256 0248aa64c7dbe86ffb0c231197b32669382c869c391a5af681912f6ceef1fc22

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tzk-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 555cdc59ef51b6876cad93d84e8e890420629b7cc55c15bf833b5831337a037a
MD5 328fba35dfdc42350e957f0bd7c743f0
BLAKE2b-256 2f974aff10a3bf62a2c706b61cb445c98c83676b12c158822772abd9d438e8cb

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