Go to file
Soren I. Bjornstad 295f61299a update sphinx version 2023-10-15 22:11:12 -05:00
cli_docs update sphinx version 2023-10-15 22:11:12 -05:00
docs fix 'npm bin' bug and update to latest ZK 2023-10-15 21:55:26 -05:00
tzk bump version 2023-10-15 21:56:14 -05:00
.gitignore use API token to upload to PyPi 2022-08-19 17:32:38 -05:00
.readthedocs.yaml add RTD requirements.txt 2023-10-15 22:06:31 -05:00
LICENSE update copyright notice 2022-03-14 20:59:57 -05:00
MANIFEST.in set up publish to pypi 2021-09-21 11:54:05 -05:00
README.md add walkthrough video to README 2021-09-22 11:28:36 -05:00
RELEASING.md bump version 2021-09-21 20:45:44 -05:00
publish.sh use API token to upload to PyPi 2022-08-19 17:32:38 -05:00
requirements.txt update sphinx version 2023-10-15 22:11:12 -05:00
setup.py bump version 2023-10-15 21:56:14 -05:00


Documentation Status

tzk (TiddlyZettelKasten) is a TiddlyWiki edition and associated CLI for maintaining personal notes in something approaching the Zettelkasten method. Its updated periodically from whatever tooling Im currently using in my own Zettelkasten. As such, its currently considered alpha-quality; while it ought to be very stable and theres no meaningful risk of data loss, updating to a newer version might be difficult and Im unlikely to accept patches unless theyre 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.