Change into a directory you’d like to use as your Zettelkasten repository. The directory should be empty, so you’ll probably want to create a new one, e.g.:
$ mkdir my_zettelkasten $ cd my_zettelkasten
tzk init. This will create a tzk configuration file, install TiddlyWiki to this folder, and set up a Git repository.
inithas completed successfully, open the
tzk_config.pyin your favorite text editor. Read the comments and make any changes you would like. See the Builders section of this documentation for more information about builders – but you’ll most likely want to get started with your wiki now and worry about builds once you actually have some content to build!
tzk listenand confirm that you can access your wiki.
Many people find that carefully designing atomic Git commits
when editing a TiddlyWiki
is difficult and not all that useful,
tzk commit command is made available
to quickly stage, commit, and (if you wish) push all changes in the repository in one go.
If you want to push your changes to some remote location,
such as a GitHub repository,
add a new Git remote (e.g.,
git remote add origin https://github.com/you/YourRepository)
and set the
commit_remote option in your tzk config to the remote name
You can selectively skip pushing for a particular commit
--local switch to
If you want to push a wiki that contains only some of your content
to GitHub in a form that others can browse,
don’t try to set it up here –
at the end of the
public build product.
See Builders for more information.
If you’d like to be able to run
tzk from any directory,
rather than having to change into the directory of your tzk repository,
TZK_DIRECTORY environment variable on your system
to its full path.
If the current directory contains a
the current directory will still be preferred to the
TZK_DIRECTORY is not honored when calling
Otherwise tzk would prioritize the
TZK_DIRECTORY over the current directory
since the current directory doesn’t contain a config file yet,
and it would be impossible to initialize a second tzk repository.