about summary refs log tree commit diff
path: root/splorm/TEMPLATES.md
blob: f96cbfdc1e8a15dff1d9922b2bd77e89eb17ecd1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
what variables are available in templates?

### frontmatter

**description** (default: none)  
description of the page for OpenGraph tags

**markup** (default: legacy)  
how to process the content going into the page.
Either through `legacy` or `breakdown`

**title** (default: filename)  
the `<title>` of the page

<center>⁂</center>

**features** (default: none)  
featuers to enable for this page: `SystemStats`

**skip-path** (default: none)  
number of path components to remove while displaying the **`path`** pattern.

### patterns
**pathnav**  
creates a collection of navigation links linking to directories under the page.

template variables:
- `pathnav_link`: link to navigate to
- `pathnav_name`: displayed name of the link

frontmatter:
- `skip-path`: how many immediate parents to remove from the path

**published**  
inserts an html element showing the time a page was published

template variables:
- `published_human`: time formatted for a human to read
- `published_machine`: time formatted for a machine to read

frontmatter:
- `published`: time page was published

**styles**  
inserts `<link rel="stylesheet">` into the head of the document.

template variables:
- `style`: path to a stylesheet

frontmatter:
- `style`: path to a stylesheet

## features
**`SystemStats`**  
enables tempalte variables for system statistics acquired from gatherer