tzk/README.md
2021-09-22 11:28:36 -05:00

42 lines
1.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[![Documentation Status](https://readthedocs.org/projects/tzk/badge/?version=latest)](https://tzk.readthedocs.io/en/latest/?badge=latest)
**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](https://zettelkasten.sorenbjornstad.com).
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](https://tiddlywiki.com)
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](https://www.youtube.com/watch?v=9X_T-DVie8o).