You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

configuration.md 2.0KB

7 years ago
7 years ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. +++
  2. title = "Configuration"
  3. weight = 4
  4. +++
  5. The default configuration will be enough to get Gutenberg running locally but not more than that.
  6. It follows the philosophy of only paying for what you need: almost everything is turned off by default.
  7. To change the config, edit the `config.toml` file.
  8. If you are not familiar with TOML, have a look at [the TOML Spec](https://github.com/toml-lang/toml)
  9. to learn about it.
  10. Only one variable - `base_url` - is mandatory, everything else is optional. You can find all variables
  11. used by Gutenberg config as well as their default values below:
  12. ```toml
  13. # Base URL of the site, the only required config argument
  14. base_url = "mywebsite.com"
  15. # Used in RSS by default
  16. title = ""
  17. description = ""
  18. language_code = "en"
  19. # Theme name to use
  20. theme = ""
  21. # Highlight all code blocks found
  22. highlight_code = false
  23. # Which theme to use for the code highlighting. See below for list of accepted values
  24. highlight_theme = "base16-ocean-dark"
  25. # Whether to generate a RSS feed automatically
  26. generate_rss = false
  27. # The number of articles to include in the RSS feed
  28. rss_limit = 20
  29. # Whether to generate a tags page and individual tag pages for pages with tags
  30. generate_tags_pages = false
  31. # Whether to generate a categories page and individual category pages for pages with a category
  32. generate_categories_pages = false
  33. # Whether to compile the Sass files found in the `sass` directory
  34. compile_sass = false
  35. # You can put any kind of data in there and it will be accessible in all templates
  36. [extra]
  37. ```
  38. ## Syntax highlighting
  39. Gutenberg currently has the following highlight themes available:
  40. - base16-ocean-dark
  41. - base16-ocean-light
  42. - gruvbox-dark
  43. - gruvbox-light
  44. - inspired-github
  45. - kronuz
  46. - material-dark
  47. - material-light
  48. - monokai
  49. - solarized-dark
  50. - solarized-light
  51. Gutenberg uses the Sublime Text themes, making it very easy to add more.
  52. 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).