@ -13,25 +13,52 @@ Initialized a notebook in my-notes
$ cd my-notes
$ cd my-notes
```
```
## Edit the configuration file
## Create your first notes
To customize your experience with `zk`, you may want to edit the [user configuration file](config.md).
Now you are ready to write your very first note. Pick a subject, [create a new note](note-creation.md) and write on!
```sh
```sh
$ vim .zk/config.toml
$ zk new --title "An interesting concept"
```
```
## Create your first notes
You can customize your experience using [custom templates](template.md) to generate many kind of notes.
Now you are ready to write your very first note. Pick a subject, [create a new note](note-creation.md) and write on!
<divalign="center"><imgalt="Create a note"width="85%"src="assets/media/new1.svg"/></div>
If you are not sure whether a note already exists for a particular subject, the "search or create" mode might be more appropriate than `zk new`. It is inspired by [Notational Velocity](https://notational.net/) and enables searching for an existing note or creating a new one in a single action.
From `zk`'s interactive edit screen, press `Ctrl-N` to create a new note using the current search query as title.
<divalign="center"><imgalt="Create a note"width="85%"src="assets/media/new2.svg"/></div>
## List existing notes
After some time, hopefully you will have enough notes to be lost in it. Use `zk`'s powerful [filtering capabilities](note-filtering.md) to find the notes you need.
```sh
```sh
$ zk new --title "An interesting concept"
$ zk list -m "recipe pizza -pineapple"
```
```
<divalign="center"><imgalt="Format the list output"width="85%"src="assets/media/list.svg"/></div>
Sort the results however you need with `--sort`.
<divalign="center"><imgalt="Format the list output"width="85%"src="assets/media/list-sort.svg"/></div>
`--format` and `--delimiter` offer some versatile formatting options to customize the output.
<divalign="center"><imgalt="Format the list output"width="85%"src="assets/media/list-format.svg"/></div>
`zk` is aware of the links you set between your notes. You can use the linking options to find the backlinks or outbound links of a note. It even supports listing indirect links thanks to `--recursive`.
<divalign="center"><imgalt="Format the list output"width="85%"src="assets/media/list-link.svg"/></div>
`zk` supports an interactive mode powered by [`fzf`](https://github.com/junegunn/fzf) to further filter notes manually.
<divalign="center"><imgalt="Format the list output"width="85%"src="assets/media/list-interactive.svg"/></div>
## Edit existing notes
## Edit existing notes
After some time, hopefully you will have enough notes to be lost in it. Use `zk`'s powerful [filtering capabilities](note-filtering.md) to find what you need.
To edit notes with your default editor, use `zk edit`. It supports the same [filtering options](note-filtering.md) as `zk list`.