2017-09-12 07:13:26 +00:00
|
|
|
+++
|
|
|
|
title = "Configuration"
|
2017-09-27 14:37:17 +00:00
|
|
|
weight = 4
|
2017-09-12 07:13:26 +00:00
|
|
|
+++
|
|
|
|
|
2018-10-18 21:09:32 +00:00
|
|
|
The default configuration will be enough to get Zola running locally but not more than that.
|
2017-09-27 14:37:17 +00:00
|
|
|
It follows the philosophy of only paying for what you need: almost everything is turned off by default.
|
|
|
|
|
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
|
|
|
To change the config, edit the `config.toml` file.
|
2017-09-27 14:37:17 +00:00
|
|
|
If you are not familiar with TOML, have a look at [the TOML Spec](https://github.com/toml-lang/toml)
|
|
|
|
to learn about it.
|
|
|
|
|
|
|
|
Only one variable - `base_url` - is mandatory, everything else is optional. You can find all variables
|
2018-10-18 21:09:32 +00:00
|
|
|
used by Zola config as well as their default values below:
|
2017-09-27 14:37:17 +00:00
|
|
|
|
|
|
|
|
|
|
|
```toml
|
|
|
|
# Base URL of the site, the only required config argument
|
|
|
|
base_url = "mywebsite.com"
|
|
|
|
|
|
|
|
# Used in RSS by default
|
|
|
|
title = ""
|
|
|
|
description = ""
|
2018-12-28 12:24:49 +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
|
|
|
|
|
|
|
# Theme name to use
|
|
|
|
theme = ""
|
|
|
|
|
|
|
|
# Highlight all code blocks found
|
|
|
|
highlight_code = false
|
|
|
|
|
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
|
|
|
# Which theme to use for the code highlighting.
|
2017-10-03 15:21:18 +00:00
|
|
|
# See below for list of accepted values
|
2017-09-27 14:37:17 +00:00
|
|
|
highlight_theme = "base16-ocean-dark"
|
|
|
|
|
|
|
|
# Whether to generate a RSS feed automatically
|
|
|
|
generate_rss = false
|
|
|
|
|
2018-10-10 02:20:09 +00:00
|
|
|
# The number of articles to include in the RSS feed. Will include all items if
|
|
|
|
# not set (the default).
|
|
|
|
# rss_limit = 20
|
2017-09-27 14:37:17 +00:00
|
|
|
|
2019-07-10 21:37:19 +00:00
|
|
|
# Whether to copy or hardlink files in static/ directory. Useful for sites
|
|
|
|
# whose static files are large. Note that for this to work, both static/ and
|
|
|
|
# output directory need to be on the same filesystem. Also, theme's static/
|
|
|
|
# files are always copies, regardles of this setting. False by default.
|
|
|
|
# hard_link_static = false
|
|
|
|
|
2018-07-16 08:54:05 +00:00
|
|
|
# The taxonomies to be rendered for that site and their configuration
|
|
|
|
# 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
|
|
|
|
2018-12-28 12:24:49 +00:00
|
|
|
# The additional languages for that site
|
|
|
|
# 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 = []
|
|
|
|
|
2017-09-27 14:37:17 +00:00
|
|
|
# Whether to compile the Sass files found in the `sass` directory
|
|
|
|
compile_sass = false
|
|
|
|
|
2018-03-21 15:18:24 +00:00
|
|
|
# Whether to build a search index out of the pages and section
|
|
|
|
# content for the `default_language`
|
|
|
|
build_search_index = false
|
|
|
|
|
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
|
|
|
# A list of glob patterns specifying asset files to ignore when
|
2018-04-02 00:33:59 +00:00
|
|
|
# processing the content directory.
|
2018-03-01 09:31:51 +00:00
|
|
|
# Defaults to none, which means all asset files are copied over to the public folder.
|
|
|
|
# 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 = []
|
|
|
|
|
2018-08-14 14:54:24 +00:00
|
|
|
# A list of directories to search for additional `.sublime-syntax` files in.
|
|
|
|
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"
|
|
|
|
#
|
2018-01-16 12:57:31 +00:00
|
|
|
[translations]
|
|
|
|
|
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
|
|
|
# You can put any kind of data in there and it
|
2017-10-03 15:21:18 +00:00
|
|
|
# will be accessible in all templates
|
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)
|
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.
|
|
|
|
If you want a theme not on that list, please open an issue or a pull request on the [Zola repo](https://github.com/getzola/zola).
|