Update changelog and documentation

CHANGELOG.md

@@ -6,9 +6,22 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+* Support for LSP references to browse the backlinks of the current note, if the caret is not over a link.
+* New template variables are available when [generating custom Markdown links with `link-format`](docs/note-format.md).
+    * `filename`, `path`, `abs-path` and `rel-path` for many path flavors.
+    * `metadata` to use information (e.g. `id`) from the YAML frontmatter.
+* The LSP server is now matching wiki links to any part of a note's path or its title.
+    * Given the note `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`:
+        ```markdown
+        [[../book/z5mj]]
+        [[book/z5mj]]
+        [[z5mj]]
+        [[book review information]]
+        [[Information Graphics]]
+        ```
 * Use the `{{abs-path}}` template variable when [formatting notes](docs/template-format.md) to print the absolute path to the note (contributed by [@pstuifzand](https://github.com/mickael-menu/zk/pull/60)).
 * Allow setting the `--working-dir` and `--notebook-dir` flags before the `zk` subcommand when using aliases, e.g. `zk -W ~/notes my-alias`.
-* Support for LSP references to browse the backlinks of the current note, if the caret is not over a link.
+
 
 ### Fixed
 

docs/note-format.md

@@ -21,9 +21,22 @@ You can set up some features of `zk`'s Markdown parser from your [configuration
 
 ### Customizing the Markdown links generated by `zk`
 
-By default, `zk` will generate regular Markdown links for internal links. If you prefer to use `[[Wiki Links]]` instead, set the `link-format` setting to `wiki`. If you want to override completely the link format, you can also set `link-format` to a [custom template](template.md). Two variables `path` and `title` are available in the template, for example to generate a wiki-link with a title:
+By default, `zk` will generate regular Markdown links for internal links. If you prefer to use `[[Wiki Links]]` instead, set the `link-format` setting to `wiki`. If you want to override completely the link format, you can also set `link-format` to a [custom template](template.md). For example, to generate a wiki link using an ID from the frontmatter and a title:
 
 ```toml
 [format.markdown]
-link-format = "[[{{path}}|{{title}}]]"
+link-format = "[[{{metadata.id}}|{{title}}]]"
 ```
+
+The following variables are available in the template:
+
+| Variable   | Type   | Description                                               |
+|------------|--------|-----------------------------------------------------------|
+| `filename` | string | Filename of the note                                      |
+| `path`     | string | File path to the note, relative to the notebook directory |
+| `abs-path` | string | Absolute file path to the note                            |
+| `rel-path` | string | File path to the note, relative to the current directory  |
+| `title`    | string | Note title                                                |
+| `metadata` | map    | YAML frontmatter metadata, e.g. `metadata.id`<sup>1</sup> |
+
+1. YAML keys are normalized to lower case.