* maybe_slugify() only does simple sanitation if config.slugify is false * slugify is disabled by default, turn on for backwards-compatibility * First docs changes for optional slugification * Remove # from slugs but not & * Add/fix tests for utf8 slugs * Fix test sites for i18n slugs * fix templates tests for i18n slugs * Rename slugify setting to slugify_paths * Default slugify_paths * Update documentation for slugify_paths * quasi_slugify removes ?, /, # and newlines * Remove forbidden NTFS chars in quasi_slugify() * Slugification forbidden chars can be configured * Remove trailing dot/space in quasi_slugify * Fix NTFS path sanitation * Revert configurable slugification charset * Remove \r for windows newlines and \t tabulations in quasi_slugify() * Update docs for output paths * Replace slugify with slugify_paths * Fix test * Default to not slugifying * Move slugs utils to utils crate * Use slugify_paths for anchors as well
6.4 KiB
6.4 KiB
+++ title = "Configuration" weight = 4 +++
The default configuration is sufficient to get Zola running locally but not more than that. It follows the philosophy of paying for only what you need; almost everything is turned off by default.
To change the configuration, edit the config.toml
file.
If you are not familiar with TOML, have a look at the TOML spec.
Only the base_url
variable is mandatory; everything else is optional. All configuration variables
used by Zola as well as their default values are listed below:
# The base URL of the site; the only required configuration variable.
base_url = "mywebsite.com"
# The site title and description; used in RSS by default.
title = ""
description = ""
# The default language; used in RSS.
default_language = "en"
# The site theme to use.
theme = ""
# Slugify paths for compatibility with ASCII-only URLs produced by Zola < 0.9
# Enabling this setting removes non-English (UTF8) characters in URLs
slugify_paths = false
# When set to "true", all code blocks are highlighted.
highlight_code = false
# The theme to use for code highlighting.
# See below for list of allowed values.
highlight_theme = "base16-ocean-dark"
# When set to "true", an RSS feed is automatically generated.
generate_rss = false
# The number of articles to include in the RSS feed. All items are included if
# this limit is not set (the default).
# rss_limit = 20
# When set to "true", files in the `static` directory are hard-linked. Useful for large
# static files. Note that for this to work, both `static` and the
# output directory need to be on the same filesystem. Note that the theme's `static`
# files are always copied, regardles of this setting.
# hard_link_static = false
# The taxonomies to be rendered for the site and their configuration.
# Example:
# taxonomies = [
# {name = "tags", rss = true}, # each tag will have its own RSS feed
# {name = "tags", lang = "fr"}, # you can have taxonomies with the same name in multiple languages
# {name = "categories", paginate_by = 5}, # 5 items per page for a term
# {name = "authors"}, # Basic definition: no RSS or pagination
# ]
#
taxonomies = []
# The additional languages for the site.
# Example:
# languages = [
# {code = "fr", rss = true}, # there will be a RSS feed for French content
# {code = "fr", search = true}, # there will be a Search Index for French content
# {code = "it"}, # there won't be a RSS feed for Italian content
# ]
#
languages = []
# When set to "true", the Sass files in the `sass` directory are compiled.
compile_sass = false
# When set to "true", a search index is built from the pages and section
# content for `default_language`.
build_search_index = false
# A list of glob patterns specifying asset files to ignore when the content
# directory is processed. Defaults to none, which means that all asset files are
# copied over to the `public` directory.
# Example:
# ignored_content = ["*.{graphml,xlsx}", "temp.*"]
ignored_content = []
# A list of directories used to search for additional `.sublime-syntax` files.
extra_syntaxes = []
<<<<<<< HEAD
# Optional translation object. The key if present should be a language code.
# Example:
# default_language = "fr"
#
# [translations]
# [translations.fr]
# title = "Un titre"
#
# [translations.en]
# title = "A title"
# Configuration of the link checker.
[link_checker]
# Skip link checking for external URLs that start with these prefixes
skip_prefixes = [
"http://[2001:db8::]/",
]
# Skip anchor checking for external URLs that start with these prefixes
skip_anchor_prefixes = [
"https://caniuse.com/",
]
[extra]
Syntax highlighting
Zola currently has the following highlight themes available:
- 1337
- agola-dark
- ascetic-white
- axar
- base16-ocean-dark
- base16-ocean-light
- bbedit
- boron
- charcoal
- cheerfully-light
- classic-modified
- demain
- dimmed-fluid
- dracula
- gray-matter-dark
- gruvbox-dark
- gruvbox-light
- idle
- inspired-github
- ir-white
- kronuz
- material-dark
- material-light
- monokai
- solarized-dark
- solarized-light
- subway-madrid
- subway-moscow
- visual-studio-dark
- ayu-light
- ayu-dark
- ayu-mirage
- Tomorrow
- one-dark
- zenburn
Zola uses the Sublime Text themes, making it very easy to add more. If you want a theme not listed above, please open an issue or a pull request on the Zola repo.