You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Jacob Kiers ca830713d3 Merge tag 'v0.3.0' from upstream 5 months ago
cli_docs update to latest ZK version, bump version number 7 months ago
docs update to latest ZK version, bump version number 7 months ago
tzk update to latest ZK version, bump version number 7 months ago
.gitignore use API token to upload to PyPi 7 months ago
LICENSE update copyright notice 1 year ago
MANIFEST.in set up publish to pypi 2 years ago
README.md add walkthrough video to README 2 years ago
RELEASING.md bump version 2 years ago
publish.sh use API token to upload to PyPi 7 months ago
requirements.txt work around ReadTheDocs bug 1 year ago
setup.py update to latest ZK version, bump version number 7 months ago

README.md

Documentation Status

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