2017-09-12 07:13:26 +00:00
|
|
|
+++
|
|
|
|
title = "Configuration"
|
2020-01-20 03:02:05 +00:00
|
|
|
weight = 40
|
2017-09-12 07:13:26 +00:00
|
|
|
+++
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
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.
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
To change the configuration, edit the `config.toml` file.
|
|
|
|
If you are not familiar with TOML, have a look at [the TOML spec](https://github.com/toml-lang/toml).
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
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:
|
2017-09-27 14:37:17 +00:00
|
|
|
|
|
|
|
|
|
|
|
```toml
|
2019-11-26 19:30:30 +00:00
|
|
|
# The base URL of the site; the only required configuration variable.
|
2017-09-27 14:37:17 +00:00
|
|
|
base_url = "mywebsite.com"
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# The site title and description; used in RSS by default.
|
2017-09-27 14:37:17 +00:00
|
|
|
title = ""
|
|
|
|
description = ""
|
2019-11-26 19:30:30 +00:00
|
|
|
|
|
|
|
# The default language; used in RSS.
|
2018-01-16 12:57:31 +00:00
|
|
|
default_language = "en"
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# The site theme to use.
|
2017-09-27 14:37:17 +00:00
|
|
|
theme = ""
|
|
|
|
|
2019-12-21 09:44:13 +00:00
|
|
|
# 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
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# When set to "true", all code blocks are highlighted.
|
2017-09-27 14:37:17 +00:00
|
|
|
highlight_code = false
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# The theme to use for code highlighting.
|
|
|
|
# See below for list of allowed values.
|
2017-09-27 14:37:17 +00:00
|
|
|
highlight_theme = "base16-ocean-dark"
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# When set to "true", an RSS feed is automatically generated.
|
2017-09-27 14:37:17 +00:00
|
|
|
generate_rss = false
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# The number of articles to include in the RSS feed. All items are included if
|
|
|
|
# this limit is not set (the default).
|
2018-10-10 02:20:09 +00:00
|
|
|
# rss_limit = 20
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# 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.
|
2019-07-10 21:37:19 +00:00
|
|
|
# hard_link_static = false
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# The taxonomies to be rendered for the site and their configuration.
|
2018-07-16 08:54:05 +00:00
|
|
|
# Example:
|
|
|
|
# taxonomies = [
|
2018-08-29 22:55:49 +00:00
|
|
|
# {name = "tags", rss = true}, # each tag will have its own RSS feed
|
2019-08-10 16:53:16 +00:00
|
|
|
# {name = "tags", lang = "fr"}, # you can have taxonomies with the same name in multiple languages
|
2018-08-29 22:55:49 +00:00
|
|
|
# {name = "categories", paginate_by = 5}, # 5 items per page for a term
|
|
|
|
# {name = "authors"}, # Basic definition: no RSS or pagination
|
2018-07-16 08:54:05 +00:00
|
|
|
# ]
|
|
|
|
#
|
|
|
|
taxonomies = []
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# The additional languages for the site.
|
2018-12-28 12:24:49 +00:00
|
|
|
# Example:
|
|
|
|
# languages = [
|
|
|
|
# {code = "fr", rss = true}, # there will be a RSS feed for French content
|
2019-09-03 14:50:23 +00:00
|
|
|
# {code = "fr", search = true}, # there will be a Search Index for French content
|
2018-12-28 12:24:49 +00:00
|
|
|
# {code = "it"}, # there won't be a RSS feed for Italian content
|
|
|
|
# ]
|
|
|
|
#
|
|
|
|
languages = []
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# When set to "true", the Sass files in the `sass` directory are compiled.
|
2017-09-27 14:37:17 +00:00
|
|
|
compile_sass = false
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# When set to "true", a search index is built from the pages and section
|
|
|
|
# content for `default_language`.
|
2018-03-21 15:18:24 +00:00
|
|
|
build_search_index = false
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# 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.
|
2018-03-01 09:31:51 +00:00
|
|
|
# Example:
|
Filter ignored content in page.rs.
* Add ignored_content to the Config structure.
* Use the GlobSet crate to parse the glob patterns into a matcher, which
is created once at program initialization. If there are no patterns in
ignored_content, an empty globber is created, which excludes no files.
This is consistent with the existing behaviour of Gutenberg, before
this feature was added.
* Bail if there are any errors in the glob patterns.
* Add a call to the globber in page.rs to actually do the filtering.
* Update documentation.
A note on the Config structure
------------------------------
* I had to remove the PartialEq derive from the Config structure as it
does not work for the GlobSet type. No harm is done, Config does not
need to be PartialEq anyway, since there is no need to sort Configs.
* The implementation follows the pattern of the existing config settings
in that it uses an Option<...>. This would appear unnecessary, in that
an empty vec could be used as the default, but it appears to be needed
by the TOML parsing. A better approach would be to use a separate
SerializableConfig and map to/from a Config struct. This would also
allow the elimination of most, if not all, of the other Options in
the Config structure, but that ought to be another PR.
2018-02-25 11:42:31 +00:00
|
|
|
# ignored_content = ["*.{graphml,xlsx}", "temp.*"]
|
|
|
|
ignored_content = []
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# A list of directories used to search for additional `.sublime-syntax` files.
|
2018-08-14 14:54:24 +00:00
|
|
|
extra_syntaxes = []
|
|
|
|
|
2019-11-28 18:18:52 +00:00
|
|
|
# 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"
|
2019-10-14 16:31:03 +00:00
|
|
|
|
|
|
|
|
2019-11-26 19:30:30 +00:00
|
|
|
# Configuration of the link checker.
|
2019-10-14 16:31:03 +00:00
|
|
|
[link_checker]
|
2019-11-25 11:13:02 +00:00
|
|
|
# Skip link checking for external URLs that start with these prefixes
|
|
|
|
skip_prefixes = [
|
|
|
|
"http://[2001:db8::]/",
|
|
|
|
]
|
|
|
|
|
2019-10-14 16:31:03 +00:00
|
|
|
# Skip anchor checking for external URLs that start with these prefixes
|
|
|
|
skip_anchor_prefixes = [
|
|
|
|
"https://caniuse.com/",
|
|
|
|
]
|
2018-01-16 12:57:31 +00:00
|
|
|
|
2017-09-27 14:37:17 +00:00
|
|
|
[extra]
|
|
|
|
```
|
|
|
|
|
|
|
|
## Syntax highlighting
|
|
|
|
|
2018-10-18 21:09:32 +00:00
|
|
|
Zola currently has the following highlight themes available:
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2018-04-02 00:33:59 +00:00
|
|
|
- [1337](https://tmtheme-editor.herokuapp.com/#!/editor/theme/1337)
|
|
|
|
- [agola-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark)
|
|
|
|
- [ascetic-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Ascetic%20White)
|
|
|
|
- [axar](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Axar)
|
2019-06-17 08:08:05 +00:00
|
|
|
- [base16-ocean-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Base16%20Ocean%20Dark)
|
|
|
|
- [base16-ocean-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Base16%20Ocean%20Light)
|
2018-04-02 00:33:59 +00:00
|
|
|
- [bbedit](https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit)
|
|
|
|
- [boron](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Boron)
|
|
|
|
- [charcoal](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Charcoal)
|
|
|
|
- [cheerfully-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Cheerfully%20Light)
|
|
|
|
- [classic-modified](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Classic%20Modified)
|
|
|
|
- [demain](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Demain)
|
|
|
|
- [dimmed-fluid](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Dimmed%20Fluid)
|
2019-01-15 22:20:47 +00:00
|
|
|
- [dracula](https://draculatheme.com/)
|
2018-04-02 00:33:59 +00:00
|
|
|
- [gray-matter-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Gray%20Matter%20Dark)
|
|
|
|
- [gruvbox-dark](https://github.com/morhetz/gruvbox)
|
|
|
|
- [gruvbox-light](https://github.com/morhetz/gruvbox)
|
|
|
|
- [idle](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IDLE)
|
|
|
|
- [inspired-github](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Inspiredgithub)
|
|
|
|
- [ir-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IR_White)
|
|
|
|
- [kronuz](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Kronuz)
|
|
|
|
- [material-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Material%20Dark)
|
|
|
|
- [material-light](https://github.com/morhetz/gruvbox)
|
|
|
|
- [monokai](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai)
|
|
|
|
- [solarized-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(dark))
|
|
|
|
- [solarized-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(light))
|
|
|
|
- [subway-madrid](https://github.com/idleberg/Subway.tmTheme)
|
|
|
|
- [subway-moscow](https://github.com/idleberg/Subway.tmTheme)
|
|
|
|
- [visual-studio-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Visual%20Studio%20Dark)
|
2018-10-26 18:04:56 +00:00
|
|
|
- [ayu-light](https://github.com/dempfi/ayu)
|
|
|
|
- [ayu-dark](https://github.com/dempfi/ayu)
|
|
|
|
- [ayu-mirage](https://github.com/dempfi/ayu)
|
2019-07-16 15:22:02 +00:00
|
|
|
- [Tomorrow](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Tomorrow)
|
2019-08-24 17:06:41 +00:00
|
|
|
- [one-dark](https://github.com/andresmichel/one-dark-theme)
|
2019-10-08 19:31:23 +00:00
|
|
|
- [zenburn](https://github.com/colinta/zenburn)
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2018-10-18 21:09:32 +00:00
|
|
|
Zola uses the Sublime Text themes, making it very easy to add more.
|
2019-11-26 19:30:30 +00:00
|
|
|
If you want a theme not listed above, please open an issue or a pull request on the [Zola repo](https://github.com/getzola/zola).
|