Changelog

All notable changes to this project will be documented in this file.

Unreleased

Customize the format of fzf's lines with your own template.

[tool]
fzf-line = "{{style 'green' path}}{{#each tags}} #{{this}}{{/each}} {{style 'black' body}}"

Interactive wizard for the zk init command.
An experimental Language Server for LSP-compatible editors:
- Auto-complete Markdown links with [[ (setup wiki-links in the note formats configuration)
- Auto-complete hashtags and colon-separated tags.
- Preview the content of a note when hovering a link.
- Navigate in your notes by following internal links.
- And more to come...
- See the documentation for configuration samples.
Pair --match with --exact-match / -e to search for (case insensitive) exact occurrences in your notes.
- This can be useful when looking for terms including special characters, such as [[name]].
Generating links to notes.
- Use the {{link}} template variable when formatting notes to print a link to the note, relative to the working directory.
- Use the {{format-link path title}} template helper to render a custom link.
- Customize the link format from the note formats settings. You can for example choose regular Markdown links, Wiki-links or a custom format.

The local configuration file (.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.
- For convenience, 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.
- A practical use case is to use 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.

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 set ZK_NOTEBOOK_DIR to run zk 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 when zk 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.
Find every note whose title is mentioned in the note you are working on with --mentioned-by file.md.
- 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-linked-by, e.g. --mentioned-by file.md --no-linked-by file.md.

Declare named filters in the configuration file to reuse note filtering options used frequently together, for example:

[filter]
recents = "--sort created- --created-after 'last two weeks'"

$ zk list recents --limit 10
$ zk edit recents --interactive

Support for tags.
- Filter notes by their tags using --tag "history, europe".
  - To match notes associated with either tags, use a pipe | or OR (all caps), e.g. --tag "inbox OR todo".
  - If you want to exclude notes having a particular tag, prefix it with - or NOT (all caps), e.g. --tag "NOT done".
  - Use glob patterns to match multiple tags, e.g. --tag "book-*".
- 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 key tags or keywords.
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}}.