2021-09-21 16:43:51 +00:00
|
|
|
|
[](https://tzk.readthedocs.io/en/latest/?badge=latest)
|
|
|
|
|
|
|
2021-09-21 16:32:33 +00:00
|
|
|
|
**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](https://zettelkasten.sorenbjornstad.com).
|
|
|
|
|
|
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](https://tiddlywiki.com)
|
|
|
|
|
|
is necessary and assumed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Documentation / Installation
|
2021-09-22 16:28:36 +00:00
|
|
|
|
----------------------------
|
2021-09-21 16:32:33 +00:00
|
|
|
|
|
|
|
|
|
|
Find a live version of the edition on the web with further instructions
|
2021-09-21 16:56:08 +00:00
|
|
|
|
at https://sobjornstad.github.io/tzk/.
|
2021-09-21 16:32:33 +00:00
|
|
|
|
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)
|
2021-09-21 16:56:08 +00:00
|
|
|
|
at https://tzk.readthedocs.io/en/latest/.
|
2021-09-22 16:28:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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](https://www.youtube.com/watch?v=9X_T-DVie8o).
|
