Go to file
Soren I. Bjornstad a1c946db9e update to latest ZK version, bump version number 2022-08-19 17:27:43 -05:00
cli_docs update to latest ZK version, bump version number 2022-08-19 17:27:43 -05:00
docs update to latest ZK version, bump version number 2022-08-19 17:27:43 -05:00
tzk update to latest ZK version, bump version number 2022-08-19 17:27:43 -05:00
.gitignore check in editions directory 2021-09-21 12:27:23 -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 activate venv before trying publish 2021-09-22 11:29:05 -05:00
requirements.txt work around ReadTheDocs bug 2022-03-27 15:22:31 -05:00
setup.py update to latest ZK version, bump version number 2022-08-19 17:27:43 -05:00

README.md

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.