Bot releases are hidden (Show)
tool.shell
configuration key to set a custom shell (contributed by @lsvmello).notebook.dir
configuration key to set the default notebook (contributed by @lsvmello).note.ignore
configuration property was renamed to note.exclude
, to be more consistent with the CLI flags.Published by mickael-menu over 1 year ago
zk.new
now returns the created note's content in its output (content
), and has two new options:
dryRun
will prevent zk.new
from creating the note on the file system.insertContentAtLocation
can be used to insert the created note's content into an arbitrary location.zk.link
command to insert a link to a given note (contributed by @psanker).Published by mickael-menu almost 2 years ago
documentLink
.{{date}}
template helper to obtain a date object from natural language (contributed by @zalegrala).
Get a relative date using natural language:
{{date "next week"}}
Format a date returned by `get-date`:
{{format-date (date "monday") "timestamp"}}
zk list
now support multiple --match
/-m
flags, which allows to search for several tokens appearing in any order in the notes (contributed by @rktjmp).{{date}}
template helper was renamed to {{format-date}}
. You might need to update your configuration and templates.Published by mickael-menu over 2 years ago
zk new
now requires the --interactive
/-i
flag to read the note body from a pipe or standard input. See rational.Published by mickael-menu over 2 years ago
--match
.
# Find notes containing emails.
$ zk list --match-strategy re --match ".+@.+"
$ zk list -Mr -m ".+@.+"
--exact-match
/-e
are deprecated in favor of --match-strategy exact
/-Me
.[[Planet]]
can match a note with filename i4w0 Planet.md
but not i4w0.md
with a Markdown title Planet
anymore.zk
CLI.Published by mickael-menu over 2 years ago
libicu
.Published by mickael-menu over 2 years ago
New --date
flag for zk new
to set the current date manually.
New --id
flag for zk new
to skip ID generation and use a provided value (contributed by @skbolton).
#144 LSP auto-completion of YAML frontmatter tags.
zk-nvim#26 The LSP server doesn't use additionalTextEdits
anymore to remove the trigger characters when completing links.
use-additional-text-edits
configuration key.#163 Use the ZK_SHELL
environment variable to override the shell for zk
only.
#173 Support for double star globbing in note.ignore
config option.
#137 Customize the fzf
options used by zk
's interactive modes with the fzf-options
config option (contributed by @Nelyah).
#168 Customize the fzf
key binding to create new notes with the fzf-bind-new
config option.
fzf
key binding to create a new note with zk edit --interactive
was changed to Ctrl-E
, to avoid conflict with the default Ctrl-N
binding.Published by mickael-menu almost 3 years ago
zk.list
to search for notes.zk.tag.list
to retrieve the list of tags.--debug
mode which prints a stacktrace on SIGINT
.Published by mickael-menu almost 3 years ago
zk graph --format json
command which produces a JSON graph of the notes matching the given criteria.filename
and filename-stem
when formatting notes (e.g. with zk list --format
) and for the fzf-line
config key.[lsp.completion]
configuration section.
[lsp.completion]
# Show the note title in the completion pop-up, or fallback on its path if empty.
note-label = "{{title-or-path}}"
# Filter out the completion pop-up using the note title or its path.
note-filter-text = "{{title}} {{path}}"
# Show the note filename without extension as detail.
note-detail = "{{filename-stem}}"
--dry-run
flag for zk new
which prints out the path and content of the generated note instead of saving it to the file system.--verbose
flag for zk index
which prints detailed information about the indexing process.zk list --interactive
.zk index
from outside the notebook (contributed by @adamreese).--linked-by
and --link-to
.Published by mickael-menu about 3 years ago
zk tag list
.
zk tag list --help
.link-format
.
filename
, path
, abs-path
and rel-path
for many path flavors.metadata
to use information (e.g. id
) from the YAML frontmatter.book/z5mj Information Graphics.md
with the title "Book Review of Information Graphics", the following wiki links would work from a note located under journal/2020-09-25.md
:
[[../book/z5mj]]
[[book/z5mj]]
[[z5mj]]
[[book review information]]
[[Information Graphics]]
{{abs-path}}
template variable when formatting notes to print the absolute path to the note (contributed by @pstuifzand).{{substring s index length}}
template helper extracts a portion of a given string, e.g.:
{{substring 'A full quote' 2 4}}
outputs full
{{substring 'A full quote' -5 5}
outputs quote
Published by mickael-menu over 3 years ago
zk list
for easy post-processing:
--format json
prints a plain JSON array.--format jsonl
prints one JSON note object per line, according to JSON Lines.{{json}}
template helper serializes any template context variable into a valid JSON value, e.g.:
{{json title}}
prints with quotes "An interesting note"
{{json .}}
serializes the full template context as a JSON object.--header
and --footer
options with zk list
to print arbitrary text at the start or end of the list.note.ignore
configuration option to ignore files matching the given path globs when indexing notes.
[note]
ignore = [
"log-*.md"
"drafts/*"
]
[[filename#section]]
.zk index --force
after upgrading to fix your index.Published by mickael-menu over 3 years ago
new
and index
from your editor.[custom title]((
.fzf
's lines with your own template.
[tool]
fzf-line = "{{style 'green' path}}{{#each tags}} #{{this}}{{/each}} {{style 'black' body}}"
fzf
in a directory containing spaces.Published by mickael-menu over 3 years ago
zk init
command.[[
(setup wiki-links in the note formats configuration)--match
with --exact-match
/ -e
to search for (case insensitive) exact occurrences in your notes.
[[name]]
.{{link}}
template variable when formatting notes to print a link to the note, relative to the working directory.{{format-link path title}}
template helper to render a custom link..zk/config.toml
) is not required anymore in a notebook's .zk
directory.--notebook-dir
does not change the working directory anymore, instead it sets manually the current notebook and disable auto-discovery. Use the new --working-dir
/-W
flag to run zk
as if it was started from this path instead of the current working directory.
ZK_NOTEBOOK_DIR
behaves like setting a --working-dir
fallback, instead of --notebook-dir
. This way, paths will be relative to the root of the notebook.zk list -W .
when outside a notebook. This will list the notes in ZK_NOTEBOOK_DIR
but print paths relative to the current directory, making them actionable from your terminal emulator.Published by mickael-menu over 3 years ago
zk
configuration at ~/.config/zk/config.toml
.
~/.config/zk/templates/
.XDG_CONFIG_HOME
is taken into account.--notebook-dir
or set ZK_NOTEBOOK_DIR
to run zk
as if it was started from this path instead of the current working directory.
zk
without being in a notebook.ZK_NOTEBOOK_DIR
in your shell configuration file (e.g. ~/.profile
), you are declaring a default global notebook which will be used when zk
is not in a notebook.--mentioned-by file.md
.
aliases
. For example the note titled "Artificial Intelligence" might have: aliases: [AI, robot]
--no-linked-by
, e.g. --mentioned-by file.md --no-linked-by file.md
.[filter]
recents = "--sort created- --created-after 'last two weeks'"
$ zk list recents --limit 10
$ zk edit recents --interactive
Published by mickael-menu over 3 years ago
Published by mickael-menu over 3 years ago
--tag "history, europe"
.
|
or OR
(all caps), e.g. --tag "inbox OR todo"
.-
or NOT
(all caps), e.g. --tag "NOT done"
.--tag "book-*"
.#hashtags
, :colon:separated:tags:
(opt-in) and even Bear's #multi-word tags#
(opt-in). If you prefer to use a YAML frontmatter, list your tags with the key tags
or keywords
.--mention file.md
.
aliases
. For example the note titled "Artificial Intelligence" might have: aliases: [AI, robot]
--no-link-to
, e.g. --mention file.md --no-link-to file.md
.list
output using {{metadata.<key>}}
, e.g. {{metadata.description}}
. Keys are normalized to lower case.date
for the note creation date, when provided.env.<key>
template variable, e.g. {{env.PATH}}
.--linking-to
filtering option to --link-to
.--extra
variables are now separated by ,
instead of ;
.Published by mickael-menu over 3 years ago
Very first release!