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.1KB

7 years ago
7 years ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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. # the default language, used in RSS and coming i18n
  19. default_language = "en"
  20. # Theme name to use
  21. theme = ""
  22. # Highlight all code blocks found
  23. highlight_code = false
  24. # Which theme to use for the code highlighting.
  25. # See below for list of accepted values
  26. highlight_theme = "base16-ocean-dark"
  27. # Whether to generate a RSS feed automatically
  28. generate_rss = false
  29. # The number of articles to include in the RSS feed
  30. rss_limit = 20
  31. # Whether to generate a tags page and individual
  32. # tag pages for pages with tags
  33. generate_tags_pages = false
  34. # Whether to generate a categories page and individual
  35. # category pages for pages with a category
  36. generate_categories_pages = false
  37. # Whether to compile the Sass files found in the `sass` directory
  38. compile_sass = false
  39. # Optional translation object. The key if present should be a language code
  40. [translations]
  41. # You can put any kind of data in there and it
  42. # will be accessible in all templates
  43. [extra]
  44. ```
  45. ## Syntax highlighting
  46. Gutenberg currently has the following highlight themes available:
  47. - base16-ocean-dark
  48. - base16-ocean-light
  49. - gruvbox-dark
  50. - gruvbox-light
  51. - inspired-github
  52. - kronuz
  53. - material-dark
  54. - material-light
  55. - monokai
  56. - solarized-dark
  57. - solarized-light
  58. - 1337
  59. Gutenberg uses the Sublime Text themes, making it very easy to add more.
  60. 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).