From a4b961c36a96628471b18ab4a4429daa4560e4d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mickae=CC=88l=20Menu?= Date: Fri, 5 Mar 2021 21:56:15 +0100 Subject: [PATCH] Add screencasts in the Getting Started page --- README.md | 2 +- docs/assets/media/alias.svg | 102 ++++++++++++++++ docs/assets/media/edit.svg | 107 +++++++++++++++++ docs/assets/media/list-format.svg | 100 ++++++++++++++++ docs/assets/media/list-interactive.svg | 98 ++++++++++++++++ docs/assets/media/list-link.svg | 97 +++++++++++++++ docs/assets/media/list-sort.svg | 95 +++++++++++++++ docs/assets/media/list.svg | 98 ++++++++++++++++ docs/assets/media/new1.svg | 96 +++++++++++++++ docs/assets/media/new2.svg | 102 ++++++++++++++++ docs/assets/media/screencast.svg | 150 +++++++++++++++++++++++- docs/assets/media/screencast_shadow.svg | 19 --- docs/getting-started.md | 54 +++++++-- 13 files changed, 1089 insertions(+), 31 deletions(-) create mode 100644 docs/assets/media/alias.svg create mode 100644 docs/assets/media/edit.svg create mode 100644 docs/assets/media/list-format.svg create mode 100644 docs/assets/media/list-interactive.svg create mode 100644 docs/assets/media/list-link.svg create mode 100644 docs/assets/media/list-sort.svg create mode 100644 docs/assets/media/list.svg create mode 100644 docs/assets/media/new1.svg create mode 100644 docs/assets/media/new2.svg delete mode 100644 docs/assets/media/screencast_shadow.svg diff --git a/README.md b/README.md index 980f673..cd5cf1e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@

zk

A plain text note-taking assistant

-Screencast +Screencast

Looking for a quick usage example? Let's get started.

diff --git a/docs/assets/media/alias.svg b/docs/assets/media/alias.svg new file mode 100644 index 0000000..4422111 --- /dev/null +++ b/docs/assets/media/alias.svg @@ -0,0 +1,102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk list --format "{{word-count}}\t{{title}}" --sort word-count --limit 10 $ zk list --format "{{word-count}}\t{{title}}" --sort word-count --limit 10 7 Interesting subject10 March 05, 202154 A future-proof notebook69 Setting your default editor88 Automating frequent tasks93 Setting your default pager101 Call zk from other programs106 zk – a plain text note-taking assistant117 Notebook122 StylingFound 10 notes$ vim .zk/config.toml 1 [note] 1 filename = "{{slug title}}" 2 template = "default.md" 3 4 [group.journal.note] 5 filename = "{{date now}}" 6 template = "journal.md" 7 8 [tool] 9 editor = "nvim" 10 fzf-preview = "bat -p --theme Nord --color always {-1}" 11 12 [alias] ~ docs/.zk/config.toml 12 [note] 11 filename = "{{slug title}}" 10 template = "default.md" 9 8 [group.journal.note] 7 filename = "{{date now}}" 5 4 [tool] 3 editor = "nvim" 2 fzf-preview = "bat -p --theme Nord --color always {-1}" 1 13 [alias] 13 [note] 12 filename = "{{slug title}}" 11 template = "default.md" 10 9 [group.journal.note] 8 filename = "{{date now}}" 7 template = "journal.md" 6 5 [tool] 4 editor = "nvim" 3 fzf-preview = "bat -p --theme Nord --color always {-1}" 2 1 [alias] 14 -- INSERT -- 14 wc = "zk list --quiet --format '{{word-count}}\t{{title}}' --sort word- count --limit 10 $@" count --limit 10 $@" count --limit 10 $@" : :q "docs/.zk/config.toml" $ zk wc $ zk wc $ zk wc --exclude journal --limit 5 $ zk wc --exclude journal --limit 5 $ + \ No newline at end of file diff --git a/docs/assets/media/edit.svg b/docs/assets/media/edit.svg new file mode 100644 index 0000000..9e7f39e --- /dev/null +++ b/docs/assets/media/edit.svg @@ -0,0 +1,107 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk edit $ zk edit --interactive $ zk edit --interactive --created-after "last week" > ╭──────────────────────────────────────╮ 4/4 (0) │ │ Ctrl-N: create a note with the quer.. │ │> A future-proof notebook `zk` is de.. │ │ Interesting subject I'm writing ab.. │ │ March 05, 2021 What did I do today.. │ │ Notebook housekeeping Tending to y.. │ │ │ │ ╰──────────────────────────────────────╯ 4/4 (0) │ # A future-proof notebook │ Ctrl-N: create a note with the quer.. │ │> A future-proof notebook `zk` is de.. │ `zk` is designed to be future-proof │ Interesting subject I'm writing ab.. │ and rely on simple plain text format │ March 05, 2021 What did I do today.. │ s such as Markdown. │ Notebook housekeeping Tending to y.. │ │ │ The shape of your [notebook](noteboo │ │ k.md) is entirely up to you, making │ │ │ A future-proof notebook `zk` is de.. │ `zk` is designed to be future-proof │> Interesting subject I'm writing ab.. │ and rely on simple plain text format │ 4/4 (0) │ # Interesting subject │ A future-proof notebook `zk` is de.. │ I'm writing about it │> Interesting subject I'm writing ab.. │ │ March 05, 2021 What did I do today.. │ │ 4/4 (1) │ # Interesting subject │ >Interesting subject I'm writing ab.. │ │> March 05, 2021 What did I do today.. │ │ 4/4 (1) │ # March 05, 2021 │ A future-proof notebook `zk` is de.. │ What did I do today? │ >Interesting subject I'm writing ab.. │ * │> Notebook housekeeping Tending to y.. │ │ 4/4 (1) │ # Notebook housekeeping 1/26 │ A future-proof notebook `zk` is de.. │ Tending to your notes does not only │ >Interesting subject I'm writing ab.. │ mean writing. You need to keep your │> Notebook housekeeping Tending to y.. │ ## Find related notes │ │ To surf your notebook with ease, mak │ │ e sure to link all related notes tog │ │ ether. You can list notes which coul │ │ d be good candidates for a new link │ │ with the `--related` [filtering opti │ │ on](note-filtering.md). │ │ ```sh │ │ $ zk list --related note.md │ │ ``` │ │ This returns notes which are not con │ │ nected to the given note, but with a │ │ t least one linked note in common. │ │ ## Find flimsy notes │ 4/4 (2) │ # Notebook housekeeping 1/26 │>>Notebook housekeeping Tending to y.. │ ## Find related notes │ 1 # Interesting subject 1 2 I'm writing about it 3 ~ docs/interesting-subject.md 1 # Interesting subject : :ne :nex :next :next 1 # Notebook housekeeping 2 Tending to your notes does not only mean writing. You need to keep your notebook in great shape to make good use of it. For many maintenance tasks, zk can help! 4 ## Find related notes 5 6 To surf your notebook with ease, make sure to link all related notes together. You can list notes which could be good candidates for a new link with the --related filtering option. 7 8 ```sh 9 $ zk list --related note.md 10 ``` 11 12 This returns notes which are not connected to the given note, but with at least one linked note in common. 13 14 ## Find flimsy notes 15 16 To find flimsy notes needing to be fleshed out, you can list the first few notes with the smallest word count from your notebook with the @@@ docs/notebook-housekeeping.md :next 1 # Notebook housekeeping :next Z $ + \ No newline at end of file diff --git a/docs/assets/media/list-format.svg b/docs/assets/media/list-format.svg new file mode 100644 index 0000000..934ebf8 --- /dev/null +++ b/docs/assets/media/list-format.svg @@ -0,0 +1,100 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk list -qn3 $ zk list -qn3 A future-proof notebook future-proof.md (6 days ago) ‣ `zk` is designed to be future-proof and rely on simple plain text formats such as Markdown.Automating frequent tasks automation.md (2 weeks ago) ‣ `zk` was designed with automation in mind and strive to be [a good Unix citizen](https://en.wikipedia.org/wiki/Unix_philosophy). As such, it offers a number of ways to interface with other programs:Call zk from other programs external-call.md (2 weeks ago) ‣ Calling `zk` from other programs can be useful in a number of situations, such as:$ zk list -qn3 --format full A future-proof notebook future-proof.mdCreated: 02/26/2021Modified: 02/26/2021 `zk` is designed to be future-proof and rely on simple plain text formats such as Markdown. The shape of your [notebook](notebook.md) is entirely up to you, making `zk` flexible enough to be used in a variety of contexts. However, `zk` shines in a Zettelkasten-style notebook with many small interlinked notes.Automating frequent tasks automation.mdCreated: 02/20/2021Modified: 02/20/2021 `zk` was designed with automation in mind and strive to be [a good Unix citizen](https://en.wikipedia.org/wiki/Unix_philosophy). As such, it offers a number of ways to interface with other programs: * [write command aliases](config-alias.md) for repeated complex commands * [call `zk` from other programs](external-call.md) * [send notes for processing by other programs](external-processing.md) * [create a note with initial content](note-creation.md) from a standard input pipe: If you find out that `zk` does not behave as expected or could communicate better with other programs, [please post an issue](https://github.com/mickael-menu/zk/issues).Call zk from other programs external-call.md Calling `zk` from other programs can be useful in a number of situations, such as: * creating notes from your text editor using a custom shortcut * creating a reference note from the text selected in your web browser * automating periodical maintenance tasks on your [notebook](notebook.md) * displaying the backlinks of a note in a GUI wrapper around `zk` The following options can be useful to make sure `zk` behaves properly in a background context: <!-- TODO: --color=none, --json --> * `--no-input` disables all user prompts and ignores `--interactive` * `--quiet` reduces unnecessary output(END) $ zk list -qn5 --format oneline $ zk list -qn5 --format oneline Command aliases config-alias.md (2 weeks ago)Configuration file config.md (3 weeks ago)$ zk list -qn5 --format path $ zk list -qn5 --format path future-proof.mdautomation.mdexternal-call.mdconfig-alias.mdconfig.md$ zk list -qn5 --format path --delimiter , $ zk list -qn5 --format path --delimiter , future-proof.md,automation.md,external-call.md,config-alias.md,config.md$ zk list -qn5 --format "{{word-count}}\t{{style 'green underline' title}}" $ zk list -qn5 --format "{{word-count}}\t{{style 'green underline' title}}" 54 A future-proof notebook88 Automating frequent tasks101 Call zk from other programs1009 Command aliases345 Configuration file$ + \ No newline at end of file diff --git a/docs/assets/media/list-interactive.svg b/docs/assets/media/list-interactive.svg new file mode 100644 index 0000000..f5e3297 --- /dev/null +++ b/docs/assets/media/list-interactive.svg @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk list --interactive $ zk list --interactive > ╭──────────────────────────────────────╮ 27/27 (0) │ │> A future-proof notebook `zk` is de.. │ │ Automating frequent tasks `zk` was.. │ │ Call zk from other programs Callin.. │ │ Command aliases A command alias is.. │ │ Configuration file Each [notebook].. │ │ Creating a new note You can add a .. │ │ Extra user variables `zk` is opene.. │ │ Getting started with zk A short in.. │ │ Integration with fzf [`fzf`](https.. │ │ Interesting subject I'm writing ab.. │ │ Maintaining a daily journal Let's .. │ │ March 05, 2021 What did I do today.. │ │ Neuron [Neuron](https://neuron.zet.. │ │ Note ID Each note is uniquely iden.. │ │ Note configuration The `[note]` se.. │ │ Note group A *group* is a named [c.. │ │ Notebook A *notebook* is a directo.. │ │ Notebook housekeeping Tending to y.. │ │ Searching and filtering notes A fe.. │ │ Send notes for processing by other .. │ │ Setting your default editor `zk` i.. │ │ Setting your default pager When `z.. │ │ Styling `zk` supports a `{{style}}.. ╰──────────────────────────────────────╯ 27/27 (0) │ # A future-proof notebook │> A future-proof notebook `zk` is de.. │ │ Automating frequent tasks `zk` was.. │ `zk` is designed to be future-proof │ Call zk from other programs Callin.. │ and rely on simple plain text format │ Command aliases A command alias is.. │ s such as Markdown. │ Configuration file Each [notebook].. │ │ Creating a new note You can add a .. │ The shape of your [notebook](noteboo │ Extra user variables `zk` is opene.. │ k.md) is entirely up to you, making │ Getting started with zk A short in.. │ │ Integration with fzf [`fzf`](https.. │ │ Interesting subject I'm writing ab.. │ │ Maintaining a daily journal Let's .. │ │ March 05, 2021 What did I do today.. │ │ Neuron [Neuron](https://neuron.zet.. │ │ Note ID Each note is uniquely iden.. │ │ Note configuration The `[note]` se.. │ │ Note group A *group* is a named [c.. │ │ Notebook A *notebook* is a directo.. │ │ Notebook housekeeping Tending to y.. │ │ Searching and filtering notes A fe.. │ │ Send notes for processing by other .. │ │ Setting your default editor `zk` i.. │ │ Setting your default pager When `z.. │ │> f ╭──────────────────────────────────────╮ 25/27 (0) │ # A future-proof notebook │ Call zk from other programs Callin.. │ `zk` is designed to be future-proof │ Automating frequent tasks `zk` was.. │ and rely on simple plain text format │ Send notes for processing by other .. │ s such as Markdown. │ Searching and filtering notes A fe.. │ The shape of your [notebook](noteboo │ Integration with fzf [`fzf`](https.. │ k.md) is entirely up to you, making │ Template context when formatting a .. │ │ Extra user variables `zk` is opene.. │ │ Template context when creating note.. │ │ zk – a plain text note-taking assis.. │ │ Styling `zk` supports a `{{style}}.. │ │ Template syntax `zk` uses the [Han.. │ │ Creating a new note You can add a .. │ │ Note ID Each note is uniquely iden.. ╰──────────────────────────────────────╯> fz ╭──────────────────────────────────────╮ 7/27 (0) │ # A future-proof notebook │> Integration with fzf [`fzf`](https.. │ │ Configuration file Each [notebook].. │ `zk` is designed to be future-proof │ Notebook housekeeping Tending to y.. │ and rely on simple plain text format │ Creating a new note You can add a .. │ s such as Markdown. │ Command aliases A command alias is.. │ The shape of your [notebook](noteboo │ Searching and filtering notes A fe.. │ k.md) is entirely up to you, making │ │ │ ╰──────────────────────────────────────╯ 7/27 (0) │ # Integration with `fzf` 1/25 │ Configuration file Each [notebook].. │ [`fzf`](https://github.com/junegunn/ │ Notebook housekeeping Tending to y.. │ fzf) is an awesome and versatile fuz │ Creating a new note You can add a .. │ zy finder powering `zk`'s [interacti │ Getting started with zk A short in.. │ ve filtering mode](note-filtering.md │ Command aliases A command alias is.. │ │ Searching and filtering notes A fe.. │ Besides the standard [`fzf` configur │ │ ation options](https://github.com/ju │ │ negunn/fzf) documented on its websit │ │ e, `zk` offers additional options yo │ │ u can set in the `[tool]` [configura │ │ tion section](config.md). │ │ If you wish to customize more of `fz │ │ f` behavior, [please post a feature │ │ request](https://github.com/mickael- │ │ menu/zk/issues). │ │ ## Preview command │ │ You can customize the command used t │ │ o preview a note with `fzf-preview` │ 7/27 (1) │ # Integration with `fzf` 1/25 │ >Integration with fzf [`fzf`](https.. │ │> Configuration file Each [notebook].. │ [`fzf`](https://github.com/junegunn/ │ 7/27 (1) │ # Configuration file 1/89 │> Configuration file Each [notebook].. │ Each [notebook](notebook.md) contain │ Notebook housekeeping Tending to y.. │ s a configuration file used to custo │ Creating a new note You can add a .. │ mize your experience with `zk`. This │ Getting started with zk A short in.. │ file is located at `.zk/config.toml │ Searching and filtering notes A fe.. │ * `[note]` sets the [note creation r │ │ ules](config-note.md) │ │ * `[extra]` contains free [user vari │ │ ables](config-extra.md) which can be │ │ expanded in templates │ │ * `[group]` defines [note groups](co │ │ nfig-group.md) with custom rules │ │ * `[tool]` customizes interaction wi │ │ th external programs such as: │ │ * [your default editor](tool-edi │ │ tor.md) │ │ * [your default pager](tool-page │ │ r.md) │ │ * [`fzf`](tool-fzf.md) │ │ * `[alias]` holds your [command alia │ │ ses](config-alias.md) │ Configuration file Each [notebook].. │ Each [notebook](notebook.md) contain │> Notebook housekeeping Tending to y.. │ s a configuration file used to custo │ 7/27 (1) │ # Notebook housekeeping 1/26 │ Configuration file Each [notebook].. │ Tending to your notes does not only │> Notebook housekeeping Tending to y.. │ mean writing. You need to keep your │ Getting started with zk A short in.. │ ## Find related notes │ Searching and filtering notes A fe.. │ To surf your notebook with ease, mak │ │ e sure to link all related notes tog │ │ ether. You can list notes which coul │ │ d be good candidates for a new link │ │ with the `--related` [filtering opti │ │ on](note-filtering.md). │ │ ```sh │ │ $ zk list --related note.md │ │ ``` │ │ This returns notes which are not con │ │ nected to the given note, but with a │ │ t least one linked note in common. │ │ ## Find flimsy notes │ 7/27 (2) │ # Notebook housekeeping 1/26 │ >Notebook housekeeping Tending to y.. │ mean writing. You need to keep your │> Creating a new note You can add a .. │ │ 7/27 (2) │ # Creating a new note 1/24 │ Configuration file Each [notebook].. │ You can add a new note to a [noteboo │ >Notebook housekeeping Tending to y.. │ k](notebook.md) using `zk new --titl │> Creating a new note You can add a .. │ e "An interesting concept" [<directo │ Getting started with zk A short in.. │ ry>]`. │ Searching and filtering notes A fe.. │ `zk` automatically generates a filen │ │ ame and initial content according to │ │ rules set in your [configuration fi │ │ le](config.md). These settings can b │ │ e customized per [group of notes](co │ │ nfig-group.md) in your notebook, as │ │ illustrated in [Maintaining a daily │ │ journal](daily-journal.md). │ │ By default, `zk new` will start [you │ │ r editor](tool-editor.md) after crea │ │ ting the note. You can choose instea │ │ d to print the absolute path to the │ │ note with `--print-path`, which is m │ │ ore useful for [automation](automati │ │ on.md). │Integration with fzf tool-fzf.md (2 weeks ago)─────────────────────────────────╮ ‣ [`fzf`](https://github.com/junegunn/fzf) is an awesome and versatile fuzzy finder powering `zk`'s [interactive filtering mode](note-filtering.md).[noteboo │Notebook housekeeping notebook-housekeeping.md (6 days ago) concept" [<directo │ ‣ Tending to your notes does not only mean writing. You need to keep your [notebook](notebook.md) in great shape to make good use of it. For many maintenance tasks, `zk` can help! │ ame and initial content according to │Found 2 notes │ e customized per [group of notes](co │$ + \ No newline at end of file diff --git a/docs/assets/media/list-link.svg b/docs/assets/media/list-link.svg new file mode 100644 index 0000000..59d27e6 --- /dev/null +++ b/docs/assets/media/list-link.svg @@ -0,0 +1,97 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk list --linking-to note-id.md $ zk list --linking-to note-id.md Neuron neuron.md (2 weeks ago) ‣ using the [same settings as Neuron](https://neuron.zettel.page/id.html) to generate the [note IDs](note-id.md) in the [note configuration](config-note.md)Note configuration config-note.md (2 weeks ago) ‣ Characters set used to [generate random IDs](note-id.md). ‣ Just a [random ID](note-id.md), simple and elegant.Searching and filtering notes note-filtering.md (2 weeks ago) ‣ It works fine with only a path prefix as well. This is useful when you have a [note ID](note-id.md) prefix, but not the full file path.Found 3 notes$ zk list --linking-to note-id.md --format oneline $ zk list --linking-to note-id.md --format oneline $ zk list --linking-to note-id.md --format oneline --recursive $ zk list --linking-to note-id.md --format oneline --recursive --max-distance 2 $ zk list --linking-to note-id.md --format oneline --recursive --max-distance 2 Command aliases config-alias.md (2 weeks ago)Configuration file config.md (3 weeks ago)Getting started with zk getting-started.md (2 weeks ago)Integration with fzf tool-fzf.md (2 weeks ago)Note group config-group.md (2 weeks ago)Notebook notebook.md (2 weeks ago)Notebook housekeeping notebook-housekeeping.md (6 days ago)Send notes for processing by other programs external-processing.md (2 weeks ago)Template syntax template.md (3 weeks ago)zk – a plain text note-taking assistant README.md (3 weeks ago)Found 13 notes$ zk list --linking-to note-id.md --format oneline --recursive --max-distance $ zk list --linking-to note-id.md --format oneline --recursive --max-distance 3 A future-proof notebook future-proof.md (6 days ago)Automating frequent tasks automation.md (2 weeks ago)Call zk from other programs external-call.md (2 weeks ago)Creating a new note note-creation.md (2 weeks ago)Extra user variables config-extra.md (2 weeks ago)Maintaining a daily journal daily-journal.md (2 weeks ago)Setting your default editor tool-editor.md (2 weeks ago)Setting your default pager tool-pager.md (2 weeks ago)Styling style.md (3 weeks ago)Template context when creating notes template-creation.md (3 weeks ago)Found 23 notes$ + \ No newline at end of file diff --git a/docs/assets/media/list-sort.svg b/docs/assets/media/list-sort.svg new file mode 100644 index 0000000..40fc428 --- /dev/null +++ b/docs/assets/media/list-sort.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk list -foneline $ zk list -foneline --sort created- March 05, 2021 journal/2021-03-05.md (49 minutes ago)Interesting subject interesting-subject.md (49 minutes ago)A future-proof notebook future-proof.md (6 days ago)Notebook housekeeping notebook-housekeeping.md (6 days ago)Neuron neuron.md (2 weeks ago)Getting started with zk getting-started.md (2 weeks ago)Setting your default pager tool-pager.md (2 weeks ago)Note configuration config-note.md (2 weeks ago)Note ID note-id.md (2 weeks ago)Extra user variables config-extra.md (2 weeks ago)Creating a new note note-creation.md (2 weeks ago)Integration with fzf tool-fzf.md (2 weeks ago)Send notes for processing by other programs external-processing.md (2 weeks ago)Automating frequent tasks automation.md (2 weeks ago)Searching and filtering notes note-filtering.md (2 weeks ago)Call zk from other programs external-call.md (2 weeks ago)Setting your default editor tool-editor.md (2 weeks ago)Maintaining a daily journal daily-journal.md (2 weeks ago)Command aliases config-alias.md (2 weeks ago)Note group config-group.md (2 weeks ago)Notebook notebook.md (2 weeks ago)Template syntax template.md (3 weeks ago)Template context when formatting a note template-format.md (3 weeks ago)Template context when creating notes template-creation.md (3 weeks ago): Found 27 notes$ zk list -foneline --sort random Configuration file config.md (3 weeks ago)zk – a plain text note-taking assistant README.md (3 weeks ago)Styling style.md (3 weeks ago)$ + \ No newline at end of file diff --git a/docs/assets/media/list.svg b/docs/assets/media/list.svg new file mode 100644 index 0000000..66b6180 --- /dev/null +++ b/docs/assets/media/list.svg @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk list journal/ $ zk list journal/ March 05, 2021 journal/2021-03-05.md (46 minutes ago) ‣ What did I do today? *Found 1 note$ zk list -n2 $ zk list -n2 --match "create" $ zk list -n2 --match "create" Template context when creating notes template-creation.md (3 weeks ago) ‣ The following variables are available in the templates used when [creating new notes](note-creation.md) – both for the filename…Creating a new note note-creation.md (2 weeks ago) ‣ …From `fzf`, press `Ctrl-N` to create a new note using the current search query as title. ## Create a note…Found 2 notes$ zk list -n2 --match "create" $ zk list -n2 --match "create OR edit" $ zk list -n2 --match "create OR edit" Getting started with zk getting-started.md (2 weeks ago) ‣ …From `zk`'s interactive edit screen, press `Ctrl-N` to create a new note using the current search query as…Command aliases config-alias.md (2 weeks ago) ‣ …the trailing `$@`. ```toml recent = "zk edit --sort created- --created-after 'last two weeks' --interactive" ``` ### Edit the configuration file Here's a…$ zk list -n2 --match "create OR edit" $ zk list -n2 --match "create OR edit -alias" $ zk list -n2 --match "create OR edit -alias" ‣ …note or creating a new one in a single action. This option is available when running `zk edit --interactive`, which…$ + \ No newline at end of file diff --git a/docs/assets/media/new1.svg b/docs/assets/media/new1.svg new file mode 100644 index 0000000..b11c37b --- /dev/null +++ b/docs/assets/media/new1.svg @@ -0,0 +1,96 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ echo "I'm writing about it" $ echo "I'm writing about it" | zk new $ echo "I'm writing about it" | zk new --title "Interesting subject" 1 # Interesting subject 1 2 I'm writing about it 3 ~ docs/interesting-subject.md cwd: /Users/mickael/dvpts/mickael/zk-test 1 # Interesting subject cwd: /Users/mickael/dvpts/mickael/zk-test Z $ zk new journal/ 1 # March 05, 2021 2 What did I do today? 3 * docs/journal/2021-03-05.md Z $ + \ No newline at end of file diff --git a/docs/assets/media/new2.svg b/docs/assets/media/new2.svg new file mode 100644 index 0000000..e17ae53 --- /dev/null +++ b/docs/assets/media/new2.svg @@ -0,0 +1,102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + $ $ zk edit --interactive $ zk edit --interactive > ╭──────────────────────────────────────╮ 27/27 (0) │ │ Ctrl-N: create a note with the quer.. │ │> A future-proof notebook `zk` is de.. │ │ Automating frequent tasks `zk` was.. │ │ Call zk from other programs Callin.. │ │ Command aliases A command alias is.. │ │ Configuration file Each [notebook].. │ │ Creating a new note You can add a .. │ │ Extra user variables `zk` is opene.. │ │ Getting started with zk A short in.. │ │ Integration with fzf [`fzf`](https.. │ │ Interesting subject I'm writing ab.. │ │ Maintaining a daily journal Let's .. │ │ March 05, 2021 What did I do today.. │ │ Neuron [Neuron](https://neuron.zet.. │ │ Note ID Each note is uniquely iden.. │ │ Note configuration The `[note]` se.. │ │ Note group A *group* is a named [c.. │ │ Notebook A *notebook* is a directo.. │ │ Notebook housekeeping Tending to y.. │ │ Searching and filtering notes A fe.. │ │ Send notes for processing by other .. │ │ Setting your default editor `zk` i.. │ │ Setting your default pager When `z.. ╰──────────────────────────────────────╯ 27/27 (0) │ # A future-proof notebook │ Ctrl-N: create a note with the quer.. │ │> A future-proof notebook `zk` is de.. │ `zk` is designed to be future-proof │ Automating frequent tasks `zk` was.. │ and rely on simple plain text format │ Call zk from other programs Callin.. │ s such as Markdown. │ Command aliases A command alias is.. │ │ Configuration file Each [notebook].. │ The shape of your [notebook](noteboo │ Creating a new note You can add a .. │ k.md) is entirely up to you, making │ Extra user variables `zk` is opene.. │ │ Getting started with zk A short in.. │ │ Integration with fzf [`fzf`](https.. │ │ Interesting subject I'm writing ab.. │ │ Maintaining a daily journal Let's .. │ │ March 05, 2021 What did I do today.. │ │ Neuron [Neuron](https://neuron.zet.. │ │ Note ID Each note is uniquely iden.. │ │ Note configuration The `[note]` se.. │ │ Note group A *group* is a named [c.. │ │ Notebook A *notebook* is a directo.. │ │ Notebook housekeeping Tending to y.. │ │ Searching and filtering notes A fe.. │ │ Send notes for processing by other .. │ │ Setting your default editor `zk` i.. │ │> A ╭──────────────────────────────────────╮ 22/27 (0) │ # A future-proof notebook │ Notebook A *notebook* is a directo.. │ s such as Markdown. │ Command aliases A command alias is.. │ The shape of your [notebook](noteboo │ Getting started with zk A short in.. │ k.md) is entirely up to you, making │ Creating a new note You can add a .. │ │ Template syntax `zk` uses the [Han.. │ │ Template context when formatting a .. │ │ Template context when creating note.. │ │ Configuration file Each [notebook].. │ │ Setting your default pager When `z.. │ │ zk – a plain text note-taking assis.. │ │ Maintaining a daily journal Let's .. ╰──────────────────────────────────────╯> A ╭──────────────────────────────────────╮> A ne ╭──────────────────────────────────────╮ 21/27 (0) │ # A future-proof notebook │> Notebook A *notebook* is a directo.. │ `zk` is designed to be future-proof │ Creating a new note You can add a .. │ and rely on simple plain text format │ Note group A *group* is a named [c.. │ s such as Markdown. │ Getting started with zk A short in.. │ The shape of your [notebook](noteboo │ Searching and filtering notes A fe.. │ k.md) is entirely up to you, making │ A future-proof notebook `zk` is de.. │ │ Automating frequent tasks `zk` was.. │ │ ╰──────────────────────────────────────╯> A new ╭──────────────────────────────────────╮ 12/27 (0) │ # Notebook │> Notebook A *notebook* is a directo.. │ A *notebook* is a directory containi │ Creating a new note You can add a .. │ ng a collection of notes managed by │ Command aliases A command alias is.. │ To create a new notebook, simply run │ Getting started with zk A short in.. │ `zk init [<directory>]`. │ Template context when creating note.. │ Most `zk` commands are operating "Gi │ Template syntax `zk` uses the [Han.. │ t-style" on the notebook containing │ Notebook housekeeping Tending to y.. │ the current working directory (or on │ Note configuration The `[note]` se.. │ e of its parents). │ Maintaining a daily journal Let's .. │ ## Anatomy of a notebook │ │ │ │ Similarly to Git, a notebook is iden │ │ tified by the presence of a `.zk` di │ │ rectory at its root. This directory │ │ contains the only `zk`-specific file │ │ s in your notebook: │ │ * `.zk/config.toml` is the user [con │ │ figuration file](config.md) │> A new ╭──────────────────────────────────────╮> A new n ╭──────────────────────────────────────╮> Note configuration The `[note]` se.. │ A *notebook* is a directory containi │ Note group A *group* is a named [c.. │ ng a collection of notes managed by │ Notebook housekeeping Tending to y.. │ To create a new notebook, simply run │ Creating a new note You can add a .. │ `zk init [<directory>]`. │ Getting started with zk A short in.. │ Most `zk` commands are operating "Gi │ Configuration file Each [notebook].. │ t-style" on the notebook containing │ Template context when creating note.. │ the current working directory (or on │ Extra user variables `zk` is opene.. │ e of its parents). │> A new no ╭──────────────────────────────────────╮ 12/27 (0) │ # Note configuration 1/55 │> Note configuration The `[note]` se.. │ The `[note]` section from the [confi │ Note group A *group* is a named [c.. │ guration file](config.md) is used to │ Notebook A *notebook* is a directo.. │ set the [note creation rules](note- │ Notebook housekeeping Tending to y.. │ creation.md). The following properti │ Creating a new note You can add a .. │ es are customizable: │ Getting started with zk A short in.. │ * `language` (string) │ Configuration file Each [notebook].. │ * Two-letters code of the langua │ Template context when creating note.. │ ge used when writing notes, e.g. `en │ Extra user variables `zk` is opene.. │ * This is used to generate slugs │ Template syntax `zk` uses the [Han.. │ or with date formats. For now, only │ Maintaining a daily journal Let's .. │ English is fully supported. │ │ * `default-title` (string) │ │ * The default title used for new │ │ notes when no `--title` option is p │ │ rovided. │ │ * `filename` (string) │ │ * [Template](template.md) used t │ │ o generate the note filename, withou │ │ t its file extension. │ │ * `extension` (string) │> A new not ╭──────────────────────────────────────╮> A new note ╭──────────────────────────────────────╮> A new note ╭──────────────────────────────────────╮ 1 # A new note 1 2 ~ docs/a-new-note.md Z + \ No newline at end of file diff --git a/docs/assets/media/screencast.svg b/docs/assets/media/screencast.svg index b721192..c539892 100644 --- a/docs/assets/media/screencast.svg +++ b/docs/assets/media/screencast.svg @@ -1 +1,149 @@ -$$echo$echo"I'm$echo"I'mwriting$echo"I'mwritingabout$echo"I'mwritingaboutit"$echo"I'mwritingaboutit"|$echo"I'mwritingaboutit"|zk$echo"I'mwritingaboutit"|zknew$echo"I'mwritingaboutit"|zknew--title$echo"I'mwritingaboutit"|zknew--title"Interesting$echo"I'mwritingaboutit"|zknew--title"Interestingsubject"1#Interestingsubject12I'mwritingaboutit3~docs/interesting-subject.mdcwd:/Users/mickael/dvpts/mickael/zkZZ$z$zk$zkl$zkli$zklis$zklist$zklist-$zklist--$zklist--match$zklist--match"write$zklist--match"writesubject"Interestingsubjectinteresting-subject.md(justnow)‣I'mwritingaboutitGettingstartedwithzkgetting-started.md(5daysago)‣…Pickasubject,[createanewnote](note-creation.md)andwriteon!```sh$zknew--title"Aninterestingconcept…Found2notes$zklist--match"writesubject"$zklist--match"writesubject-"$zklist--match"writesubject-s"$zklist--match"writesubject-st"$zklist--match"writesubject-sta"$zklist--match"writesubject-star"$zklist--match"writesubject-start"Found1note$zklist--match"writeORsubject"$zklist--match"writeORsubject"--limit$zklist--match"writeORsubject"--limit5Extrauservariablesconfig-extra.md(5daysago)‣…note-creation.md),forexample:*expandingcustommetadata(author,subject,etc.)*modifyinga[template](template.md)'soutputdynamicallydepending…Creatinganewnotenote-creation.md(6daysago)‣…surewhetheranotealreadyexistsforaparticularsubject,the"searchorcreate"modemightbemoreappropriatethan…Maintainingadailyjournaldaily-journal.md(1weekago)‣Let'sassumeyouwanttowritedailynotesnamedlike`2021-02-16.md`ina`journal/daily`sub-directory.This…Found5notes$zknew$zknewjournal1#February28,20212WhatdidIdotoday?3*docs/journal/2021-02-28.mdG3#February28,202121WhatdidIdotoday?4*--INSERT--4*Recording4*Recordinga4*Recordingascreencastfor4*RecordingascreencastforzkZZZ$zklistjournalFebruary28,2021journal/2021-02-28.md(justnow)‣WhatdidIdotoday?*Recordingascreencastforzk$zke$zked$zkedi$zkedit$zkedit-$zkedit--interactive$zkedit--interactive--exclude$zkedit--interactive--excludejournal╭──────────────────────────────────────╮│││╰──────────────────────────────────────╯>╭──────────────────────────────────────╮Ctrl-N:createanotewiththequer..││26/26(0)││>A future-proof notebook`zk` is de..││Automatingfrequenttasks`zk`was..││CallzkfromotherprogramsCallin..││CommandaliasesAcommandaliasis..││ConfigurationfileEach[notebook]..││CreatinganewnoteYoucanadda..││Extrauservariables`zk`isopene..││GettingstartedwithzkAshortin..││Integrationwithfzf[`fzf`](https..││InterestingsubjectI'mwritingab..││MaintainingadailyjournalLet's..││Neuron[Neuron](https://neuron.zet..││NoteIDEachnoteisuniquelyiden..││NoteconfigurationThe`[note]`se..││NotegroupA*group*isanamed[c..││NotebookA*notebook*isadirecto..││NotebookhousekeepingTendingtoy..││SearchingandfilteringnotesAfe..││Sendnotesforprocessingbyother..││Settingyourdefaulteditor`zk`i..││SettingyourdefaultpagerWhen`z..││Styling`zk`supportsa`{{style}}..╰──────────────────────────────────────╯26/26(0)│#Afuture-proofnotebook│>A future-proof notebook`zk` is de..│`zk`isdesignedtobefuture-proof│Automatingfrequenttasks`zk`was..│andrelyonsimpleplaintextformat│CallzkfromotherprogramsCallin..│ssuchasMarkdown.│ConfigurationfileEach[notebook]..│Theshapeofyour[notebook](noteboo│CreatinganewnoteYoucanadda..│k.md)isentirelyuptoyou,making│>f╭──────────────────────────────────────╮25/26(0)│#Afuture-proofnotebook│CallzkfromotherprogramsCallin..│andrelyonsimpleplaintextformat│Automatingfrequenttasks`zk`was..│ssuchasMarkdown.│SearchingandfilteringnotesAfe..│k.md)isentirelyuptoyou,making│Templatecontextwhenformattinga..││Templatecontextwhencreatingnote..││zk–aplaintextnote-takingassis..││Styling`zk`supportsa`{{style}}..││Templatesyntax`zk`usesthe[Han..││CreatinganewnoteYoucanadda..╰──────────────────────────────────────╯>fz╭──────────────────────────────────────╮>Integration with fzf[`fzf`](https..│`zk`isdesignedtobefuture-proof│ConfigurationfileEach[notebook]..│andrelyonsimpleplaintextformat│NotebookhousekeepingTendingtoy..│ssuchasMarkdown.│CommandaliasesAcommandaliasis..│Theshapeofyour[notebook](noteboo│6/26(0)│#Integrationwith`fzf`│>Integration with fzf[`fzf`](https..│[`fzf`](https://github.com/junegunn/│ConfigurationfileEach[notebook]..│fzf)isanawesomeandversatilefuz│NotebookhousekeepingTendingtoy..│zyfinderpowering`zk`'s[interacti│CreatinganewnoteYoucanadda..│vefilteringmode](note-filtering.md│SearchingandfilteringnotesAfe..│Besidesthestandard[`fzf`configur││ationoptions](https://github.com/ju││negunn/fzf)documentedonitswebsit││e,`zk`offersadditionaloptionsyo││ucansetinthe`[tool]`[configura││tionsection](config.md).││Ifyouwishtocustomizemoreof`fz││f`behavior,[pleasepostafeature││request](https://github.com/mickael-││menu/zk/issues).││##Previewcommand│6/26(0)│#Integrationwith`fzf`1/25││Youcancustomizethecommandusedt││opreviewanotewith`fzf-preview`│>fzf╭──────────────────────────────────────╮1#Integrationwithfzf2`fzf`isanawesomeandversatilefuzzyfinderpoweringzk'sinteractivefilteringmode.4Besidesthestandard`fzf`configurationoptionsdocumentedonitswebsite,zkoffersadditionaloptionsyoucansetinthe[tool]configurationsection.56Ifyouwishtocustomizemoreoffzfbehavior,pleasepostafeaturerequest.78##Previewcommand910Youcancustomizethecommandusedtopreviewanotewithfzf-preview.Thespecialplaceholder{-1}willbeexpandedtothenotefilepath.1112Bydefault,zkusescatforpreview,whichisabitboring.Amuchbetteroptionwouldbetouse`bat`whichsupportssyntaxhighlighting.1314```tomldocs/tool-fzf.md$zkedit-i$zkedit-i--created-after$zkedit-i--created-after"2$zkedit-i--created-after"2days$zkedit-i--created-after"2daysago"4/4(0)││February28,2021WhatdidIdoto..││4/4(0)│#Afuture-proofnotebook│February28,2021WhatdidIdoto..│andrelyonsimpleplaintextformat│InterestingsubjectI'mwritingab..│ssuchasMarkdown.││Theshapeofyour[notebook](noteboo││k.md)isentirelyuptoyou,making│4/4(0)│#February28,2021│Afuture-proofnotebook`zk`isde..│WhatdidIdotoday?│>February 28, 2021What did I do to..│*Recordingascreencastforzk│>Interesting subjectI'm writing ab..││4/4(0)│#Interestingsubject│Afuture-proofnotebook`zk`isde..│I'mwritingaboutit│>C╭──────────────────────────────────────╮0/4(0)││>Ca╭──────────────────────────────────────╮>Can╭──────────────────────────────────────╮>Can'╭──────────────────────────────────────╮>Can't╭──────────────────────────────────────╮>Can'tf╭──────────────────────────────────────╮>Can'tfi╭──────────────────────────────────────╮>Can'tfin╭──────────────────────────────────────╮>Can'tfind╭──────────────────────────────────────╮>Can'tfindw╭──────────────────────────────────────╮>Can'tfindwh╭──────────────────────────────────────╮>Can'tfindwha╭──────────────────────────────────────╮>Can'tfindwhat╭──────────────────────────────────────╮>Can'tfindwhatI╭──────────────────────────────────────╮>Can'tfindwhatIn╭──────────────────────────────────────╮>Can'tfindwhatIne╭──────────────────────────────────────╮>Can'tfindwhatInee╭──────────────────────────────────────╮>Can'tfindwhatIneed╭──────────────────────────────────────╮>Can'tfindwhatIneed:╭──────────────────────────────────────╮>Can'tfindwhatIneed:t╭──────────────────────────────────────╮>Can'tfindwhatIneed:ti╭──────────────────────────────────────╮>Can'tfindwhatIneed:tim╭──────────────────────────────────────╮>Can'tfindwhatIneed:time╭──────────────────────────────────────╮>Can'tfindwhatIneed:timet╭──────────────────────────────────────╮>Can'tfindwhatIneed:timeto╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetoh╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetohi╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetohit╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetohitC╭──────────────────────────────────────╮>an'tfindwhatIneed:timetohitCt╭──────────────────────────────────────╮>n'tfindwhatIneed:timetohitCtr╭──────────────────────────────────────╮>'tfindwhatIneed:timetohitCtrl╭──────────────────────────────────────╮>tfindwhatIneed:timetohitCtrl-╭──────────────────────────────────────╮>findwhatIneed:timetohitCtrl-N╭──────────────────────────────────────╮>findwhatIneed:timetohitCtrl-N!╭──────────────────────────────────────╮1#Can'tfindwhatIneed:timetohitCtrl-N!docs/cant-find-what-i-need-time-to-hit-ctrl-n.md$zklist--linking-to$zklist--linking-tonote-id.mdNeuronneuron.md(4daysago)‣usingthe[samesettingsasNeuron](https://neuron.zettel.page/id.html)togeneratethe[noteIDs](note-id.md)inthe[noteconfiguration](config-note.md)Noteconfigurationconfig-note.md(5daysago)‣Characterssetusedto[generaterandomIDs](note-id.md).‣Justa[randomID](note-id.md),simpleandelegant.Searchingandfilteringnotesnote-filtering.md(1weekago)‣Itworksfinewithonlyapathprefixaswell.Thisisusefulwhenyouhavea[noteID](note-id.md)prefix,butnotthefullfilepath.Found3notes$zklist--linking-tonote-id.md--format$zklist--linking-tonote-id.md--formatoneline$zklist--linking-tonote-id.md--formatoneline--recursive$zklist--linking-tonote-id.md--formatoneline--recursive--max-distance$zklist--linking-tonote-id.md--formatoneline--recursive--max-distance2Commandaliasesconfig-alias.md(1weekago)Configurationfileconfig.md(2weeksago)Integrationwithfzftool-fzf.md(6daysago)Notegroupconfig-group.md(1weekago)Notebooknotebook.md(1weekago)Notebookhousekeepingnotebook-housekeeping.md(yesterday)Sendnotesforprocessingbyotherprogramsexternal-processing.md(1weekago)Templatesyntaxtemplate.md(2weeksago)zk–aplaintextnote-takingassistantREADME.md(2weeksago)Found13notes$zklist--linking-tonote-id.md--formatoneline--recursive--max-distance3Afuture-proofnotebookfuture-proof.md(yesterday)Automatingfrequenttasksautomation.md(1weekago)Callzkfromotherprogramsexternal-call.md(1weekago)Settingyourdefaulteditortool-editor.md(1weekago)Settingyourdefaultpagertool-pager.md(5daysago)Stylingstyle.md(2weeksago)Templatecontextwhencreatingnotestemplate-creation.md(2weeksago)Found23notes$zklist--format$zklist--format"{{word-count}}\t{{title}}"$zklist--format"{{word-count}}\t{{title}}"--sort$zklist--format"{{word-count}}\t{{title}}"--sortword-count$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limit$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limit107Interestingsubject10Can'tfindwhatIneed:timetohitCtrl-N!15February28,202154Afuture-proofnotebook69Settingyourdefaulteditor88Automatingfrequenttasks93Settingyourdefaultpager101Callzkfromotherprograms106zk–aplaintextnote-takingassistant117NotebookFound10notes$vim$vim.zk/config.toml1[note]1filename="{{slugtitle}}"2template="default.md"4[group.journal.note]5filename="{{datenow}}"6template="journal.md"8[tool]9editor="nvim"10fzf-preview="bat-p--themeNord--coloralways{-1}"12[alias]docs/.zk/config.toml12[note]11filename="{{slugtitle}}"10template="default.md"8[group.journal.note]7filename="{{datenow}}"4[tool]3editor="nvim"2fzf-preview="bat-p--themeNord--coloralways{-1}"13[alias]13[note]12filename="{{slugtitle}}"11template="default.md"109[group.journal.note]8filename="{{datenow}}"7template="journal.md"65[tool]4editor="nvim"3fzf-preview="bat-p--themeNord--coloralways{-1}"1[alias]14wc14wc=14wc="zk14wc="zklist14wc="zklist--quiet14wc="zklist--quiet--f~0fzf [A]~0filename [A]14wc="zklist--quiet--fo14wc="zklist--quiet--format14wc="zklist--quiet--format'{{word-c~0color [A]14wc="zklist--quiet--format'{{word-co14wc="zklist--quiet--format'{{word-cou14wc="zklist--quiet--format'{{word-count}}\t~0theme [A]~0tool [A]~0template [A]~0title [A]14wc="zklist--quiet--format'{{word-count}}\t{14wc="zklist--quiet--format'{{word-count}}\t{{t~0theme [A]~0tool [A]~0template [A]~0title [A]14wc="zklist--quiet--format'{{word-count}}\t{{ti~0title [A]14wc="zklist--quiet--format'{{word-count}}\t{{tit14wc="zklist--quiet--format'{{word-count}}\t{{titl14wc="zklist--quiet--format'{{word-count}}\t{{title14wc="zklist--quiet--format'{{word-count}}\t{{title}}'14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--s~0slug [A]14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--so14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sort14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortw~0word [A]14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortwo14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortwor14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-c~0count~0color14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-co14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-coucoun~0count [A]countcount--l~0list [A]count--licount--limcount--limitcount--limit1014wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-count--limit10$@"$zkw$zkwc$zkwc--exclude$zkwc--excludejournal$zkwc--excludejournal--limit$zkwc--excludejournal--limit5$e$ec$ech$echo"$echo"I$echo"I'$echo"I'mw$echo"I'mwr$echo"I'mwri$echo"I'mwrit$echo"I'mwriti$echo"I'mwritin$echo"I'mwritinga$echo"I'mwritingab$echo"I'mwritingabo$echo"I'mwritingabou$echo"I'mwritingabouti$echo"I'mwritingaboutit$echo"I'mwritingaboutit"|z$echo"I'mwritingaboutit"|zkn$echo"I'mwritingaboutit"|zkne$echo"I'mwritingaboutit"|zknew-$echo"I'mwritingaboutit"|zknew--$echo"I'mwritingaboutit"|zknew--t$echo"I'mwritingaboutit"|zknew--ti$echo"I'mwritingaboutit"|zknew--tit$echo"I'mwritingaboutit"|zknew--titl$echo"I'mwritingaboutit"|zknew--title"$echo"I'mwritingaboutit"|zknew--title"I$echo"I'mwritingaboutit"|zknew--title"In$echo"I'mwritingaboutit"|zknew--title"Int$echo"I'mwritingaboutit"|zknew--title"Inte$echo"I'mwritingaboutit"|zknew--title"Inter$echo"I'mwritingaboutit"|zknew--title"Intere$echo"I'mwritingaboutit"|zknew--title"Interes$echo"I'mwritingaboutit"|zknew--title"Interest$echo"I'mwritingaboutit"|zknew--title"Interesti$echo"I'mwritingaboutit"|zknew--title"Interestin$echo"I'mwritingaboutit"|zknew--title"Interestings$echo"I'mwritingaboutit"|zknew--title"Interestingsu$echo"I'mwritingaboutit"|zknew--title"Interestingsub$echo"I'mwritingaboutit"|zknew--title"Interestingsubj$echo"I'mwritingaboutit"|zknew--title"Interestingsubje$echo"I'mwritingaboutit"|zknew--title"Interestingsubjec$echo"I'mwritingaboutit"|zknew--title"Interestingsubjectcwd:/Users/mickael/dvpts/mickael/zkcwd:/Users/mickael/dvpts/mickael/zkZ$zklist--m$zklist--ma$zklist--mat$zklist--matc$zklist--match"$zklist--match"w$zklist--match"wr$zklist--match"wri$zklist--match"writ$zklist--match"writes$zklist--match"writesu$zklist--match"writesub$zklist--match"writesubj$zklist--match"writesubje$zklist--match"writesubjec$zklist--match"writesubject$zklist--match"writeOsubject"$zklist--match"writeORsubject"$zklist--match"writeORsubject"-$zklist--match"writeORsubject"--$zklist--match"writeORsubject"--l$zklist--match"writeORsubject"--li$zklist--match"writeORsubject"--lim$zklist--match"writeORsubject"--limi:(END)$zkn$zkne$zknewj$zknewjo$zknewjournal/A4*R4*Re4*Rec4*Reco4*Recor4*Record4*Recordi4*Recordin4*Recordingas4*Recordingasc4*Recordingascr4*Recordingascre4*Recordingascree4*Recordingascreen4*Recordingascreenc4*Recordingascreenca4*Recordingascreencas4*Recordingascreencast4*Recordingascreencast4*Recordingascreencastf4*Recordingascreencastfo4*Recordingascreencastforz"docs/journal/2021-02-28.md""docs/journal/2021-02-28.md"4L,74Cwritten$zklistj$zklistjo$zklistjournal/$zkedit--$zkedit--i$zkedit--in$zkedit--int$zkedit--inte$zkedit--inter$zkedit--intera$zkedit--interac$zkedit--interact$zkedit--interacti$zkedit--interactiv$zkedit--interactive-$zkedit--interactive--$zkedit--interactive--e$zkedit--interactive--ex$zkedit--interactive--exc$zkedit--interactive--excl$zkedit--interactive--exclu$zkedit--interactive--exclud$zkedit--interactive--excludej$zkedit--interactive--excludejo$zkedit--interactive--excludejou$zkedit--interactive--excludejour$zkedit--interactive--excludejourn$zkedit--interactive--excludejournal/0/26(0)││Gettingstartedwith││SearchingandfnoteYoucanadda..│k.md)isentirelyuptoyou,making│Templatesyntaxgroup*isanamed[c..││rmattinga..││6/26(0)│#Afuture-proofnotebook│NotebookhousekeepingTendingtoy..│zyfinderpowering`zk││negunn/fzf)││Ify│8##$zkedit-i-$zkedit-i--$zkedit-i--c$zkedit-i--cr$zkedit-i--cre$zkedit-i--crea$zkedit-i--creat$zkedit-i--create$zkedit-i--created$zkedit-i--created-$zkedit-i--created-a$zkedit-i--created-af$zkedit-i--created-aft$zkedit-i--created-afte$zkedit-i--created-after"$zkedit-i--created-after"2d$zkedit-i--created-after"2da$zkedit-i--created-after"2day$zkedit-i--created-after"2daysa$zkedit-i--created-after"2daysag$zkedit-i--created-after"2daysagoâ §0/0(0)││Afuture-proofnotebook`zk`isde..│`zk`isdesignedtobefuture-proof│>February 28, 2021What did I do to..│andrelyonsimpleplaintextformat│February28,2021WhatdidIdoto..│*Recordingascreencastforzk│0/4(0)│#Interestingsubject││I'mwritingaboutit│$zklist--l$zklist--li$zklist--lin$zklist--link$zklist--linki$zklist--linkin$zklist--linking$zklist--linking-$zklist--linking-t$zklist--linking-ton$zklist--linking-tono$zklist--linking-tonot$zklist--linking-tonote$zklist--linking-tonote-$zklist--linking-tonote-i$zklist--linking-tonote-id.md-$zklist--linking-tonote-id.md--$zklist--linking-tonote-id.md--f$zklist--linking-tonote-id.md--fo$zklist--linking-tonote-id.md--for$zklist--linking-tonote-id.md--form$zklist--linking-tonote-id.md--forma$zklist--linking-tonote-id.md--formato$zklist--linking-tonote-id.md--formaton$zklist--linking-tonote-id.md--formatone$zklist--linking-tonote-id.md--formatonel$zklist--linking-tonote-id.md--formatoneli$zklist--linking-tonote-id.md--formatonelin$zklist--linking-tonote-id.md--formatoneline-$zklist--linking-tonote-id.md--formatoneline--$zklist--linking-tonote-id.md--formatoneline--r$zklist--linking-tonote-id.md--formatoneline--re$zklist--linking-tonote-id.md--formatoneline--rec$zklist--linking-tonote-id.md--formatoneline--recu$zklist--linking-tonote-id.md--formatoneline--recur$zklist--linking-tonote-id.md--formatoneline--recurs$zklist--linking-tonote-id.md--formatoneline--recursi$zklist--linking-tonote-id.md--formatoneline--recursiv$zklist--linking-tonote-id.md--formatoneline--recursive-$zklist--linking-tonote-id.md--formatoneline--recursive--$zklist--linking-tonote-id.md--formatoneline--recursive--m$zklist--linking-tonote-id.md--formatoneline--recursive--ma$zklist--linking-tonote-id.md--formatoneline--recursive--max$zklist--linking-tonote-id.md--formatoneline--recursive--max-$zklist--linking-tonote-id.md--formatoneline--recursive--max-d$zklist--linking-tonote-id.md--formatoneline--recursive--max-di$zklist--linking-tonote-id.md--formatoneline--recursive--max-dis$zklist--linking-tonote-id.md--formatoneline--recursive--max-dist$zklist--linking-tonote-id.md--formatoneline--recursive--max-dista$zklist--linking-tonote-id.md--formatoneline--recursive--max-distan$zklist--linking-tonote-id.md--formatoneline--recursive--max-distancExtrauservariableExtrauservariables$zklist--f$zklist--fo$zklist--for$zklist--form$zklist--forma$zklist--format"$zklist--format"{$zklist--format"{{$zklist--format"{{w$zklist--format"{{wo$zklist--format"{{wor$zklist--format"{{word$zklist--format"{{word-$zklist--format"{{word-c$zklist--format"{{word-co$zklist--format"{{word-cou$zklist--format"{{word-coun$zklist--format"{{word-count$zklist--format"{{word-count}$zklist--format"{{word-count}}$zklist--format"{{word-count}}\$zklist--format"{{word-count}}\t$zklist--format"{{word-count}}\t{$zklist--format"{{word-count}}\t{{$zklist--format"{{word-count}}\t{{t$zklist--format"{{word-count}}\t{{ti$zklist--format"{{word-count}}\t{{tit$zklist--format"{{word-count}}\t{{titl$zklist--format"{{word-count}}\t{{title$zklist--format"{{word-count}}\t{{title}$zklist--format"{{word-count}}\t{{title}}$zklist--format"{{word-count}}\t{{title}}"-$zklist--format"{{word-count}}\t{{title}}"--$zklist--format"{{word-count}}\t{{title}}"--s$zklist--format"{{word-count}}\t{{title}}"--so$zklist--format"{{word-count}}\t{{title}}"--sor$zklist--format"{{word-count}}\t{{title}}"--sortw$zklist--format"{{word-count}}\t{{title}}"--sortwo$zklist--format"{{word-count}}\t{{title}}"--sortwor$zklist--format"{{word-count}}\t{{title}}"--sortword$zklist--format"{{word-count}}\t{{title}}"--sortword-$zklist--format"{{word-count}}\t{{title}}"--sortword-c$zklist--format"{{word-count}}\t{{title}}"--sortword-co$zklist--format"{{word-count}}\t{{title}}"--sortword-cou$zklist--format"{{word-count}}\t{{title}}"--sortword-coun$zklist--format"{{word-count}}\t{{title}}"--sortword-count-$zklist--format"{{word-count}}\t{{title}}"--sortword-count--$zklist--format"{{word-count}}\t{{title}}"--sortword-count--l$zklist--format"{{word-count}}\t{{title}}"--sortword-count--li$zklist--format"{{word-count}}\t{{title}}"--sortword-count--lim$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limi$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limit1$v$vi$vim.$vim.z$vim.zk$vim.zk/$vim.zk/c$vim.zk/co$vim.zk/con$vim.zk/conf$vim.zk/confio1414w14wc="14wc="z14wc="zkl14wc="zkli14wc="zklis14wc="zklist-14wc="zklist--14wc="zklist--q14wc="zklist--qu14wc="zklist--qui14wc="zklist--quie14wc="zklist--quiet-14wc="zklist--quiet--14wc="zklist--quiet--for14wc="zklist--quiet--form14wc="zklist--quiet--forma14wc="zklist--quiet--format"14wc="zklist--quiet--format'14wc="zklist--quiet--format'{14wc="zklist--quiet--format'{{14wc="zklist--quiet--format'{{w14wc="zklist--quiet--format'{{wo14wc="zklist--quiet--format'{{wor14wc="zklist--quiet--format'{{word14wc="zklist--quiet--format'{{word-14wc="zklist--quiet--format'{{word-coun14wc="zklist--quiet--format'{{word-count14wc="zklist--quiet--format'{{word-count}14wc="zklist--quiet--format'{{word-count}}14wc="zklist--quiet--format'{{word-count}}\14wc="zklist--quiet--format'{{word-count}}\t{{14wc="zklist--quiet--format'{{word-count}}\t{{title}14wc="zklist--quiet--format'{{word-count}}\t{{title}14wc="zklist--quiet--format'{{word-count}}\t{{title}}14wc="zklist--quiet--format'{{word-count}}\t{{title}}'-14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sorcount-count--count--limicount--limit1count--limit10%count--limit10$count--limit10$@"docs/.zk/config.toml""docs/.zk/config.toml"14L,312Cwritten$zkwc-$zkwc--$zkwc--e$zkwc--ex$zkwc--exc$zkwc--excl$zkwc--exclu$zkwc--exclud$zkwc--excludej$zkwc--excludejo$zkwc--excludejou$zkwc--excludejour$zkwc--excludejourn$zkwc--excludejourna$zkwc--excludejournal-$zkwc--excludejournal--$zkwc--excludejournal--l$zkwc--excludejournal--li$zkwc--excludejournal--lim$zkwc--excludejournal--limi + + + + + + + + + + + + + + + + + + + + + + + + + $ $ echo "I'm writing about it" | zk new --title "Interesting subject" 1 # Interesting subject 1 2 I'm writing about it 3 ~ docs/interesting-subject.md cwd: /Users/mickael/dvpts/mickael/zk 1 # Interesting subject cwd: /Users/mickael/dvpts/mickael/zk Z $ zk list --match "write subject" $ zk list --match "write subject" Interesting subject interesting-subject.md (just now) ‣ I'm writing about itGetting started with zk getting-started.md (2 weeks ago) ‣ …Pick a subject, [create a new note](note-creation.md) and write on! ```sh $ zk new --title "An interesting concept…Found 2 notes$ zk list --match "write OR subject" --limit 5 Extra user variables config-extra.md (2 weeks ago) ‣ …note-creation.md), for example: * expanding custom metadata (author, subject, etc.) * modifying a [template](template.md)'s output dynamically depending…Creating a new note note-creation.md (2 weeks ago) ‣ …sure whether a note already exists for a particular subject, the "search or create" mode might be more appropriate than…Maintaining a daily journal daily-journal.md (2 weeks ago): Found 5 notes$ zk new journal 1 # March 04, 2021 2 What did I do today? 3 * docs/journal/2021-03-04.md Z $ zk edit --interactive --exclude journal > ╭──────────────────────────────────────╮ 26/26 (0) │ │ Ctrl-N: create a note with the quer.. │ │> A future-proof notebook `zk` is de.. │ │ Automating frequent tasks `zk` was.. │ │ Call zk from other programs Callin.. │ │ Command aliases A command alias is.. │ │ Configuration file Each [notebook].. │ │ Creating a new note You can add a .. │ │ Extra user variables `zk` is opene.. │ │ Getting started with zk A short in.. │ │ Integration with fzf [`fzf`](https.. │ │ Interesting subject I'm writing ab.. │ │ Maintaining a daily journal Let's .. │ │ Neuron [Neuron](https://neuron.zet.. │ │ Note ID Each note is uniquely iden.. │ │ Note configuration The `[note]` se.. │ │ Note group A *group* is a named [c.. │ │ Notebook A *notebook* is a directo.. │ │ Notebook housekeeping Tending to y.. │ │ Searching and filtering notes A fe.. │ │ Send notes for processing by other .. │ │ Setting your default editor `zk` i.. │ │ Setting your default pager When `z.. │ │ Styling `zk` supports a `{{style}}.. ╰──────────────────────────────────────╯ 26/26 (0) │ # A future-proof notebook │ Ctrl-N: create a note with the quer.. │ │> A future-proof notebook `zk` is de.. │ `zk` is designed to be future-proof │ Automating frequent tasks `zk` was.. │ and rely on simple plain text format │ Call zk from other programs Callin.. │ s such as Markdown. │ Command aliases A command alias is.. │ │ Configuration file Each [notebook].. │ The shape of your [notebook](noteboo │ Creating a new note You can add a .. │ k.md) is entirely up to you, making │ Extra user variables `zk` is opene.. │ │ Getting started with zk A short in.. │ │ Integration with fzf [`fzf`](https.. │ │ Interesting subject I'm writing ab.. │ │ Maintaining a daily journal Let's .. │ │ Neuron [Neuron](https://neuron.zet.. │ │ Note ID Each note is uniquely iden.. │ │ Note configuration The `[note]` se.. │ │ Note group A *group* is a named [c.. │ │ Notebook A *notebook* is a directo.. │ │ Notebook housekeeping Tending to y.. │ │ Searching and filtering notes A fe.. │ │ Send notes for processing by other .. │ │ Setting your default editor `zk` i.. │ │ Setting your default pager When `z.. │ │> f ╭──────────────────────────────────────╮ 25/26 (0) │ # A future-proof notebook │ Call zk from other programs Callin.. │ and rely on simple plain text format │ Automating frequent tasks `zk` was.. │ s such as Markdown. │ Searching and filtering notes A fe.. │ k.md) is entirely up to you, making │ Template context when formatting a .. │ │ Template context when creating note.. │ │ zk – a plain text note-taking assis.. │ │ Styling `zk` supports a `{{style}}.. │ │ Template syntax `zk` uses the [Han.. │ │ Creating a new note You can add a .. ╰──────────────────────────────────────╯> fz ╭──────────────────────────────────────╮ 6/26 (0) │ # A future-proof notebook │> Integration with fzf [`fzf`](https.. │ `zk` is designed to be future-proof │ Configuration file Each [notebook].. │ and rely on simple plain text format │ Notebook housekeeping Tending to y.. │ s such as Markdown. │ Creating a new note You can add a .. │ │ Command aliases A command alias is.. │ The shape of your [notebook](noteboo │ │ │ ╰──────────────────────────────────────╯ 6/26 (0) │ # Integration with `fzf` 1/25 │> Integration with fzf [`fzf`](https.. │ [`fzf`](https://github.com/junegunn/ │ Configuration file Each [notebook].. │ fzf) is an awesome and versatile fuz │ Notebook housekeeping Tending to y.. │ zy finder powering `zk`'s [interacti │ Creating a new note You can add a .. │ ve filtering mode](note-filtering.md │ Searching and filtering notes A fe.. │ Besides the standard [`fzf` configur │ │ ation options](https://github.com/ju │ │ negunn/fzf) documented on its websit │ │ e, `zk` offers additional options yo │ │ u can set in the `[tool]` [configura │ │ tion section](config.md). │ │ If you wish to customize more of `fz │ │ f` behavior, [please post a feature │ │ request](https://github.com/mickael- │ │ menu/zk/issues). │ │ ## Preview command │ │ You can customize the command used t │ │ o preview a note with `fzf-preview` │ 1 # Integration with fzf 2 `fzf` is an awesome and versatile fuzzy finder powering zk's interactive filtering mode . 4 Besides the standard `fzf` configuration options documented on its website, zk offers additional options you can set in the [tool] configuration section. 5 6 If you wish to customize more of fzf behavior, please post a feature request. 7 8 ## Preview command 9 10 You can customize the command used to preview a note with fzf-preview. The special placeholder {-1} will be expanded to the note file path. 11 12 By default, zk uses cat for preview, which is a bit boring. A much better option would be to use `bat` which supports syntax highlighting. 13 14 ```toml docs/tool-fzf.md $ zk edit --interactive --created-after "one week ago" 4/4 (0) │ │ March 04, 2021 What did I do today.. │ │ │ │ 4/4 (0) │ # A future-proof notebook │ Interesting subject I'm writing ab.. │ and rely on simple plain text format │ March 04, 2021 What did I do today.. │ s such as Markdown. │ │ The shape of your [notebook](noteboo │ │ k.md) is entirely up to you, making │> N ╭──────────────────────────────────────╮ 1/4 (0) │ # A future-proof notebook │> Notebook housekeeping Tending to y.. │ `zk` is designed to be future-proof │ │ and rely on simple plain text format │ │ s such as Markdown. │ 1/4 (0) │ # Notebook housekeeping 1/26 │> Notebook housekeeping Tending to y.. │ Tending to your notes does not only │ │ mean writing. You need to keep your │ │ ## Find related notes │ │ To surf your notebook with ease, mak │ │ e sure to link all related notes tog │ │ ether. You can list notes which coul │ │ d be good candidates for a new link │ │ with the `--related` [filtering opti │ │ on](note-filtering.md). │ │ ```sh │ │ $ zk list --related note.md │ │ ``` │ │ This returns notes which are not con │ │ nected to the given note, but with a │ │ t least one linked note in common. │ │ ## Find flimsy notes │> Ne ╭──────────────────────────────────────╮ 0/4 (0) │ │> New ╭──────────────────────────────────────╮> New n ╭──────────────────────────────────────╮> New no ╭──────────────────────────────────────╮> New not ╭──────────────────────────────────────╮> New note ╭──────────────────────────────────────╮ 1 # New note 2 docs/new-note.md > New note% $ zk list --linking-to note-id.md $ zk list --linking-to note-id.md Neuron neuron.md (2 weeks ago) ‣ using the [same settings as Neuron](https://neuron.zettel.page/id.html) to generate the [note IDs](note-id.md) in the [note configuration](config-note.md) Note configuration config-note.md (2 weeks ago) ‣ Characters set used to [generate random IDs](note-id.md). ‣ Just a [random ID](note-id.md), simple and elegant. Searching and filtering notes note-filtering.md (2 weeks ago) ‣ It works fine with only a path prefix as well. This is useful when you have a [note ID](note-id.md) prefix, but not the full file path. Found 3 notes $ zk list --linking-to note-id.md --format oneline $ zk list --linking-to note-id.md --format oneline Note configuration config-note.md (2 weeks ago)Searching and filtering notes note-filtering.md (2 weeks ago)Found 3 notes$ zk list --linking-to note-id.md --format oneline --recursive $ zk list --linking-to note-id.md --format oneline --recursive --max-distance 2 $ zk list --linking-to note-id.md --format oneline --recursive --max-distance 2 Command aliases config-alias.md (2 weeks ago)Configuration file config.md (3 weeks ago)Integration with fzf tool-fzf.md (2 weeks ago)Neuron neuron.md (2 weeks ago)Note group config-group.md (2 weeks ago)Notebook notebook.md (2 weeks ago)Notebook housekeeping notebook-housekeeping.md (5 days ago)Send notes for processing by other programs external-processing.md (2 weeks ago)Template syntax template.md (2 weeks ago)zk – a plain text note-taking assistant README.md (3 weeks ago)Found 13 notes$ zk list --format "{{word-count}}\t{{title}}" --sort word-count --limit 10 $ zk list --format "{{word-count}}\t{{title}}" --sort word-count --limit 10 3 New note7 Interesting subject10 March 04, 202154 A future-proof notebook69 Setting your default editor88 Automating frequent tasks93 Setting your default pager101 Call zk from other programs106 zk – a plain text note-taking assistant117 NotebookFound 10 notes$ vim .zk/config.toml 1 [note] 1 filename = "{{slug title}}" 2 template = "default.md" 4 [group.journal.note] 5 filename = "{{date now}}" 6 template = "journal.md" 8 [tool] 9 editor = "nvim" 10 fzf-preview = "bat -p --theme Nord --color always {-1}" 12 [alias] docs/.zk/config.toml 12 [note] 11 filename = "{{slug title}}" 10 template = "default.md" 8 [group.journal.note] 7 filename = "{{date now}}" 4 [tool] 3 editor = "nvim" 2 fzf-preview = "bat -p --theme Nord --color always {-1}" 13 [alias] 13 [note] 12 filename = "{{slug title}}" 11 template = "default.md" 10 9 [group.journal.note] 8 filename = "{{date now}}" 7 template = "journal.md" 6 5 [tool] 4 editor = "nvim" 3 fzf-preview = "bat -p --theme Nord --color always {-1}" 1 [alias] 14 -- INSERT -- 14 wc = "zk list --quiet --format '{{word-count}}\t{{title}}' --sort word- count --limit 10 $@" count --limit 10 $@" count --limit 10 $@" "docs/.zk/config.toml" $ zk wc $ zk wc $ zk wc --exclude journal --limit 5 $ zk wc --exclude journal --limit 5 $ + \ No newline at end of file diff --git a/docs/assets/media/screencast_shadow.svg b/docs/assets/media/screencast_shadow.svg deleted file mode 100644 index 7d9fde6..0000000 --- a/docs/assets/media/screencast_shadow.svg +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - - - - -$$echo$echo"I'm$echo"I'mwriting$echo"I'mwritingabout$echo"I'mwritingaboutit"$echo"I'mwritingaboutit"|$echo"I'mwritingaboutit"|zk$echo"I'mwritingaboutit"|zknew$echo"I'mwritingaboutit"|zknew--title$echo"I'mwritingaboutit"|zknew--title"Interesting$echo"I'mwritingaboutit"|zknew--title"Interestingsubject"1#Interestingsubject12I'mwritingaboutit3~docs/interesting-subject.mdcwd:/Users/mickael/dvpts/mickael/zkZZ$z$zk$zkl$zkli$zklis$zklist$zklist-$zklist--$zklist--match$zklist--match"write$zklist--match"writesubject"Interestingsubjectinteresting-subject.md(justnow)‣I'mwritingaboutitGettingstartedwithzkgetting-started.md(5daysago)‣…Pickasubject,[createanewnote](note-creation.md)andwriteon!```sh$zknew--title"Aninterestingconcept…Found2notes$zklist--match"writesubject"$zklist--match"writesubject-"$zklist--match"writesubject-s"$zklist--match"writesubject-st"$zklist--match"writesubject-sta"$zklist--match"writesubject-star"$zklist--match"writesubject-start"Found1note$zklist--match"writeORsubject"$zklist--match"writeORsubject"--limit$zklist--match"writeORsubject"--limit5Extrauservariablesconfig-extra.md(5daysago)‣…note-creation.md),forexample:*expandingcustommetadata(author,subject,etc.)*modifyinga[template](template.md)'soutputdynamicallydepending…Creatinganewnotenote-creation.md(6daysago)‣…surewhetheranotealreadyexistsforaparticularsubject,the"searchorcreate"modemightbemoreappropriatethan…Maintainingadailyjournaldaily-journal.md(1weekago)‣Let'sassumeyouwanttowritedailynotesnamedlike`2021-02-16.md`ina`journal/daily`sub-directory.This…Found5notes$zknew$zknewjournal1#February28,20212WhatdidIdotoday?3*docs/journal/2021-02-28.mdG3#February28,202121WhatdidIdotoday?4*--INSERT--4*Recording4*Recordinga4*Recordingascreencastfor4*RecordingascreencastforzkZZZ$zklistjournalFebruary28,2021journal/2021-02-28.md(justnow)‣WhatdidIdotoday?*Recordingascreencastforzk$zke$zked$zkedi$zkedit$zkedit-$zkedit--interactive$zkedit--interactive--exclude$zkedit--interactive--excludejournal╭──────────────────────────────────────╮│││╰──────────────────────────────────────╯>╭──────────────────────────────────────╮Ctrl-N:createanotewiththequer..││26/26(0)││>A future-proof notebook`zk` is de..││Automatingfrequenttasks`zk`was..││CallzkfromotherprogramsCallin..││CommandaliasesAcommandaliasis..││ConfigurationfileEach[notebook]..││CreatinganewnoteYoucanadda..││Extrauservariables`zk`isopene..││GettingstartedwithzkAshortin..││Integrationwithfzf[`fzf`](https..││InterestingsubjectI'mwritingab..││MaintainingadailyjournalLet's..││Neuron[Neuron](https://neuron.zet..││NoteIDEachnoteisuniquelyiden..││NoteconfigurationThe`[note]`se..││NotegroupA*group*isanamed[c..││NotebookA*notebook*isadirecto..││NotebookhousekeepingTendingtoy..││SearchingandfilteringnotesAfe..││Sendnotesforprocessingbyother..││Settingyourdefaulteditor`zk`i..││SettingyourdefaultpagerWhen`z..││Styling`zk`supportsa`{{style}}..╰──────────────────────────────────────╯26/26(0)│#Afuture-proofnotebook│>A future-proof notebook`zk` is de..│`zk`isdesignedtobefuture-proof│Automatingfrequenttasks`zk`was..│andrelyonsimpleplaintextformat│CallzkfromotherprogramsCallin..│ssuchasMarkdown.│ConfigurationfileEach[notebook]..│Theshapeofyour[notebook](noteboo│CreatinganewnoteYoucanadda..│k.md)isentirelyuptoyou,making│>f╭──────────────────────────────────────╮25/26(0)│#Afuture-proofnotebook│CallzkfromotherprogramsCallin..│andrelyonsimpleplaintextformat│Automatingfrequenttasks`zk`was..│ssuchasMarkdown.│SearchingandfilteringnotesAfe..│k.md)isentirelyuptoyou,making│Templatecontextwhenformattinga..││Templatecontextwhencreatingnote..││zk–aplaintextnote-takingassis..││Styling`zk`supportsa`{{style}}..││Templatesyntax`zk`usesthe[Han..││CreatinganewnoteYoucanadda..╰──────────────────────────────────────╯>fz╭──────────────────────────────────────╮>Integration with fzf[`fzf`](https..│`zk`isdesignedtobefuture-proof│ConfigurationfileEach[notebook]..│andrelyonsimpleplaintextformat│NotebookhousekeepingTendingtoy..│ssuchasMarkdown.│CommandaliasesAcommandaliasis..│Theshapeofyour[notebook](noteboo│6/26(0)│#Integrationwith`fzf`│>Integration with fzf[`fzf`](https..│[`fzf`](https://github.com/junegunn/│ConfigurationfileEach[notebook]..│fzf)isanawesomeandversatilefuz│NotebookhousekeepingTendingtoy..│zyfinderpowering`zk`'s[interacti│CreatinganewnoteYoucanadda..│vefilteringmode](note-filtering.md│SearchingandfilteringnotesAfe..│Besidesthestandard[`fzf`configur││ationoptions](https://github.com/ju││negunn/fzf)documentedonitswebsit││e,`zk`offersadditionaloptionsyo││ucansetinthe`[tool]`[configura││tionsection](config.md).││Ifyouwishtocustomizemoreof`fz││f`behavior,[pleasepostafeature││request](https://github.com/mickael-││menu/zk/issues).││##Previewcommand│6/26(0)│#Integrationwith`fzf`1/25││Youcancustomizethecommandusedt││opreviewanotewith`fzf-preview`│>fzf╭──────────────────────────────────────╮1#Integrationwithfzf2`fzf`isanawesomeandversatilefuzzyfinderpoweringzk'sinteractivefilteringmode.4Besidesthestandard`fzf`configurationoptionsdocumentedonitswebsite,zkoffersadditionaloptionsyoucansetinthe[tool]configurationsection.56Ifyouwishtocustomizemoreoffzfbehavior,pleasepostafeaturerequest.78##Previewcommand910Youcancustomizethecommandusedtopreviewanotewithfzf-preview.Thespecialplaceholder{-1}willbeexpandedtothenotefilepath.1112Bydefault,zkusescatforpreview,whichisabitboring.Amuchbetteroptionwouldbetouse`bat`whichsupportssyntaxhighlighting.1314```tomldocs/tool-fzf.md$zkedit-i$zkedit-i--created-after$zkedit-i--created-after"2$zkedit-i--created-after"2days$zkedit-i--created-after"2daysago"4/4(0)││February28,2021WhatdidIdoto..││4/4(0)│#Afuture-proofnotebook│February28,2021WhatdidIdoto..│andrelyonsimpleplaintextformat│InterestingsubjectI'mwritingab..│ssuchasMarkdown.││Theshapeofyour[notebook](noteboo││k.md)isentirelyuptoyou,making│4/4(0)│#February28,2021│Afuture-proofnotebook`zk`isde..│WhatdidIdotoday?│>February 28, 2021What did I do to..│*Recordingascreencastforzk│>Interesting subjectI'm writing ab..││4/4(0)│#Interestingsubject│Afuture-proofnotebook`zk`isde..│I'mwritingaboutit│>C╭──────────────────────────────────────╮0/4(0)││>Ca╭──────────────────────────────────────╮>Can╭──────────────────────────────────────╮>Can'╭──────────────────────────────────────╮>Can't╭──────────────────────────────────────╮>Can'tf╭──────────────────────────────────────╮>Can'tfi╭──────────────────────────────────────╮>Can'tfin╭──────────────────────────────────────╮>Can'tfind╭──────────────────────────────────────╮>Can'tfindw╭──────────────────────────────────────╮>Can'tfindwh╭──────────────────────────────────────╮>Can'tfindwha╭──────────────────────────────────────╮>Can'tfindwhat╭──────────────────────────────────────╮>Can'tfindwhatI╭──────────────────────────────────────╮>Can'tfindwhatIn╭──────────────────────────────────────╮>Can'tfindwhatIne╭──────────────────────────────────────╮>Can'tfindwhatInee╭──────────────────────────────────────╮>Can'tfindwhatIneed╭──────────────────────────────────────╮>Can'tfindwhatIneed:╭──────────────────────────────────────╮>Can'tfindwhatIneed:t╭──────────────────────────────────────╮>Can'tfindwhatIneed:ti╭──────────────────────────────────────╮>Can'tfindwhatIneed:tim╭──────────────────────────────────────╮>Can'tfindwhatIneed:time╭──────────────────────────────────────╮>Can'tfindwhatIneed:timet╭──────────────────────────────────────╮>Can'tfindwhatIneed:timeto╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetoh╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetohi╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetohit╭──────────────────────────────────────╮>Can'tfindwhatIneed:timetohitC╭──────────────────────────────────────╮>an'tfindwhatIneed:timetohitCt╭──────────────────────────────────────╮>n'tfindwhatIneed:timetohitCtr╭──────────────────────────────────────╮>'tfindwhatIneed:timetohitCtrl╭──────────────────────────────────────╮>tfindwhatIneed:timetohitCtrl-╭──────────────────────────────────────╮>findwhatIneed:timetohitCtrl-N╭──────────────────────────────────────╮>findwhatIneed:timetohitCtrl-N!╭──────────────────────────────────────╮1#Can'tfindwhatIneed:timetohitCtrl-N!docs/cant-find-what-i-need-time-to-hit-ctrl-n.md$zklist--linking-to$zklist--linking-tonote-id.mdNeuronneuron.md(4daysago)‣usingthe[samesettingsasNeuron](https://neuron.zettel.page/id.html)togeneratethe[noteIDs](note-id.md)inthe[noteconfiguration](config-note.md)Noteconfigurationconfig-note.md(5daysago)‣Characterssetusedto[generaterandomIDs](note-id.md).‣Justa[randomID](note-id.md),simpleandelegant.Searchingandfilteringnotesnote-filtering.md(1weekago)‣Itworksfinewithonlyapathprefixaswell.Thisisusefulwhenyouhavea[noteID](note-id.md)prefix,butnotthefullfilepath.Found3notes$zklist--linking-tonote-id.md--format$zklist--linking-tonote-id.md--formatoneline$zklist--linking-tonote-id.md--formatoneline--recursive$zklist--linking-tonote-id.md--formatoneline--recursive--max-distance$zklist--linking-tonote-id.md--formatoneline--recursive--max-distance2Commandaliasesconfig-alias.md(1weekago)Configurationfileconfig.md(2weeksago)Integrationwithfzftool-fzf.md(6daysago)Notegroupconfig-group.md(1weekago)Notebooknotebook.md(1weekago)Notebookhousekeepingnotebook-housekeeping.md(yesterday)Sendnotesforprocessingbyotherprogramsexternal-processing.md(1weekago)Templatesyntaxtemplate.md(2weeksago)zk–aplaintextnote-takingassistantREADME.md(2weeksago)Found13notes$zklist--linking-tonote-id.md--formatoneline--recursive--max-distance3Afuture-proofnotebookfuture-proof.md(yesterday)Automatingfrequenttasksautomation.md(1weekago)Callzkfromotherprogramsexternal-call.md(1weekago)Settingyourdefaulteditortool-editor.md(1weekago)Settingyourdefaultpagertool-pager.md(5daysago)Stylingstyle.md(2weeksago)Templatecontextwhencreatingnotestemplate-creation.md(2weeksago)Found23notes$zklist--format$zklist--format"{{word-count}}\t{{title}}"$zklist--format"{{word-count}}\t{{title}}"--sort$zklist--format"{{word-count}}\t{{title}}"--sortword-count$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limit$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limit107Interestingsubject10Can'tfindwhatIneed:timetohitCtrl-N!15February28,202154Afuture-proofnotebook69Settingyourdefaulteditor88Automatingfrequenttasks93Settingyourdefaultpager101Callzkfromotherprograms106zk–aplaintextnote-takingassistant117NotebookFound10notes$vim$vim.zk/config.toml1[note]1filename="{{slugtitle}}"2template="default.md"4[group.journal.note]5filename="{{datenow}}"6template="journal.md"8[tool]9editor="nvim"10fzf-preview="bat-p--themeNord--coloralways{-1}"12[alias]docs/.zk/config.toml12[note]11filename="{{slugtitle}}"10template="default.md"8[group.journal.note]7filename="{{datenow}}"4[tool]3editor="nvim"2fzf-preview="bat-p--themeNord--coloralways{-1}"13[alias]13[note]12filename="{{slugtitle}}"11template="default.md"109[group.journal.note]8filename="{{datenow}}"7template="journal.md"65[tool]4editor="nvim"3fzf-preview="bat-p--themeNord--coloralways{-1}"1[alias]14wc14wc=14wc="zk14wc="zklist14wc="zklist--quiet14wc="zklist--quiet--f~0fzf [A]~0filename [A]14wc="zklist--quiet--fo14wc="zklist--quiet--format14wc="zklist--quiet--format'{{word-c~0color [A]14wc="zklist--quiet--format'{{word-co14wc="zklist--quiet--format'{{word-cou14wc="zklist--quiet--format'{{word-count}}\t~0theme [A]~0tool [A]~0template [A]~0title [A]14wc="zklist--quiet--format'{{word-count}}\t{14wc="zklist--quiet--format'{{word-count}}\t{{t~0theme [A]~0tool [A]~0template [A]~0title [A]14wc="zklist--quiet--format'{{word-count}}\t{{ti~0title [A]14wc="zklist--quiet--format'{{word-count}}\t{{tit14wc="zklist--quiet--format'{{word-count}}\t{{titl14wc="zklist--quiet--format'{{word-count}}\t{{title14wc="zklist--quiet--format'{{word-count}}\t{{title}}'14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--s~0slug [A]14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--so14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sort14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortw~0word [A]14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortwo14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortwor14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-c~0count~0color14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-co14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-coucoun~0count [A]countcount--l~0list [A]count--licount--limcount--limitcount--limit1014wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sortword-count--limit10$@"$zkw$zkwc$zkwc--exclude$zkwc--excludejournal$zkwc--excludejournal--limit$zkwc--excludejournal--limit5$e$ec$ech$echo"$echo"I$echo"I'$echo"I'mw$echo"I'mwr$echo"I'mwri$echo"I'mwrit$echo"I'mwriti$echo"I'mwritin$echo"I'mwritinga$echo"I'mwritingab$echo"I'mwritingabo$echo"I'mwritingabou$echo"I'mwritingabouti$echo"I'mwritingaboutit$echo"I'mwritingaboutit"|z$echo"I'mwritingaboutit"|zkn$echo"I'mwritingaboutit"|zkne$echo"I'mwritingaboutit"|zknew-$echo"I'mwritingaboutit"|zknew--$echo"I'mwritingaboutit"|zknew--t$echo"I'mwritingaboutit"|zknew--ti$echo"I'mwritingaboutit"|zknew--tit$echo"I'mwritingaboutit"|zknew--titl$echo"I'mwritingaboutit"|zknew--title"$echo"I'mwritingaboutit"|zknew--title"I$echo"I'mwritingaboutit"|zknew--title"In$echo"I'mwritingaboutit"|zknew--title"Int$echo"I'mwritingaboutit"|zknew--title"Inte$echo"I'mwritingaboutit"|zknew--title"Inter$echo"I'mwritingaboutit"|zknew--title"Intere$echo"I'mwritingaboutit"|zknew--title"Interes$echo"I'mwritingaboutit"|zknew--title"Interest$echo"I'mwritingaboutit"|zknew--title"Interesti$echo"I'mwritingaboutit"|zknew--title"Interestin$echo"I'mwritingaboutit"|zknew--title"Interestings$echo"I'mwritingaboutit"|zknew--title"Interestingsu$echo"I'mwritingaboutit"|zknew--title"Interestingsub$echo"I'mwritingaboutit"|zknew--title"Interestingsubj$echo"I'mwritingaboutit"|zknew--title"Interestingsubje$echo"I'mwritingaboutit"|zknew--title"Interestingsubjec$echo"I'mwritingaboutit"|zknew--title"Interestingsubjectcwd:/Users/mickael/dvpts/mickael/zkcwd:/Users/mickael/dvpts/mickael/zkZ$zklist--m$zklist--ma$zklist--mat$zklist--matc$zklist--match"$zklist--match"w$zklist--match"wr$zklist--match"wri$zklist--match"writ$zklist--match"writes$zklist--match"writesu$zklist--match"writesub$zklist--match"writesubj$zklist--match"writesubje$zklist--match"writesubjec$zklist--match"writesubject$zklist--match"writeOsubject"$zklist--match"writeORsubject"$zklist--match"writeORsubject"-$zklist--match"writeORsubject"--$zklist--match"writeORsubject"--l$zklist--match"writeORsubject"--li$zklist--match"writeORsubject"--lim$zklist--match"writeORsubject"--limi:(END)$zkn$zkne$zknewj$zknewjo$zknewjournal/A4*R4*Re4*Rec4*Reco4*Recor4*Record4*Recordi4*Recordin4*Recordingas4*Recordingasc4*Recordingascr4*Recordingascre4*Recordingascree4*Recordingascreen4*Recordingascreenc4*Recordingascreenca4*Recordingascreencas4*Recordingascreencast4*Recordingascreencast4*Recordingascreencastf4*Recordingascreencastfo4*Recordingascreencastforz"docs/journal/2021-02-28.md""docs/journal/2021-02-28.md"4L,74Cwritten$zklistj$zklistjo$zklistjournal/$zkedit--$zkedit--i$zkedit--in$zkedit--int$zkedit--inte$zkedit--inter$zkedit--intera$zkedit--interac$zkedit--interact$zkedit--interacti$zkedit--interactiv$zkedit--interactive-$zkedit--interactive--$zkedit--interactive--e$zkedit--interactive--ex$zkedit--interactive--exc$zkedit--interactive--excl$zkedit--interactive--exclu$zkedit--interactive--exclud$zkedit--interactive--excludej$zkedit--interactive--excludejo$zkedit--interactive--excludejou$zkedit--interactive--excludejour$zkedit--interactive--excludejourn$zkedit--interactive--excludejournal/0/26(0)││Gettingstartedwith││SearchingandfnoteYoucanadda..│k.md)isentirelyuptoyou,making│Templatesyntaxgroup*isanamed[c..││rmattinga..││6/26(0)│#Afuture-proofnotebook│NotebookhousekeepingTendingtoy..│zyfinderpowering`zk││negunn/fzf)││Ify│8##$zkedit-i-$zkedit-i--$zkedit-i--c$zkedit-i--cr$zkedit-i--cre$zkedit-i--crea$zkedit-i--creat$zkedit-i--create$zkedit-i--created$zkedit-i--created-$zkedit-i--created-a$zkedit-i--created-af$zkedit-i--created-aft$zkedit-i--created-afte$zkedit-i--created-after"$zkedit-i--created-after"2d$zkedit-i--created-after"2da$zkedit-i--created-after"2day$zkedit-i--created-after"2daysa$zkedit-i--created-after"2daysag$zkedit-i--created-after"2daysagoâ §0/0(0)││Afuture-proofnotebook`zk`isde..│`zk`isdesignedtobefuture-proof│>February 28, 2021What did I do to..│andrelyonsimpleplaintextformat│February28,2021WhatdidIdoto..│*Recordingascreencastforzk│0/4(0)│#Interestingsubject││I'mwritingaboutit│$zklist--l$zklist--li$zklist--lin$zklist--link$zklist--linki$zklist--linkin$zklist--linking$zklist--linking-$zklist--linking-t$zklist--linking-ton$zklist--linking-tono$zklist--linking-tonot$zklist--linking-tonote$zklist--linking-tonote-$zklist--linking-tonote-i$zklist--linking-tonote-id.md-$zklist--linking-tonote-id.md--$zklist--linking-tonote-id.md--f$zklist--linking-tonote-id.md--fo$zklist--linking-tonote-id.md--for$zklist--linking-tonote-id.md--form$zklist--linking-tonote-id.md--forma$zklist--linking-tonote-id.md--formato$zklist--linking-tonote-id.md--formaton$zklist--linking-tonote-id.md--formatone$zklist--linking-tonote-id.md--formatonel$zklist--linking-tonote-id.md--formatoneli$zklist--linking-tonote-id.md--formatonelin$zklist--linking-tonote-id.md--formatoneline-$zklist--linking-tonote-id.md--formatoneline--$zklist--linking-tonote-id.md--formatoneline--r$zklist--linking-tonote-id.md--formatoneline--re$zklist--linking-tonote-id.md--formatoneline--rec$zklist--linking-tonote-id.md--formatoneline--recu$zklist--linking-tonote-id.md--formatoneline--recur$zklist--linking-tonote-id.md--formatoneline--recurs$zklist--linking-tonote-id.md--formatoneline--recursi$zklist--linking-tonote-id.md--formatoneline--recursiv$zklist--linking-tonote-id.md--formatoneline--recursive-$zklist--linking-tonote-id.md--formatoneline--recursive--$zklist--linking-tonote-id.md--formatoneline--recursive--m$zklist--linking-tonote-id.md--formatoneline--recursive--ma$zklist--linking-tonote-id.md--formatoneline--recursive--max$zklist--linking-tonote-id.md--formatoneline--recursive--max-$zklist--linking-tonote-id.md--formatoneline--recursive--max-d$zklist--linking-tonote-id.md--formatoneline--recursive--max-di$zklist--linking-tonote-id.md--formatoneline--recursive--max-dis$zklist--linking-tonote-id.md--formatoneline--recursive--max-dist$zklist--linking-tonote-id.md--formatoneline--recursive--max-dista$zklist--linking-tonote-id.md--formatoneline--recursive--max-distan$zklist--linking-tonote-id.md--formatoneline--recursive--max-distancExtrauservariableExtrauservariables$zklist--f$zklist--fo$zklist--for$zklist--form$zklist--forma$zklist--format"$zklist--format"{$zklist--format"{{$zklist--format"{{w$zklist--format"{{wo$zklist--format"{{wor$zklist--format"{{word$zklist--format"{{word-$zklist--format"{{word-c$zklist--format"{{word-co$zklist--format"{{word-cou$zklist--format"{{word-coun$zklist--format"{{word-count$zklist--format"{{word-count}$zklist--format"{{word-count}}$zklist--format"{{word-count}}\$zklist--format"{{word-count}}\t$zklist--format"{{word-count}}\t{$zklist--format"{{word-count}}\t{{$zklist--format"{{word-count}}\t{{t$zklist--format"{{word-count}}\t{{ti$zklist--format"{{word-count}}\t{{tit$zklist--format"{{word-count}}\t{{titl$zklist--format"{{word-count}}\t{{title$zklist--format"{{word-count}}\t{{title}$zklist--format"{{word-count}}\t{{title}}$zklist--format"{{word-count}}\t{{title}}"-$zklist--format"{{word-count}}\t{{title}}"--$zklist--format"{{word-count}}\t{{title}}"--s$zklist--format"{{word-count}}\t{{title}}"--so$zklist--format"{{word-count}}\t{{title}}"--sor$zklist--format"{{word-count}}\t{{title}}"--sortw$zklist--format"{{word-count}}\t{{title}}"--sortwo$zklist--format"{{word-count}}\t{{title}}"--sortwor$zklist--format"{{word-count}}\t{{title}}"--sortword$zklist--format"{{word-count}}\t{{title}}"--sortword-$zklist--format"{{word-count}}\t{{title}}"--sortword-c$zklist--format"{{word-count}}\t{{title}}"--sortword-co$zklist--format"{{word-count}}\t{{title}}"--sortword-cou$zklist--format"{{word-count}}\t{{title}}"--sortword-coun$zklist--format"{{word-count}}\t{{title}}"--sortword-count-$zklist--format"{{word-count}}\t{{title}}"--sortword-count--$zklist--format"{{word-count}}\t{{title}}"--sortword-count--l$zklist--format"{{word-count}}\t{{title}}"--sortword-count--li$zklist--format"{{word-count}}\t{{title}}"--sortword-count--lim$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limi$zklist--format"{{word-count}}\t{{title}}"--sortword-count--limit1$v$vi$vim.$vim.z$vim.zk$vim.zk/$vim.zk/c$vim.zk/co$vim.zk/con$vim.zk/conf$vim.zk/confio1414w14wc="14wc="z14wc="zkl14wc="zkli14wc="zklis14wc="zklist-14wc="zklist--14wc="zklist--q14wc="zklist--qu14wc="zklist--qui14wc="zklist--quie14wc="zklist--quiet-14wc="zklist--quiet--14wc="zklist--quiet--for14wc="zklist--quiet--form14wc="zklist--quiet--forma14wc="zklist--quiet--format"14wc="zklist--quiet--format'14wc="zklist--quiet--format'{14wc="zklist--quiet--format'{{14wc="zklist--quiet--format'{{w14wc="zklist--quiet--format'{{wo14wc="zklist--quiet--format'{{wor14wc="zklist--quiet--format'{{word14wc="zklist--quiet--format'{{word-14wc="zklist--quiet--format'{{word-coun14wc="zklist--quiet--format'{{word-count14wc="zklist--quiet--format'{{word-count}14wc="zklist--quiet--format'{{word-count}}14wc="zklist--quiet--format'{{word-count}}\14wc="zklist--quiet--format'{{word-count}}\t{{14wc="zklist--quiet--format'{{word-count}}\t{{title}14wc="zklist--quiet--format'{{word-count}}\t{{title}14wc="zklist--quiet--format'{{word-count}}\t{{title}}14wc="zklist--quiet--format'{{word-count}}\t{{title}}'-14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--14wc="zklist--quiet--format'{{word-count}}\t{{title}}'--sorcount-count--count--limicount--limit1count--limit10%count--limit10$count--limit10$@"docs/.zk/config.toml""docs/.zk/config.toml"14L,312Cwritten$zkwc-$zkwc--$zkwc--e$zkwc--ex$zkwc--exc$zkwc--excl$zkwc--exclu$zkwc--exclud$zkwc--excludej$zkwc--excludejo$zkwc--excludejou$zkwc--excludejour$zkwc--excludejourn$zkwc--excludejourna$zkwc--excludejournal-$zkwc--excludejournal--$zkwc--excludejournal--l$zkwc--excludejournal--li$zkwc--excludejournal--lim$zkwc--excludejournal--limi - - \ No newline at end of file diff --git a/docs/getting-started.md b/docs/getting-started.md index d861b76..ba8665a 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -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! +
Create a note
+ +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. + +
Create a note
+ +## 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" ``` +
Format the list output
+ +Sort the results however you need with `--sort`. + +
Format the list output
+ +`--format` and `--delimiter` offer some versatile formatting options to customize the output. + +
Format the list output
+ +`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`. + +
Format the list output
+ +`zk` supports an interactive mode powered by [`fzf`](https://github.com/junegunn/fzf) to further filter notes manually. + +
Format the list output
## 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 +
Format the list output
-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. + +
Format the list output
+