4.4 KiB
+++ 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
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:
# 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: 5}, # 5 terms per page
# ]
#
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
# 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 = []
# 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
- agola-dark
- ascetic-white
- axar
- base16-ocean-dark
- base16-ocean-light
- bbedit
- boron
- charcoal
- cheerfully-light
- classic-modified
- demain
- dimmed-fluid
- 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
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.