mirror of
https://github.com/mickael-menu/zk
synced 2024-11-07 15:20:21 +00:00
2.9 KiB
2.9 KiB
Changelog
All notable changes to this project will be documented in this file.
Unreleased
Added
- Global
zk
configuration at~/.config/zk/config.toml
.- Useful to share aliases or default settings across several notebooks.
- This is the same format as a notebook configuration file.
- Shared templates can be stored in
~/.config/zk/templates/
. XDG_CONFIG_HOME
is taken into account.
- Use
--notebook-dir
or setZK_NOTEBOOK_DIR
to runzk
as if it was started from this path instead of the current working directory.- This allows running
zk
without being in a notebook. - By setting
ZK_NOTEBOOK_DIR
in your shell configuration file (e.g.~/.profile
), you are declaring a default global notebook which will be used whenzk
is not in a notebook. - When the notebook directory is set explicitly, any path given as argument will be relative to it instead of the actual working directory.
- This allows running
0.2.1
Fixed
- Looking for mentions of a note with a title containing double quotes.
- Crash when parsing certain link snippets.
0.2.0
Added
- Support for tags.
- Filter notes by their tags using
--tag "history, europe"
.- To match notes associated with either tags, use a pipe
|
orOR
(all caps), e.g.--tag "inbox OR todo"
. - If you want to exclude notes having a particular tag, prefix it with
-
orNOT
(all caps), e.g.--tag "NOT done"
. - Use glob patterns to match multiple tags, e.g.
--tag "book-*"
.
- To match notes associated with either tags, use a pipe
- Many tag flavors are supported:
#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 keytags
orkeywords
.
- Filter notes by their tags using
- Find every mention of a note in your notebook with
--mention file.md
.- This will look for occurrences of the note's title in other notes.
- To refer to a note using several names, you can use the YAML frontmatter key
aliases
. For example the note titled "Artificial Intelligence" might have:aliases: [AI, robot]
- To find only unlinked mentions, pair it with
--no-link-to
, e.g.--mention file.md --no-link-to file.md
.
- Print metadata from the YAML frontmatter in
list
output using{{metadata.<key>}}
, e.g.{{metadata.description}}
. Keys are normalized to lower case. - Use the YAML frontmatter key
date
for the note creation date, when provided. - Access environment variables from note templates with the
env.<key>
template variable, e.g.{{env.PATH}}
.
Changed
- Renamed
--linking-to
filtering option to--link-to
. - Multiple
--extra
variables are now separated by,
instead of;
.