nat
/
calathea
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix error in README

This commit is contained in:
Nat 2023-08-31 13:21:43 -07:00
parent 08a358b0ce
commit dc73067439
Signed by: nat
GPG Key ID: B53AB05285D710D6
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -20,11 +20,13 @@ Complete, valid yaml frontmatter for a page:
``` ```
--- ---
title: required string title: required string
permalink: required string permalink: optional string
data: optional anything data: optional anything
--- ---
``` ```
If a permalink is not specified, the resultant file will have the same stem as the source file, and the extension `html`.
Besides the above, the following variables can be accessed from the global scope in the template: Besides the above, the following variables can be accessed from the global scope in the template:
- `incoming` - a list of objects in the form of `{ title, permalink, data, id }` that link to this page - `incoming` - a list of objects in the form of `{ title, permalink, data, id }` that link to this page
- `id` - a trimmed, lower-cased version of the current page's title used internally to reference pages - `id` - a trimmed, lower-cased version of the current page's title used internally to reference pages