emelie/zola
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
zola/docs/content/documentation/getting-started/configuration.md

108 lines
4.3 KiB
Markdown
Raw Normal View History

WIP docs
2017-09-12 07:13:26 +00:00
+++
title = "Configuration"
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
weight = 4
WIP docs
2017-09-12 07:13:26 +00:00
+++
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
The default configuration will be enough to get Gutenberg running locally but not more than that.
Working on site And some tweaks as I write the docs
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.
Working on site And some tweaks as I write the docs
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
used by Gutenberg config as well as their default values below:
```toml
# Base URL of the site, the only required config argument
base_url = "mywebsite.com"
# Used in RSS by default
title = ""
description = ""
Update docs about trans
2018-01-16 12:57:31 +00:00
# the default language, used in RSS and coming i18n
default_language = "en"
Working on site And some tweaks as I write the docs
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.
Some design work on docs
2017-10-03 15:21:18 +00:00
# See below for list of accepted values
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
highlight_theme = "base16-ocean-dark"
# Whether to generate a RSS feed automatically
generate_rss = false
# The number of articles to include in the RSS feed
rss_limit = 20
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
# Whether to generate a tags page and individual
Some design work on docs
2017-10-03 15:21:18 +00:00
# tag pages for pages with tags
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
generate_tags_pages = 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
# Whether to generate a categories page and individual
Some design work on docs
2017-10-03 15:21:18 +00:00
# category pages for pages with a category
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
generate_categories_pages = false
# Whether to compile the Sass files found in the `sass` directory
compile_sass = false
Write some docs
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
Update list of themes
2018-03-01 09:31:51 +00:00
# processing the content directory.
# 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 = []
Update docs about trans
2018-01-16 12:57:31 +00:00
# Optional translation object. The key if present should be a language code
[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
Some design work on docs
2017-10-03 15:21:18 +00:00
# will be accessible in all templates
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
[extra]
```
## Syntax highlighting
Gutenberg currently has the following highlight themes available:
Update list of themes
2018-03-01 09:31:51 +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
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
- base16-ocean-dark
Update list of themes
2018-03-01 09:31:51 +00:00
- base16-ocean-light
- 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
- 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
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
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
Gutenberg uses the Sublime Text themes, making it very easy to add more.
Working on site And some tweaks as I write the docs
2017-09-27 14:37:17 +00:00
If you want a theme not on that list, please open an issue or a pull request on the [Gutenberg repo](https://github.com/Keats/gutenberg).
Reference in a new issue Copy permalink