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.
zk/README.md

20 lines
1.1 KiB
Markdown

3 years ago
# `zk` a plain text note-taking assistant
Looking for a quick usage example? [Let's get started](http://mickael-menu.github.io/zk/getting-started).
`zk` is a command-line tool helping you to maintain a plain text [Zettelkasten](https://zettelkasten.de/introduction/) or [personal wiki](https://en.wikipedia.org/wiki/Personal_wiki).
It is primarily focused on:
* [keeping your notebook future-proof](http://mickael-menu.github.io/zk/future-proof), by relying on plain text
* [creating notes from templates](http://mickael-menu.github.io/zk/note-creation)
* performing [advanced search queries](http://mickael-menu.github.io/zk/note-filtering)
* being a hub for everything related to your notes, thanks to [command aliases](http://mickael-menu.github.io/zk/config-alias) and [automation](http://mickael-menu.github.io/zk/automation).
* [notebook housekeeping](http://mickael-menu.github.io/zk/notebook-housekeeping)
What `zk` is not:
* a note editor
* a tool to serve your notes on the web for this, you may be interested in [Neuron](http://mickael-menu.github.io/zk/neuron) or [Gollum](https://github.com/gollum/gollum).