mirror of https://github.com/getzola/zola
153 lines
5.3 KiB
Markdown
153 lines
5.3 KiB
Markdown
+++
|
|
title = "Sections and Pages"
|
|
weight = 20
|
|
+++
|
|
|
|
Templates for pages and sections are very similar.
|
|
|
|
## Page variables
|
|
Zola will try to load the `templates/page.html` template, the `page.html` template of the theme if one is used
|
|
or render the built-in template (a blank page).
|
|
|
|
Whichever template you decide to render, you will get a `page` variable in your template
|
|
with the following fields:
|
|
|
|
|
|
```ts
|
|
// The HTML output of the Markdown content
|
|
content: String;
|
|
title: String?;
|
|
description: String?;
|
|
date: String?;
|
|
updated: String?;
|
|
slug: String;
|
|
path: String;
|
|
authors: Array<String>;
|
|
draft: Bool;
|
|
// the path, split on '/'
|
|
components: Array<String>;
|
|
permalink: String;
|
|
summary: String?;
|
|
taxonomies: HashMap<String, Array<String>>;
|
|
extra: HashMap<String, Any>;
|
|
toc: Array<Header>,
|
|
// Naive word count, will not work for languages without whitespace
|
|
word_count: Number;
|
|
// Based on https://help.medium.com/hc/en-us/articles/214991667-Read-time
|
|
reading_time: Number;
|
|
// earlier / lighter
|
|
lower: Page?;
|
|
// later / heavier
|
|
higher: Page?;
|
|
// Year/month/day is only set if the page has a date and month/day are 1-indexed
|
|
year: Number?;
|
|
month: Number?;
|
|
day: Number?;
|
|
// Paths of colocated assets, relative to the content directory
|
|
assets: Array<String>;
|
|
// The relative paths of the parent sections until the index one, for use with the `get_section` Tera function
|
|
// The first item is the index section and the last one is the parent section
|
|
// This is filled after rendering a page content so it will be empty in shortcodes
|
|
ancestors: Array<String>;
|
|
// The relative path from the `content` directory to the markdown file
|
|
relative_path: String;
|
|
// The relative path from the `content` directory to the directory of a colocated index.md markdown file
|
|
// Null if the file is not colocated.
|
|
colocated_path: String?;
|
|
// The language for the page if there is one. Default to the config `default_language`
|
|
lang: String;
|
|
// Information about all the available languages for that content, including the current page
|
|
translations: Array<TranslatedContent>;
|
|
// All the pages/sections linking this page: their permalink and a title if there is one
|
|
backlinks: Array<{permalink: String, title: String?}>;
|
|
```
|
|
|
|
## Section variables
|
|
By default, Zola will try to load `templates/index.html` for `content/_index.md`
|
|
and `templates/section.html` for other `_index.md` files. If there isn't
|
|
one, it will render the built-in template (a blank page).
|
|
|
|
Whichever template you decide to render, you will get a `section` variable in your template
|
|
with the following fields:
|
|
|
|
|
|
```ts
|
|
// The HTML output of the Markdown content
|
|
content: String;
|
|
title: String?;
|
|
description: String?;
|
|
path: String;
|
|
// the path, split on '/'
|
|
components: Array<String>;
|
|
permalink: String;
|
|
extra: HashMap<String, Any>;
|
|
// Pages directly in this section. By default, the pages are not sorted. Please set the "sort_by"
|
|
// variable in the _index.md file of the corresponding section to "date" or "weight" for sorting by
|
|
// date and weight, respectively.
|
|
pages: Array<Page>;
|
|
// Direct subsections to this section, sorted by subsections weight
|
|
// This only contains the path to use in the `get_section` built-in function to get
|
|
// the actual section object if you need it
|
|
subsections: Array<String>;
|
|
toc: Array<Header>,
|
|
// Unicode word count
|
|
word_count: Number;
|
|
// Based on https://help.medium.com/hc/en-us/articles/214991667-Read-time
|
|
reading_time: Number;
|
|
// Paths of colocated assets, relative to the content directory
|
|
assets: Array<String>;
|
|
// The relative paths of the parent sections until the index one, for use with the `get_section` Tera function
|
|
// The first item is the index section and the last one is the parent section
|
|
// This is filled after rendering a page content so it will be empty in shortcodes
|
|
ancestors: Array<String>;
|
|
// The relative path from the `content` directory to the markdown file
|
|
relative_path: String;
|
|
// The language for the section if there is one. Default to the config `default_language`
|
|
lang: String;
|
|
// Information about all the available languages for that content
|
|
translations: Array<TranslatedContent>;
|
|
// All the pages/sections linking this page: their permalink and a title if there is one
|
|
backlinks: Array<{permalink: String, title: String?}>;
|
|
// Whether this section generates feeds or not. Taken from the front-matter if set
|
|
generate_feeds: bool;
|
|
// Whether this section is transparent. Taken from the front-matter if set
|
|
transparent: bool;
|
|
```
|
|
|
|
## Table of contents
|
|
|
|
Both page and section templates have a `toc` variable that corresponds to an array of `Header`.
|
|
A `Header` has the following fields:
|
|
|
|
```ts
|
|
// The hX level
|
|
level: 1 | 2 | 3 | 4 | 5 | 6;
|
|
// The generated slug id
|
|
id: String;
|
|
// The text of the header
|
|
title: String;
|
|
// A link pointing directly to the header, using the inserted anchor
|
|
permalink: String;
|
|
// All lower level headers below this header
|
|
children: Array<Header>;
|
|
```
|
|
|
|
## Translated content
|
|
|
|
Both pages and sections have a `translations` field that corresponds to an array of `TranslatedContent`. If your
|
|
site is not using multiple languages, this will always be an empty array.
|
|
`TranslatedContent` has the following fields:
|
|
|
|
```ts
|
|
// The language code for that content, empty if it is the default language
|
|
lang: String?;
|
|
// The title of that content if there is one
|
|
title: String?;
|
|
// A permalink to that content
|
|
permalink: String;
|
|
// The path to the markdown file; useful for retrieving the full page through
|
|
// the `get_page` function.
|
|
path: String;
|
|
```
|
|
|