jjkiers/tzk
1
0
Fork 0
Code Issues Pull Requests Releases Activity
Fork of https://github.com/sobjornstad/tzk
86 Commits 3 Branches 11 Tags 10 MiB
JavaScript 60.4%
CSS 21.1%
Python 18.2%
Makefile 0.1%
HTML 0.1%
04272c3973
Go to file
Soren I. Bjornstad 04272c3973 also privatize JSON tiddlers 
This seems slightly dangerous because we're just applying the same
replacement logic and JSON has a much fussier syntax. However, if any
tiddlers end up invalid we should just get a build failure, so this
doesn't seem highly consequential.
2022-08-19 17:14:06 -05:00
cli_docs pull ZK updates and bump version 2022-03-27 15:19:41 -05:00
docs pull ZK updates and bump version 2022-03-27 15:19:41 -05:00
tzk also privatize JSON tiddlers 2022-08-19 17:14:06 -05:00
.gitignore check in editions directory 2021-09-21 12:27:23 -05:00
LICENSE update copyright notice 2022-03-14 20:59:57 -05:00
MANIFEST.in set up publish to pypi 2021-09-21 11:54:05 -05:00
publish.sh activate venv before trying publish 2021-09-22 11:29:05 -05:00
README.md add walkthrough video to README 2021-09-22 11:28:36 -05:00
RELEASING.md bump version 2021-09-21 20:45:44 -05:00
requirements.txt work around ReadTheDocs bug 2022-03-27 15:22:31 -05:00
setup.py pull ZK updates and bump version 2022-03-27 15:19:41 -05:00

README.md

Documentation Status

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. 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 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.