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.

overview.md 8.3KB

6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231
  1. +++
  2. title = "Overview"
  3. weight = 10
  4. +++
  5. Zola uses the [Tera](https://tera.netlify.com) template engine and is very similar
  6. to Jinja2, Liquid or Twig.
  7. As this documentation will only talk about how templates work in Zola, please read
  8. the [Tera template documentation](https://tera.netlify.com/docs/templates/) if you want
  9. to learn more about it first.
  10. All templates live in the `templates` directory. If you are not sure what variables are available in a template, you can just stick `{{ __tera_context }}` in it
  11. to print the whole context.
  12. A few variables are available on all templates minus RSS and sitemap:
  13. - `config`: the [configuration](./documentation/getting-started/configuration.md) without any modifications
  14. - `current_path`: the path (full URL without the `base_url`) of the current page, never starting with a `/`
  15. - `current_url`: the full URL for that page
  16. - `lang`: the language for that page, `null` if the page/section doesn't have a language set
  17. ## Standard Templates
  18. By default, Zola will look for three templates: `index.html`, which is applied
  19. to the site homepage; `section.html`, which is applied to all sections (any HTML
  20. page generated by creating a directory within your `content` directory); and
  21. `page.html`, which is applied to all pages (any HTML page generated by creating a
  22. `.md` file within your `content` directory).
  23. The homepage is always a section (regardless of whether it contains other pages).
  24. Thus, the `index.html` and `section.html` templates both have access to the
  25. section variables. The `page.html` template has access to the page variables.
  26. The page and section variables are described in more detail in the next section of this documentation.
  27. ## Built-in Templates
  28. Zola comes with three built-in templates: `rss.xml`, `sitemap.xml`, and
  29. `robots.txt` (each described in their own section of this documentation).
  30. Additionally, themes can add their own templates, which will be applied if not
  31. overridden. You can override built-in or theme templates by creating a template with
  32. same name in the correct path. For example, you can override the RSS template by
  33. creating a `templates/rss.xml` file.
  34. ## Custom Templates
  35. In addition to the standard `index.html`, `section.html`, and `page.html` templates,
  36. you may also create custom templates by creating a `.html` file in the `templates`
  37. directory. These custom templates will not be used by default. Instead, the custom template will _only_ be used if you apply it by setting the `template` front-matter variable to the path for that template (or if you `include` it in another template that is applied). For example, if you created a custom template for your site's About page called `about.html`, you could apply it to your `about.md` page by including the following front matter in your `about.md` page:
  38. ```md
  39. +++
  40. title = "About Us"
  41. template = "about.html"
  42. +++
  43. ```
  44. Custom templates are not required to live at the root of your `templates` directory.
  45. For example, `product_pages/with_pictures.html` is a valid template.
  46. ## Built-in filters
  47. Zola adds a few filters, in addition of the ones [ones already present](https://tera.netlify.com/docs/templates/#built-in-filters) in Tera.
  48. ### markdown
  49. Converts the given variable to HTML using Markdown. This doesn't apply any of the
  50. features that Zola adds to Markdown: internal links, shortcodes etc won't work.
  51. By default, the filter will wrap all text into a paragraph. To disable that, you can
  52. pass `true` to the inline argument:
  53. ```jinja2
  54. {{ some_text | markdown(inline=true) }}
  55. ```
  56. ### base64_encode
  57. Encode the variable to base64.
  58. ### base64_decode
  59. Decode the variable from base64.
  60. ## Built-in global functions
  61. Zola adds a few global functions to [those in Tera](https://tera.netlify.com/docs/templates/#built-in-functions) in order to make it easier to develop complex sites.
  62. ### `get_page`
  63. Takes a path to a `.md` file and returns the associated page
  64. ```jinja2
  65. {% set page = get_page(path="blog/page2.md") %}
  66. ```
  67. ### `get_section`
  68. Takes a path to a `_index.md` file and returns the associated section
  69. ```jinja2
  70. {% set section = get_section(path="blog/_index.md") %}
  71. ```
  72. If you only need the metadata of the section, you can pass `metadata_only=true` to the function:
  73. ```jinja2
  74. {% set section = get_section(path="blog/_index.md", metadata_only=true) %}
  75. ```
  76. ### ` get_url`
  77. Gets the permalink for the given path.
  78. If the path starts with `./`, it will be understood as an internal
  79. link like the ones used in markdown.
  80. ```jinja2
  81. {% set url = get_url(path="./blog/_index.md") %}
  82. ```
  83. This can also be used to get the permalinks for static assets for example if
  84. we want to link to the file that is located at `static/css/app.css`:
  85. ```jinja2
  86. {{/* get_url(path="css/app.css") */}}
  87. ```
  88. By default, assets will not have a trailing slash. You can force one by passing `trailing_slash=true` to the `get_url` function.
  89. An example is:
  90. ```jinja2
  91. {{/* get_url(path="css/app.css", trailing_slash=true) */}}
  92. ```
  93. In the case of non-internal links, you can also add a cachebust of the format `?t=1290192` at the end of a URL
  94. by passing `cachebust=true` to the `get_url` function.
  95. ### `get_taxonomy_url`
  96. Gets the permalink for the taxonomy item found.
  97. ```jinja2
  98. {% set url = get_taxonomy_url(kind="categories", name=page.taxonomies.category) %}
  99. ```
  100. The `name` will almost come from a variable but in case you want to do it manually,
  101. the value should be the same as the one in the front-matter, not the slugified version.
  102. ### `get_taxonomy`
  103. Gets the whole taxonomy of a specific kind.
  104. ```jinja2
  105. {% set categories = get_taxonomy(kind="categories") %}
  106. ```
  107. ### `load_data`
  108. Loads data from a file or URL. Supported file types include *toml*, *json* and *csv*.
  109. Any other file type will be loaded as plain text.
  110. The `path` argument specifies the path to the data file relative to your base directory, where your `config.toml` is.
  111. As a security precaution, If this file is outside of the main site directory, your site will fail to build.
  112. ```jinja2
  113. {% set data = load_data(path="content/blog/story/data.toml") %}
  114. ```
  115. The optional `format` argument allows you to specify and override which data type is contained
  116. within the file specified in the `path` argument. Valid entries are `toml`, `json`, `csv`
  117. or `plain`. If the `format` argument isn't specified, then the paths extension is used.
  118. ```jinja2
  119. {% set data = load_data(path="content/blog/story/data.txt", format="json") %}
  120. ```
  121. Use the `plain` format for when your file has a toml/json/csv extension but you want to load it as plain text.
  122. For *toml* and *json* the data is loaded into a structure matching the original data file,
  123. however for *csv* there is no native notion of such a structure. Instead the data is separated
  124. into a data structure containing *headers* and *records*. See the example below to see
  125. how this works.
  126. In the template:
  127. ```jinja2
  128. {% set data = load_data(path="content/blog/story/data.csv") %}
  129. ```
  130. In the *content/blog/story/data.csv* file:
  131. ```csv
  132. Number, Title
  133. 1,Gutenberg
  134. 2,Printing
  135. ```
  136. The equivalent json value of the parsed data would be stored in the `data` variable in the
  137. template:
  138. ```json
  139. {
  140. "headers": ["Number", "Title"],
  141. "records": [
  142. ["1", "Gutenberg"],
  143. ["2", "Printing"]
  144. ],
  145. }
  146. ```
  147. #### Remote content
  148. Instead of using a file, you can load data from a remote URL. This can be done by specifying a `url` parameter to `load_data` rather than `path`.
  149. ```jinja2
  150. {% set response = load_data(url="https://api.github.com/repos/getzola/zola") %}
  151. {{ response }}
  152. ```
  153. By default, the response body will be returned with no parsing. This can be changed by using the `format` argument as below.
  154. ```jinja2
  155. {% set response = load_data(url="https://api.github.com/repos/getzola/zola", format="json") %}
  156. {{ response }}
  157. ```
  158. #### Data Caching
  159. Data file loading and remote requests are cached in memory during build, so multiple requests aren't made to the same endpoint.
  160. URLs are cached based on the URL, and data files are cached based on the files modified time.
  161. The format is also taken into account when caching, so a request will be sent twice if it's loaded with 2 different formats.
  162. ### `trans`
  163. Gets the translation of the given `key`, for the `default_language` or the `lang`uage given
  164. ```jinja2
  165. {{/* trans(key="title") */}}
  166. {{/* trans(key="title", lang="fr") */}}
  167. ```
  168. ### `resize_image`
  169. Resizes an image file.
  170. Pease refer to [_Content / Image Processing_](./documentation/content/image-processing/index.md) for complete documentation.