You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
zk/docs/template-creation.md

22 lines
1.7 KiB
Markdown

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# Template context when creating notes
The following variables are available in the templates used when [creating new notes](note-creation.md) both for the filename and the note content.
| Variable | Type | Description |
|---------------|--------|---------------------------------------------------------------------------------------|
| `id` | string | Random ID generated for this note |
| `title` | string | Note title given to `--title` |
| `content` | string | Any text piped through the standard input |
| `dir` | string | Parent directory in the notebook |
| `extra.<key>` | string | [Additional variables](config-extra.md) provided through the config file or `--extra` |
| `now` | date | Current date and time, useful when paired with [`{{format-date now}}`](template.md) |
| `env` | map | Dictionary of case-sensitive environment variables, e.g. `{{env.PATH}}`. |
These additional variables are available only to the note content template, once the filename is generated.
| Variable | Type | Description |
|-----------------|--------|----------------------------------------------------------------|
| `filename` | string | Filename generated for this note, including the file extension |
| `filename-stem` | string | Filename without the file extension |