jjkiers
/
tzk
1
0
Fork 0
Code Issues Pull Requests Releases Activity
59 Commits 3 Branches 11 Tags 10 MiB
JavaScript 60.4%
CSS 21.1%
Python 18.2%
Makefile 0.1%
HTML 0.1%
Go to file
Soren I. Bjornstad ec83de9978 fix 'compile_html_file' to use dirs_exist_ok 
5065efd3 incorrectly changed to doing an rmtree of the entire target
since that was what editionify needed. Editionify should clean the
target directory, but the single HTML file build should not (it ended up
wiping my git repository from my hard drive). We might wish to revisit
this particular fix in the future since it still fails to delete removed
extimages, but this doesn't seem like a big deal.
 		2021-09-21 21:13:30 -05:00
cli_docs bump version 2021-09-21 20:45:44 -05:00
docs don't carry FileSystemPaths into emptified edition 2021-09-21 20:44:12 -05:00
tzk fix 'compile_html_file' to use dirs_exist_ok 2021-09-21 21:13:30 -05:00
.gitignore check in editions directory 2021-09-21 12:27:23 -05:00
LICENSE add MIT license 2021-09-21 11:39:01 -05:00
MANIFEST.in set up publish to pypi 2021-09-21 11:54:05 -05:00
README.md update README URLs 2021-09-21 11:56:08 -05:00
RELEASING.md bump version 2021-09-21 20:45:44 -05:00
publish.sh don't upload to test pypi for the real publish >__< 2021-09-21 12:42:01 -05:00
requirements.txt try first test pip build 2021-09-10 11:17:50 -05:00
setup.py bump version 2021-09-21 20:45:44 -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/.