Zola Configuration
A fast static site generator in a single binary with everything built-in
| Type | object |
|---|---|
| File match |
zola.toml
|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/zola-configuration/latest.json |
| Source | https://cscnk52.github.io/json-schemas/zola.schema.json |
Validate with Lintel
npx @lintel/lintel checkProperties
Base URL of the site, the only required config argument
Theme to use
Title of the site. Defaults to None
Description of the site
The language used in the site. Defaults to "en"
The translations strings for the default language
{}Whether to generate feeds. Defaults to false.
The number of articles to include in the feed. Defaults to including all items.
The filenames to use for feeds. Used to find the templates, too. Defaults to ["atom.xml"], with "rss.xml" also having a template provided out of the box.
[
"atom.xml"
]If set, files from static/ will be hardlinked instead of copied to the output dir.
[]The default author for pages.
Whether to compile the sass directory and output the css files into the static folder
Whether to minify the html output
Whether to build the search index for the content
A list of file glob patterns to ignore when processing the content folder. Defaults to none. Had to remove the PartialEq derive because GlobSet does not implement it. No impact because it's unused anyway (who wants to sort Configs?).
[]A list of file glob patterns to ignore when processing the static folder. Defaults to none.
[]Whether dotfiles inside the output directory are preserved when rebuilding the site
4 nested properties
7 nested properties
Include the title of the page in the search index. true by default.
Includes the whole content in the search index. Ok for small sites but becomes
too big on large sites. true by default.
Optionally truncate the content down to n code points. This might cut content in a word
Includes the description in the search index. When the site becomes too large, you can switch
to that instead. false by default
Include the RFC3339 datetime of the page in the search index. false by default.
Include the path of the page in the search index. false by default.
16 nested properties
Whether to highlight all code blocks found in markdown files. Defaults to false
Emit an error for missing highlight languages. Defaults to false
Which themes to use for code highlighting. See Readme for supported themes Defaults to "base16-ocean-dark"
Whether to render emoji aliases (e.g.: :smile: => 😄) in the markdown files
CSS class to add to external links
Whether external links are to be opened in a new tab
If this is true, a rel="noopener" will always automatically be added for security reasons
Whether to set rel="nofollow" for all external links
Whether to set rel="noreferrer" for all external links
Whether smart punctuation is enabled (changing quotes, dashes, dots etc in their typographic form)
Whether parsing of definition lists is enabled
Whether footnotes are rendered at the bottom in the style of GitHub.
A list of directories to search for additional .sublime-syntax and .tmTheme files in.
[]Add loading="lazy" decoding="async" to img tags. When turned on, the alt text must be plain text. Defaults to false
Whether to enable GitHub-style alerts
All user params set in [extra] in the config
{}Enables the generation of Sitemap.xml
Enables the generation of robots.txt
Definitions
Title of the site. Defaults to None
Description of the site. Defaults to None
Whether to generate feeds for that language, defaults to false
The filenames to use for feeds. Used to find the templates, too. Defaults to ["atom.xml"], with "rss.xml" also having a template provided out of the box.
[
"atom.xml"
][]Whether to generate search index for that language, defaults to false
7 nested properties
Include the title of the page in the search index. true by default.
Includes the whole content in the search index. Ok for small sites but becomes
too big on large sites. true by default.
Optionally truncate the content down to n code points. This might cut content in a word
Includes the description in the search index. When the site becomes too large, you can switch
to that instead. false by default
Include the RFC3339 datetime of the page in the search index. false by default.
Include the path of the page in the search index. false by default.
A toml crate Table with String key representing term and value
another String representing its translation.
Use get_translation() method for translating key into different languages.
{}The name used in the URL, usually the plural
The slug according to the config slugification strategy
If this is set, the list of individual taxonomy term page will be paginated by this much
Whether the taxonomy will be rendered, defaults to true
Whether to generate a feed only for each taxonomy term, defaults to false
Include the title of the page in the search index. true by default.
Includes the whole content in the search index. Ok for small sites but becomes
too big on large sites. true by default.
Optionally truncate the content down to n code points. This might cut content in a word
Includes the description in the search index. When the site becomes too large, you can switch
to that instead. false by default
Include the RFC3339 datetime of the page in the search index. false by default.
Include the path of the page in the search index. false by default.
Whether to highlight all code blocks found in markdown files. Defaults to false
Emit an error for missing highlight languages. Defaults to false
Which themes to use for code highlighting. See Readme for supported themes Defaults to "base16-ocean-dark"
Whether to render emoji aliases (e.g.: :smile: => 😄) in the markdown files
CSS class to add to external links
Whether external links are to be opened in a new tab
If this is true, a rel="noopener" will always automatically be added for security reasons
Whether to set rel="nofollow" for all external links
Whether to set rel="noreferrer" for all external links
Whether smart punctuation is enabled (changing quotes, dashes, dots etc in their typographic form)
Whether parsing of definition lists is enabled
Whether footnotes are rendered at the bottom in the style of GitHub.
A list of directories to search for additional .sublime-syntax and .tmTheme files in.
[]Add loading="lazy" decoding="async" to img tags. When turned on, the alt text must be plain text. Defaults to false
Whether to enable GitHub-style alerts
Which theme are we generating the CSS from
In which file are we going to output the CSS