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

7 years ago
7 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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. # The taxonomies to be rendered for that site and their configuration
  32. # Example:
  33. # taxonomies = [
  34. # {name = "tags", rss = true}, # each tag will have its own RSS feed
  35. # {name = "categories", paginate_by = 5}, # 5 items per page for a term
  36. # {name = "authors"}, # Basic definition: no RSS or pagination
  37. # ]
  38. #
  39. taxonomies = []
  40. # Whether to compile the Sass files found in the `sass` directory
  41. compile_sass = false
  42. # Whether to build a search index out of the pages and section
  43. # content for the `default_language`
  44. build_search_index = false
  45. # Go through every links in all content and check if the links are valid
  46. # If a link is invalid (404, 500, etc), the build will error.
  47. # Link checking can take a very long time if you have many links so this should
  48. # only enabled once in a while to catch any dead links.
  49. check_external_links = false
  50. # A list of glob patterns specifying asset files to ignore when
  51. # processing the content directory.
  52. # Defaults to none, which means all asset files are copied over to the public folder.
  53. # Example:
  54. # ignored_content = ["*.{graphml,xlsx}", "temp.*"]
  55. ignored_content = []
  56. # A list of directories to search for additional `.sublime-syntax` files in.
  57. extra_syntaxes = []
  58. # Optional translation object. The key if present should be a language code
  59. [translations]
  60. # You can put any kind of data in there and it
  61. # will be accessible in all templates
  62. [extra]
  63. ```
  64. ## Syntax highlighting
  65. Gutenberg currently has the following highlight themes available:
  66. - [1337](https://tmtheme-editor.herokuapp.com/#!/editor/theme/1337)
  67. - [agola-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark)
  68. - [ascetic-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Ascetic%20White)
  69. - [axar](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Axar)
  70. - base16-ocean-dark
  71. - base16-ocean-light
  72. - [bbedit](https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit)
  73. - [boron](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Boron)
  74. - [charcoal](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Charcoal)
  75. - [cheerfully-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Cheerfully%20Light)
  76. - [classic-modified](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Classic%20Modified)
  77. - [demain](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Demain)
  78. - [dimmed-fluid](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Dimmed%20Fluid)
  79. - [gray-matter-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Gray%20Matter%20Dark)
  80. - [gruvbox-dark](https://github.com/morhetz/gruvbox)
  81. - [gruvbox-light](https://github.com/morhetz/gruvbox)
  82. - [idle](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IDLE)
  83. - [inspired-github](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Inspiredgithub)
  84. - [ir-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IR_White)
  85. - [kronuz](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Kronuz)
  86. - [material-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Material%20Dark)
  87. - [material-light](https://github.com/morhetz/gruvbox)
  88. - [monokai](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai)
  89. - [solarized-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(dark))
  90. - [solarized-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(light))
  91. - [subway-madrid](https://github.com/idleberg/Subway.tmTheme)
  92. - [subway-moscow](https://github.com/idleberg/Subway.tmTheme)
  93. - [visual-studio-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Visual%20Studio%20Dark)
  94. Gutenberg uses the Sublime Text themes, making it very easy to add more.
  95. 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).