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 4.3KB

7 years ago
7 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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. # Whether to build a search index out of the pages and section
  40. # content for the `default_language`
  41. build_search_index = false
  42. # A list of glob patterns specifying asset files to ignore when
  43. # processing the content directory.
  44. # Defaults to none, which means all asset files are copied over to the public folder.
  45. # Example:
  46. # ignored_content = ["*.{graphml,xlsx}", "temp.*"]
  47. ignored_content = []
  48. # Optional translation object. The key if present should be a language code
  49. [translations]
  50. # You can put any kind of data in there and it
  51. # will be accessible in all templates
  52. [extra]
  53. ```
  54. ## Syntax highlighting
  55. Gutenberg currently has the following highlight themes available:
  56. - 1337: https://tmtheme-editor.herokuapp.com/#!/editor/theme/1337
  57. - agola-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark
  58. - ascetic-white: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Ascetic%20White
  59. - axar: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Axar
  60. - base16-ocean-dark
  61. - base16-ocean-light
  62. - bbedit: https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit
  63. - boron: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Boron
  64. - charcoal: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Charcoal
  65. - cheerfully-light: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Cheerfully%20Light
  66. - classic-modified: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Classic%20Modified
  67. - demain: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Demain
  68. - dimmed-fluid: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Dimmed%20Fluid
  69. - gray-matter-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Gray%20Matter%20Dark
  70. - gruvbox-dark: https://github.com/morhetz/gruvbox
  71. - gruvbox-light: https://github.com/morhetz/gruvbox
  72. - idle: https://tmtheme-editor.herokuapp.com/#!/editor/theme/IDLE
  73. - inspired-github: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Inspiredgithub
  74. - ir-white: https://tmtheme-editor.herokuapp.com/#!/editor/theme/IR_White
  75. - kronuz: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Kronuz
  76. - material-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Material%20Dark
  77. - material-light: https://github.com/morhetz/gruvbox
  78. - monokai: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai
  79. - solarized-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(dark)
  80. - solarized-light: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(light)
  81. - subway-madrid: https://github.com/idleberg/Subway.tmTheme
  82. - subway-moscow: https://github.com/idleberg/Subway.tmTheme
  83. - visual-studio-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Visual%20Studio%20Dark
  84. Gutenberg uses the Sublime Text themes, making it very easy to add more.
  85. 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).