Add screencasts in the Getting Started page

pull/6/head
Mickaël Menu 3 years ago
parent 838f316694
commit a4b961c36a
No known key found for this signature in database
GPG Key ID: 53D73664CD359895

@ -1,7 +1,7 @@
<div align="center">
<h1>zk</h1>
<h4>A plain text note-taking assistant</h4>
<img alt="Screencast" width="85%" src="docs/assets/media/screencast.svg"/>
<img alt="Screencast" width="95%" src="docs/assets/media/screencast.svg"/>
<p>Looking for a quick usage example? <a href="docs/getting-started.md">Let's get started</a>.</p>
</div>

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 40 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 60 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 29 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 98 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 25 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 23 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 21 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 18 KiB

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 91 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 851 KiB

After

Width:  |  Height:  |  Size: 167 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 852 KiB

@ -13,25 +13,52 @@ Initialized a notebook in 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
$ 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!
<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.
From `zk`'s interactive edit screen, press `Ctrl-N` to create a new note using the current search query as title.
<div align="center"><img alt="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
$ zk new --title "An interesting concept"
$ zk list -m "recipe pizza -pineapple"
```
<div align="center"><img alt="Format the list output" width="85%" src="assets/media/list.svg"/></div>
Sort the results however you need with `--sort`.
<div align="center"><img alt="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.
<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`.
<div align="center"><img alt="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.
<div align="center"><img alt="Format the list output" width="85%" src="assets/media/list-interactive.svg"/></div>
## 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`.
```sh
$ zk edit --interactive --match "recipe pizza -pineapple"
@ -40,10 +67,17 @@ $ zk edit --interactive --match "recipe pizza -pineapple"
$ zk edit -i -m "recipe pizza -pineapple"
```
## List existing notes
<div align="center"><img alt="Format the list output" width="85%" src="assets/media/edit.svg"/></div>
If you do not need to edit a note, use `zk list` instead to print context-sensitive results.
## Edit the configuration file
To customize your experience with `zk`, you may want to edit the [user configuration file](config.md).
```sh
$ zk list -m "recipe pizza -pineapple"
$ vim .zk/config.toml
```
Declaring your own [aliases](config-alias.md) is a great way to make your experience with `zk` easier and more familiar.
<div align="center"><img alt="Format the list output" width="85%" src="assets/media/alias.svg"/></div>

Loading…
Cancel
Save