mirror/ kiln
1
0
Fork 0
mirror of https://git.sr.ht/~adnano/kiln synced 2024-06-08 08:16:09 +02:00
Code Issues Activity

docs: Move functions to bottom

This commit is contained in:
adnano 2022-02-09 01:43:11 -05:00
parent a5b2fe82ba
commit e4217aca3f
1 changed files with 81 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

162
docs/kiln.1.scd
View File

@ -406,6 +406,87 @@ Example feed configuration:
Templates have certain data and functions available to them.
## SITE METADATA
Site metadata contains the following data:
*Title*
The title of the site.
*Params*
Extra parameters specified in configuration.
*Generated*
Site generation time.
Site metadata can be accessed from templates with the *site* function. See
*TEMPLATE FUNCTIONS*.
To configure these variables, see *CONFIGURATION*.
## PAGE TEMPLATES
Page and index templates are provided with the following data:
*Title*
The title of the page
*Date*
The date of the page
*Weight*
The weight of the page
*Path*
The path to the page
*URL*
The URL of the page. If no base URL is configured, it is equivalent to
*Path*.
*FilePath*
The path of the page file or directory relative to the content directory
*Content*
The contents of the page
*Params*
Extra parameters specified in frontmatter
*Prev*
The previous page in sorted order
*Next*
The next page in sorted order
*Pages*
List of pages in this directory
*Dirs*
List of subdirectories in this directory
## FEED TEMPLATES
Feed templates are provided with the following data:
*Title*
Title of the feed
*Path*
The path to the feed directory
*URL*
The URL of the feed directory
*Pages*
List of pages in this feed
## PARTIAL TEMPLATES
Partial templates can be placed in the templates/\_partials directory.
Partial templates can be executed from any other template with the *partial*
function. See *TEMPLATE FUNCTIONS*.
## TEMPLATE FUNCTIONS
All templates have the following functions available to them:
@ -630,84 +711,3 @@ All templates have the following functions available to them:
its arguments in a form suitable for embedding in a URL query.
This function is unavailable in HTML templates, with a few
exceptions.
## SITE METADATA
Site metadata contains the following data:
*Title*
The title of the site.
*Params*
Extra parameters specified in configuration.
*Generated*
Site generation time.
Site metadata can be accessed from templates with the *site* function. See
*TEMPLATE FUNCTIONS*.
To configure these variables, see *CONFIGURATION*.
## PAGE TEMPLATES
Page templates are provided with the following data:
*Title*
The title of the page
*Date*
The date of the page
*Weight*
The weight of the page
*Path*
The path to the page
*URL*
The URL of the page. If no base URL is configured, it is equivalent to
*Path*.
*FilePath*
The path of the page file or directory relative to the content directory
*Content*
The contents of the page
*Params*
Extra parameters specified in frontmatter
*Prev*
The previous page in sorted order
*Next*
The next page in sorted order
*Pages*
List of pages in this directory
*Dirs*
List of subdirectories in this directory
## FEED TEMPLATES
Feed templates are provided with the following data:
*Title*
Title of the feed
*Path*
The path to the feed directory
*URL*
The URL of the feed directory
*Pages*
List of pages in this feed
## PARTIAL TEMPLATES
Partial templates can be placed in the templates/\_partials directory.
Partial templates can be executed from any other template with the *partial*
function. See *TEMPLATE FUNCTIONS*.