Archives/zk
2
0
Fork 0
mirror of https://github.com/mickael-menu/zk synced 2024-11-15 12:12:56 +00:00
Code Issues Projects Releases Wiki Activity
fa66e78068
zk/docs/template-format.md
Mickaël Menu f5b3102deb
Save additional metadata in the database (#7) 
* YAML frontmatter as a JSON object in `notes.metadata`
    * Print metadata from the YAML frontmatter in `list` output using `{{metadata.<key>}}`, e.g. `{{metadata.description}}`. Keys are normalized to lower case.
* Start and end offsets for link snippets.
    * This could be useful to expand backlinks contexts.
2021-03-08 21:38:32 +01:00

1.6 KiB
Raw Blame History

Template context when formatting a note

The following variables are available in the templates used when formatting notes, for example with zk list --format <template>.

Variable Type Description
path string File path to the note, relative to the current directory
title string Note title
lead string First paragraph extracted from the note content
body string All of the note content, minus the heading
snippets [string] List of context-sensitive relevant excerpts from the note
raw-content string The full raw content of the note file
word-count int Number of words in the note
tags [string] List of tags found in the note
metadata map YAML frontmatter metadata, e.g. metadata.description1
created date Date of creation of the note
modified date Last date of modification of the note
checksum string SHA-256 checksum of the note file
  1. YAML keys are normalized to lower case.