Archives/zk
2
0
Fork 0
mirror of https://github.com/mickael-menu/zk synced 2024-11-15 12:12:56 +00:00
Code Issues Projects Releases Wiki Activity

Doc: Improve getting started guide (#423)

Browse Source 
Co-authored-by: tjex <tjex@tjex.net>
This commit is contained in:
Sören Tempel 2024-07-12 13:18:19 +00:00 committed by GitHub
parent f0ed61cda7
commit 555e199cfb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/getting-started.md
View File

@ -25,7 +25,8 @@ You can customize your experience using [custom templates](template.md) to gener
<div align="center"><img alt="Create a note" width="85%" src="assets/media/new1.svg"/></div> <div align="center"><img alt="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. 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-E` to create a new note using the current search query as title. From `zk`'s interactive edit screen, press `Ctrl-E` to create a new note using the current search query as title.
@ -33,7 +34,10 @@ From `zk`'s interactive edit screen, press `Ctrl-E` to create a new note using t
## List existing notes ## 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. After some time, hopefully you will have enough notes to be lost in it.
To help structure your notebook, you can add [metadata](note-frontmatter.md) (e.g. keywords/tags) to your notes.
You can then use `zk`'s powerful [filtering capabilities](note-filtering.md) to find the notes you need.
```sh ```sh
$ zk list --tag "recipe" --match "pizza -pineapple" $ zk list --tag "recipe" --match "pizza -pineapple"
@ -48,7 +52,9 @@ Sort the results however you need with `--sort`.
<div align="center"><img alt="Format the list output" width="85%" src="assets/media/list-format.svg"/></div> <div align="center"><img alt="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`. `zk` is aware of the links you set between your notes.
Backlinks or outbound links of a note can be revealed by using the link filtering options.
It even supports listing indirect links thanks to `--recursive`.
<div align="center"><img alt="Format the list output" width="85%" src="assets/media/list-link.svg"/></div> <div align="center"><img alt="Format the list output" width="85%" src="assets/media/list-link.svg"/></div>