119 lines
4.8 KiB
Markdown
119 lines
4.8 KiB
Markdown
+++
|
|
title = "Configuration"
|
|
weight = 4
|
|
+++
|
|
|
|
The default configuration will be enough to get Gutenberg running locally but not more than that.
|
|
It follows the philosophy of only paying for what you need: almost everything is turned off by default.
|
|
|
|
To change the config, 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)
|
|
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 = ""
|
|
# the default language, used in RSS and coming i18n
|
|
default_language = "en"
|
|
|
|
# Theme name to use
|
|
theme = ""
|
|
|
|
# Highlight all code blocks found
|
|
highlight_code = false
|
|
|
|
# Which theme to use for the code highlighting.
|
|
# See below for list of accepted values
|
|
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
|
|
|
|
# The taxonomies to be rendered for that site and their configuration
|
|
# Example:
|
|
# taxonomies = [
|
|
# {name = "tags", rss = true}, # each tag will have its own RSS feed
|
|
# {name = "categories", paginate_by = 5}, # 5 items per page for a term
|
|
# {name = "authors"}, # Basic definition: no RSS or pagination
|
|
# ]
|
|
#
|
|
taxonomies = []
|
|
|
|
# Whether to compile the Sass files found in the `sass` directory
|
|
compile_sass = false
|
|
|
|
# Whether to build a search index out of the pages and section
|
|
# content for the `default_language`
|
|
build_search_index = false
|
|
|
|
# Go through every links in all content and check if the links are valid
|
|
# If a link is invalid (404, 500, etc), the build will error.
|
|
# Link checking can take a very long time if you have many links so this should
|
|
# only enabled once in a while to catch any dead links.
|
|
check_external_links = false
|
|
|
|
# A list of glob patterns specifying asset files to ignore when
|
|
# processing the content directory.
|
|
# Defaults to none, which means all asset files are copied over to the public folder.
|
|
# Example:
|
|
# ignored_content = ["*.{graphml,xlsx}", "temp.*"]
|
|
ignored_content = []
|
|
|
|
# A list of directories to search for additional `.sublime-syntax` files in.
|
|
extra_syntaxes = []
|
|
|
|
# Optional translation object. The key if present should be a language code
|
|
[translations]
|
|
|
|
# You can put any kind of data in there and it
|
|
# will be accessible in all templates
|
|
[extra]
|
|
```
|
|
|
|
## Syntax highlighting
|
|
|
|
Gutenberg currently has the following highlight themes available:
|
|
|
|
- [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)
|
|
- base16-ocean-dark
|
|
- 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)
|
|
|
|
Gutenberg 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 [Gutenberg repo](https://github.com/Keats/gutenberg).
|