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

7 years ago
7 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. +++
  2. title = "Configuration"
  3. weight = 4
  4. +++
  5. The default configuration is sufficient to get Zola running locally but not more than that.
  6. It follows the philosophy of paying for only what you need; almost everything is turned off by default.
  7. To change the configuration, 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. Only the `base_url` variable is mandatory; everything else is optional. All configuration variables
  10. used by Zola as well as their default values are listed below:
  11. ```toml
  12. # The base URL of the site; the only required configuration variable.
  13. base_url = "mywebsite.com"
  14. # The site title and description; used in RSS by default.
  15. title = ""
  16. description = ""
  17. # The default language; used in RSS.
  18. default_language = "en"
  19. # The site theme to use.
  20. theme = ""
  21. # When set to "true", all code blocks are highlighted.
  22. highlight_code = false
  23. # The theme to use for code highlighting.
  24. # See below for list of allowed values.
  25. highlight_theme = "base16-ocean-dark"
  26. # When set to "true", an RSS feed is automatically generated.
  27. generate_rss = false
  28. # The number of articles to include in the RSS feed. All items are included if
  29. # this limit is not set (the default).
  30. # rss_limit = 20
  31. # When set to "true", files in the `static` directory are hard-linked. Useful for large
  32. # static files. Note that for this to work, both `static` and the
  33. # output directory need to be on the same filesystem. Note that the theme's `static`
  34. # files are always copied, regardles of this setting.
  35. # hard_link_static = false
  36. # The taxonomies to be rendered for the site and their configuration.
  37. # Example:
  38. # taxonomies = [
  39. # {name = "tags", rss = true}, # each tag will have its own RSS feed
  40. # {name = "tags", lang = "fr"}, # you can have taxonomies with the same name in multiple languages
  41. # {name = "categories", paginate_by = 5}, # 5 items per page for a term
  42. # {name = "authors"}, # Basic definition: no RSS or pagination
  43. # ]
  44. #
  45. taxonomies = []
  46. # The additional languages for the site.
  47. # Example:
  48. # languages = [
  49. # {code = "fr", rss = true}, # there will be a RSS feed for French content
  50. # {code = "fr", search = true}, # there will be a Search Index for French content
  51. # {code = "it"}, # there won't be a RSS feed for Italian content
  52. # ]
  53. #
  54. languages = []
  55. # When set to "true", the Sass files in the `sass` directory are compiled.
  56. compile_sass = false
  57. # When set to "true", a search index is built from the pages and section
  58. # content for `default_language`.
  59. build_search_index = false
  60. # A list of glob patterns specifying asset files to ignore when the content
  61. # directory is processed. Defaults to none, which means that all asset files are
  62. # copied over to the `public` directory.
  63. # Example:
  64. # ignored_content = ["*.{graphml,xlsx}", "temp.*"]
  65. ignored_content = []
  66. # A list of directories used to search for additional `.sublime-syntax` files.
  67. extra_syntaxes = []
  68. <<<<<<< HEAD
  69. # Optional translation object. The key if present should be a language code.
  70. # Example:
  71. # default_language = "fr"
  72. #
  73. # [translations]
  74. # [translations.fr]
  75. # title = "Un titre"
  76. #
  77. # [translations.en]
  78. # title = "A title"
  79. # Configuration of the link checker.
  80. [link_checker]
  81. # Skip link checking for external URLs that start with these prefixes
  82. skip_prefixes = [
  83. "http://[2001:db8::]/",
  84. ]
  85. # Skip anchor checking for external URLs that start with these prefixes
  86. skip_anchor_prefixes = [
  87. "https://caniuse.com/",
  88. ]
  89. [extra]
  90. ```
  91. ## Syntax highlighting
  92. Zola currently has the following highlight themes available:
  93. - [1337](https://tmtheme-editor.herokuapp.com/#!/editor/theme/1337)
  94. - [agola-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark)
  95. - [ascetic-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Ascetic%20White)
  96. - [axar](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Axar)
  97. - [base16-ocean-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Base16%20Ocean%20Dark)
  98. - [base16-ocean-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Base16%20Ocean%20Light)
  99. - [bbedit](https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit)
  100. - [boron](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Boron)
  101. - [charcoal](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Charcoal)
  102. - [cheerfully-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Cheerfully%20Light)
  103. - [classic-modified](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Classic%20Modified)
  104. - [demain](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Demain)
  105. - [dimmed-fluid](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Dimmed%20Fluid)
  106. - [dracula](https://draculatheme.com/)
  107. - [gray-matter-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Gray%20Matter%20Dark)
  108. - [gruvbox-dark](https://github.com/morhetz/gruvbox)
  109. - [gruvbox-light](https://github.com/morhetz/gruvbox)
  110. - [idle](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IDLE)
  111. - [inspired-github](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Inspiredgithub)
  112. - [ir-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IR_White)
  113. - [kronuz](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Kronuz)
  114. - [material-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Material%20Dark)
  115. - [material-light](https://github.com/morhetz/gruvbox)
  116. - [monokai](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai)
  117. - [solarized-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(dark))
  118. - [solarized-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(light))
  119. - [subway-madrid](https://github.com/idleberg/Subway.tmTheme)
  120. - [subway-moscow](https://github.com/idleberg/Subway.tmTheme)
  121. - [visual-studio-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Visual%20Studio%20Dark)
  122. - [ayu-light](https://github.com/dempfi/ayu)
  123. - [ayu-dark](https://github.com/dempfi/ayu)
  124. - [ayu-mirage](https://github.com/dempfi/ayu)
  125. - [Tomorrow](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Tomorrow)
  126. - [one-dark](https://github.com/andresmichel/one-dark-theme)
  127. - [zenburn](https://github.com/colinta/zenburn)
  128. Zola uses the Sublime Text themes, making it very easy to add more.
  129. If you want a theme not listed above, please open an issue or a pull request on the [Zola repo](https://github.com/getzola/zola).