jjkiers/tzk
1
0
Fork 0
Code Issues Pull Requests Releases Activity
Fork of https://github.com/sobjornstad/tzk
76 Commits 3 Branches 11 Tags 10 MiB
JavaScript 60.4%
CSS 21.1%
Python 18.2%
Makefile 0.1%
HTML 0.1%
f0bd41f65a
Go to file
Soren I. Bjornstad f0bd41f65a implement more robust private-person replacer 
The previous method occasionally gave incorrect results because it
performed replacements on an entire line, rather than on individual
instances of the text to replace. This usually worked fine, but in rare
cases could create wrong/ugly output, and with future improvements to
what can be replaced could end up causing leaks.

This was a royal PITA to get working, but I'm fairly sure it's correct
now due to all the doctests. Please add more if you find any regressions
or think of cases that aren't covered.
2022-03-16 09:19:49 -05:00
cli_docs bump version and allow use of --version to see it 2022-01-23 17:28:19 -06:00
docs regular update 2022-01-03 15:31:14 -06:00
tzk implement more robust private-person replacer 2022-03-16 09:19:49 -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 try first test pip build 2021-09-10 11:17:50 -05:00
setup.py bump version and allow use of --version to see it 2022-01-23 17:28:19 -06: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.