An open API service indexing awesome lists of open source software.

https://github.com/sobjornstad/tzk

Zettelkasten edition and tooling for TiddlyWiki
https://github.com/sobjornstad/tzk

notes tiddlywiki tiddlywiki5 zettelkasten

Last synced: 8 months ago
JSON representation

Zettelkasten edition and tooling for TiddlyWiki

Awesome Lists containing this project

README

          

[![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.
It’s updated periodically from whatever tooling I’m currently using
[in my own thinking workspace](https://mosmu.se).
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 for myself.
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).