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
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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.
  24. # See below for list of accepted values
  25. highlight_theme = "base16-ocean-dark"
  26. # Whether to generate a RSS feed automatically
  27. generate_rss = false
  28. # The number of articles to include in the RSS feed
  29. rss_limit = 20
  30. # Whether to generate a tags page and individual
  31. # tag pages for pages with tags
  32. generate_tags_pages = false
  33. # Whether to generate a categories page and individual
  34. # category pages for pages with a category
  35. generate_categories_pages = false
  36. # Whether to compile the Sass files found in the `sass` directory
  37. compile_sass = false
  38. # You can put any kind of data in there and it
  39. # will be accessible in all templates
  40. [extra]
  41. ```
  42. ## Syntax highlighting
  43. Gutenberg currently has the following highlight themes available:
  44. - base16-ocean-dark
  45. - base16-ocean-light
  46. - gruvbox-dark
  47. - gruvbox-light
  48. - inspired-github
  49. - kronuz
  50. - material-dark
  51. - material-light
  52. - monokai
  53. - solarized-dark
  54. - solarized-light
  55. - 1337
  56. Gutenberg uses the Sublime Text themes, making it very easy to add more.
  57. 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).