tzk/README.md

31 lines
1.3 KiB
Markdown
Raw Normal View History

2021-09-21 16:43:51 +00:00
[![Documentation Status](https://readthedocs.org/projects/tzk/badge/?version=latest)](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.
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
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/.