Go to file
Soren I. Bjornstad ea7f7edf91 reorganize to prepare for publish 2021-09-21 11:32:33 -05:00
cli_docs reorganize to prepare for publish 2021-09-21 11:32:33 -05:00
docs reorganize to prepare for publish 2021-09-21 11:32:33 -05:00
tzk make _set_text_field work properly when 1 line long 2021-09-21 10:24:28 -05:00
.gitignore reorganize to prepare for publish 2021-09-21 11:32:33 -05:00
README.md reorganize to prepare for publish 2021-09-21 11:32:33 -05:00
requirements.txt try first test pip build 2021-09-10 11:17:50 -05:00
setup.py reorganize to prepare for publish 2021-09-21 11:32:33 -05:00

README.md

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://readthedocs.org/projects/tzk/.