zola/docs/content/documentation/themes/installing-and-using-themes.md

64 lines
2.1 KiB
Markdown
Raw Normal View History

2017-10-01 03:51:43 +00:00
+++
title = "Installing & using themes"
weight = 20
+++
## Installing a theme
The easiest way to install to theme is to clone its repository in the `themes`
directory.
```bash
$ cd themes
$ git clone THEME_REPO_URL
```
Cloning the repository using Git or another VCS will allow you to easily
update it but you can also simply download the files manually and paste
them in a folder.
## Using a theme
Now that you have the theme in your `themes` directory, you only need to tell
2018-10-18 21:09:32 +00:00
Zola to use it to get started by setting the `theme` variable of the
2017-10-01 03:51:43 +00:00
[configuration file](./documentation/getting-started/configuration.md). The theme
name has to be name of the directory you cloned the theme in.
2017-10-20 10:35:23 +00:00
For example, if you cloned a theme in `themes/simple-blog`, the theme name to use
2017-10-01 03:51:43 +00:00
in the configuration file is `simple-blog`.
## Customizing a theme
Any file from the theme can be overriden by creating a file with the same path and name in your `templates` or `static`
directory. Here are a few examples of that, assuming the theme name is `simple-blog`:
```plain
templates/pages/post.html -> replace themes/simple-blog/templates/pages/post.html
templates/macros.html -> replace themes/simple-blog/templates/macros.html
2017-11-17 21:40:41 +00:00
static/js/site.js -> replace themes/simple-blog/static/js/site.js
2017-10-01 03:51:43 +00:00
```
You can also choose to only parts of a page if a theme define some blocks by extending it. If we wanted
to only change a single block from the `post.html` page in the example above, we could do the following:
```
{% extends "simple-blog/templates/pages/post.html" %}
{% block some_block %}
Some custom data
{% endblock %}
```
2017-10-01 03:51:43 +00:00
Most themes will also provide some variables that are meant to be overriden: this happens in the `extra` section
of the [configuration file](./documentation/getting-started/configuration.md).
Let's say a theme uses a `show_twitter` variable and sets it to `false` by default. If you want to set it to `true`,
2017-10-01 03:51:43 +00:00
you can update your `config.toml` like so:
```toml
[extra]
show_twitter = false
```
You can modify files directly in the `themes` directory but this will make updating the theme harder and live reload won't work with those
2017-10-01 03:51:43 +00:00
files.