` surrounding the iframe
Usage example:
@@ -188,7 +189,7 @@ The arguments are:
- `url`: the url to the gist (mandatory)
- `file`: by default, the shortcode will pull every file from the URL unless a specific filename is requested
-- `class`: a class to add the `div` surrounding the iframe
+- `class`: a class to add to the `
` surrounding the iframe
Usage example:
diff --git a/docs/content/documentation/content/syntax-highlighting.md b/docs/content/documentation/content/syntax-highlighting.md
index 34b32d11..13260158 100644
--- a/docs/content/documentation/content/syntax-highlighting.md
+++ b/docs/content/documentation/content/syntax-highlighting.md
@@ -17,10 +17,10 @@ let highlight = true;
````
-You can replace the `rust` by the language you want to highlight or not put anything to get it
+You can replace `rust` with another language or not put anything to get the text
interpreted as plain text.
-Here is a full list of the supported languages and the short names you can use:
+Here is a full list of supported languages and their short names:
```
- ActionScript -> ["as"]
@@ -123,8 +123,8 @@ Here is a full list of the supported languages and the short names you can use:
- YAML -> ["sublime-syntax", "yaml", "yml"]
```
-If you want to highlight a language not on that list, please open an issue or a pull request on the [Zola repo](https://github.com/getzola/zola).
-Alternatively, the `extra_syntaxes` config option can be used to add additional syntax files.
+If you want to highlight a language not on this list, please open an issue or a pull request on the [Zola repo](https://github.com/getzola/zola).
+Alternatively, the `extra_syntaxes` configuration option can be used to add additional syntax files.
If your site source is laid out as follows:
@@ -143,4 +143,4 @@ If your site source is laid out as follows:
└── ...
```
-you would set your `extra_syntaxes` to `["syntaxes", "syntaxes/Sublime-Language1"]` in order to load `lang1.sublime-syntax` and `lang2.sublime-syntax`.
+you would set your `extra_syntaxes` to `["syntaxes", "syntaxes/Sublime-Language1"]` to load `lang1.sublime-syntax` and `lang2.sublime-syntax`.
diff --git a/docs/content/documentation/content/table-of-contents.md b/docs/content/documentation/content/table-of-contents.md
index 6e4d04ef..d1924011 100644
--- a/docs/content/documentation/content/table-of-contents.md
+++ b/docs/content/documentation/content/table-of-contents.md
@@ -9,7 +9,7 @@ It is available in the template through the `page.toc` or `section.toc` variable
You can view the [template variables](@/documentation/templates/pages-sections.md#table-of-contents)
documentation for information on its structure.
-Here is an example of using that field to render a 2-level table of contents:
+Here is an example of using that field to render a two-level table of contents:
```jinja2
@@ -30,7 +30,7 @@ Here is an example of using that field to render a 2-level table of contents:
```
-While headers are neatly ordered in that example, it will work just as well with disjoint headers.
+While headers are neatly ordered in this example, it will work just as well with disjoint headers.
Note that all existing HTML tags from the title will NOT be present in the table of contents to
avoid various issues.
diff --git a/docs/content/documentation/content/taxonomies.md b/docs/content/documentation/content/taxonomies.md
index 606abcfd..5bdc0636 100644
--- a/docs/content/documentation/content/taxonomies.md
+++ b/docs/content/documentation/content/taxonomies.md
@@ -7,13 +7,13 @@ Zola has built-in support for taxonomies.
The first step is to define the taxonomies in your [config.toml](@/documentation/getting-started/configuration.md).
-A taxonomy has 5 variables:
+A taxonomy has five variables:
-- `name`: a required string that will be used in the URLs, usually the plural version (i.e. tags, categories etc)
+- `name`: a required string that will be used in the URLs, usually the plural version (i.e., tags, categories, etc.)
- `paginate_by`: if this is set to a number, each term page will be paginated by this much.
-- `paginate_path`: if set, will be the path used by paginated page and the page number will be appended after it.
-For example the default would be page/1
-- `rss`: if set to `true`, a RSS feed will be generated for each individual term.
+- `paginate_path`: if set, this path will be used by the paginated page and the page number will be appended after it.
+For example the default would be page/1.
+- `rss`: if set to `true`, an RSS feed will be generated for each term.
- `lang`: only set this if you are making a multilingual site and want to indicate which language this taxonomy is for
Once this is done, you can then set taxonomies in your content and Zola will pick
diff --git a/docs/content/documentation/deployment/github-pages.md b/docs/content/documentation/deployment/github-pages.md
index dd50ac5e..5ba0287d 100644
--- a/docs/content/documentation/deployment/github-pages.md
+++ b/docs/content/documentation/deployment/github-pages.md
@@ -3,25 +3,31 @@ title = "GitHub Pages"
weight = 30
+++
-By default, GitHub Pages uses Jekyll (A ruby based static site generator),
-but you can also publish any generated files provided you have an `index.html` file in the root of a branch called `gh-pages` or `master`, in addition you can also publish from a `docs` directory in your repository. That branch name can also be manually changed in the settings of a repository. **However** this only applies to publishing in a custom domain, i.e. if you want to publish to a GitHub provided web service under the `github.io` domain, you can **only** use the `master` branch of your repository as explained [here](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages), so we will focus on the method which will work regardless of the domain.
+By default, GitHub Pages uses Jekyll (a ruby based static site generator),
+but you can also publish any generated files provided you have an `index.html` file in the root of a branch called
+`gh-pages` or `master`. In addition you can publish from a `docs` directory in your repository. That branch name can
+also be manually changed in the settings of a repository. **However**, this only applies to publishing in a custom domain,
+i.e., if you want to publish to a GitHub-provided web service under the `github.io` domain, you can **only** use the
+`master` branch of your repository, as explained
+[here](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages),
+so we will focus on the method that will work regardless of the domain.
-We can use any CI server to build and deploy our site. For example:
+We can use any continuous integration (CI) server to build and deploy our site. For example:
* [Github Actions](https://github.com/shalzz/zola-deploy-action)
* [Travis CI](#travis-ci)
## Travis CI
-We are going to use [TravisCI](https://travis-ci.org) to automatically publish the site. If you are not using Travis already,
-you will need to login with the GitHub OAuth and activate Travis for the repository.
+We are going to use [Travis CI](https://travis-ci.org) to automatically publish the site. If you are not using Travis
+already, you will need to login with the GitHub OAuth and activate Travis for the repository.
Don't forget to also check if your repository allows GitHub Pages in its settings.
-## Ensure Travis can access your theme
+## Ensure that Travis can access your theme
-Depending on how you added your theme Travis may not exactly know how to access
-it. The best way to ensure it will have full access to the theme is to use git
-submodules. When doing this ensure you are using the `https` version of the URL.
+Depending on how you added your theme, Travis may not know how to access
+it. The best way to ensure that it will have full access to the theme is to use git
+submodules. When doing this, ensure that you are using the `https` version of the URL.
```shell
$ git submodule add {THEME_URL} themes/{THEME_NAME}
@@ -29,16 +35,17 @@ $ git submodule add {THEME_URL} themes/{THEME_NAME}
## Allowing Travis to push to GitHub
-Before pushing anything, Travis needs a Github private access key in order to make changes to your repository.
-If you're already logged in to your account, just click [here](https://github.com/settings/tokens) to go to your tokens page.
+Before pushing anything, Travis needs a Github private access key to make changes to your repository.
+If you're already logged in to your account, just click [here](https://github.com/settings/tokens) to go to
+your tokens page.
Otherwise, navigate to `Settings > Developer Settings > Personal Access Tokens`.
-Generate a new token, and give it any description you'd like.
+Generate a new token and give it any description you'd like.
Under the "Select Scopes" section, give it repo permissions. Click "Generate token" to finish up.
-Your token will now be visible!
+Your token will now be visible.
Copy it into your clipboard and head back to Travis.
Once on Travis, click on your project, and navigate to "Settings". Scroll down to "Environment Variables" and input a name of `GH_TOKEN` with a value of your access token.
-Make sure "Display value in build log" is off, and then click add. Now Travis has access to your repository.
+Make sure that "Display value in build log" is off, and then click add. Now Travis has access to your repository.
## Setting up Travis
@@ -68,7 +75,7 @@ after_success: |
git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git master
```
-If your site is using a custom domain, you will need to mention it in the `ghp-import` command: `ghp-import -c vaporsoft.net -n public`
-for example.
+If your site is using a custom domain, you will need to mention it in the `ghp-import` command:
+`ghp-import -c vaporsoft.net -n public` for example.
Credits: this page is based on the article https://vaporsoft.net/publishing-gutenberg-to-github/
diff --git a/docs/content/documentation/deployment/gitlab-pages.md b/docs/content/documentation/deployment/gitlab-pages.md
index 8bcde42b..ecd8a179 100644
--- a/docs/content/documentation/deployment/gitlab-pages.md
+++ b/docs/content/documentation/deployment/gitlab-pages.md
@@ -9,7 +9,7 @@ We are going to use the GitLab CI runner to automatically publish the site (this
Your repository needs to be set up to be a user or group website. This means the name of the repository has to be in the correct format.
-For example, under your username, `john`, you have to create a project called `john.gitlab.io`. Your project URL will be `https://gitlab.com/john/john.gitlab.io`. Once you enable GitLab Pages for your project, your website will be published under `https://john.gitlab.io`.
+For example, assuming that the username is `john`, you have to create a project called `john.gitlab.io`. Your project URL will be `https://gitlab.com/john/john.gitlab.io`. Once you enable GitLab Pages for your project, your website will be published under `https://john.gitlab.io`.
Under your group `websites`, you created a project called `websites.gitlab.io`. Your project’s URL will be `https://gitlab.com/websites/websites.gitlab.io`. Once you enable GitLab Pages for your project, your website will be published under `https://websites.gitlab.io`.
@@ -18,23 +18,23 @@ This guide assumes that your zola project is located in the root of your reposit
## Ensuring that the CI runner can access your theme
-Depending on how you added your theme your repository may not contain it. The best way to ensure the theme will be added is to use
-submodules. When doing this ensure you are using the `https` version of the URL.
+Depending on how you added your theme, your repository may not contain it. The best way to ensure that the theme will
+be added is to use submodules. When doing this, ensure that you are using the `https` version of the URL.
```shell
$ git submodule add {THEME_URL} themes/{THEME_NAME}
```
-For example, this could look like
+For example, this could look like:
```shell
$ git submodule add https://github.com/getzola/hyde.git themes/hyde
```
## Setting up the GitLab CI/CD Runner
-The second step is to tell the gitlab continous integration runner how to create the gitlab page.
+The second step is to tell the GitLab continous integration runner how to create the GitLab page.
-To do this, create a file called `.gitlab-ci.yml` in the root directory of your repository.
+To do this, create a file called `.gitlab-ci.yml` in the root directory of your repository.
```yaml
variables:
@@ -62,7 +62,8 @@ pages:
- master
```
-Push this new file and... Tada! You're done! If you navigate to `settings > pages` you should be able to see something like this:
+Push this new file and ... Tada! You're done! If you navigate to `settings > pages`, you should be able to see
+something like this:
> Congratulations! Your pages are served under:
https://john.gitlab.io
diff --git a/docs/content/documentation/deployment/netlify.md b/docs/content/documentation/deployment/netlify.md
index a8557b92..d2c3f275 100644
--- a/docs/content/documentation/deployment/netlify.md
+++ b/docs/content/documentation/deployment/netlify.md
@@ -4,12 +4,12 @@ weight = 20
+++
Netlify provides best practices like SSL, CDN distribution, caching and continuous deployment
-with no effort. This very site is hosted by Netlify and automatically deployed on commits.
+with no effort. This site is hosted by Netlify and automatically deployed on commits.
If you don't have an account with Netlify, you can [sign up](https://app.netlify.com) for one.
-## Automatic Deploys
+## Automatic deploys
Once you are in the admin interface, you can add a site from a Git provider (GitHub, GitLab or Bitbucket). At the end
of this process, you can select the deploy settings for the project:
@@ -20,27 +20,27 @@ Once you are in the admin interface, you can add a site from a Git provider (Git
- Environment variables: `ZOLA_VERSION` with for example `0.8.0` as value
With this setup, your site should be automatically deployed on every commit on master. For `ZOLA_VERSION`, you may
-use any of the tagged `release` versions in the GitHub repository — Netlify will automatically fetch the tagged version
+use any of the tagged `release` versions in the GitHub repository. Netlify will automatically fetch the tagged version
and use it to build your site.
However, if you want to use everything that Netlify gives you, you should also publish temporary sites for pull requests.
-This is done by adding the following `netlify.toml` file in your repository and removing the build command/publish directory in
-the admin interface.
+This is done by adding the following `netlify.toml` file in your repository and removing the build command/publish
+directory in the admin interface.
-```toml
+```TOML
[build]
-# assuming the Zola site is in a docs folder, if it isn't you don't need
-# to have a `base` variable but you do need the `publish` and `command`
+# This assumes that the Zola site is in a docs folder. If it isn't, you don't need
+# to have a `base` variable but you do need the `publish` and `command` variables.
base = "docs"
publish = "docs/public"
command = "zola build"
[build.environment]
-# Set the version name that you want to use and Netlify will automatically use it
+# Set the version name that you want to use and Netlify will automatically use it.
ZOLA_VERSION = "0.9.0"
-# The magic for deploying previews of branches
+# The magic for deploying previews of branches.
# We need to override the base url with whatever url Netlify assigns to our
# preview site. We do this using the Netlify environment variable
# `$DEPLOY_PRIME_URL`.
@@ -49,17 +49,18 @@ ZOLA_VERSION = "0.9.0"
command = "zola build --base-url $DEPLOY_PRIME_URL"
```
-## Manual Deploys
+## Manual deploys
If you would prefer to use a version of Zola that isn't a tagged release (for example, after having built Zola from
-source and made modifications), then you will need to manually deploy your `public` folder to Netlify. You can do this through
-Netlify's web GUI or via the command line.
+source and made modifications), then you will need to manually deploy your `public` folder to Netlify. You can do
+this through Netlify's web GUI or via the command line.
For a command-line manual deploy, follow these steps:
- 1. Generate a `Personal Access Token` from the settings section of your Netlify account (*not* an OAuth Application)
- 2. Build your site with `zola build`
- 3. Create a zip folder containing the `public` directory
- 4. Run the `curl` command below, filling in your values for PERSONAL_ACCESS_TOKEN_FROM_STEP_1, FILE_NAME.zip and SITE_NAME
- 5. (Optional) delete the zip folder
+ 1. Generate a `Personal Access Token` from the settings section of your Netlify account (*not* an OAuth Application).
+ 2. Build your site with `zola build`.
+ 3. Create a zip folder containing the `public` directory.
+ 4. Run the `curl` command below, filling in your values for PERSONAL_ACCESS_TOKEN_FROM_STEP_1, FILE_NAME.zip
+ and SITE_NAME.
+ 5. (Optional) delete the zip folder.
```bash
curl -H "Content-Type: application/zip" \
diff --git a/docs/content/documentation/getting-started/cli-usage.md b/docs/content/documentation/getting-started/cli-usage.md
index d31a1980..a70300d4 100644
--- a/docs/content/documentation/getting-started/cli-usage.md
+++ b/docs/content/documentation/getting-started/cli-usage.md
@@ -1,24 +1,24 @@
+++
title = "CLI usage"
-weight = 2
+weight = 20
+++
Zola only has 4 commands: `init`, `build`, `serve` and `check`.
-You can view the help of the whole program by running `zola --help` and
-the command help by running `zola
--help`.
+You can view the help for the whole program by running `zola --help` and
+that for a specific command by running `zola --help`.
## init
Creates the directory structure used by Zola at the given directory after asking a few basic configuration questions.
-Any choices made during those prompts can easily be changed by modifying the `config.toml`.
+Any choices made during these prompts can be easily changed by modifying `config.toml`.
```bash
$ zola init my_site
$ zola init
```
-If the `my_site` folder already exists, Zola will only populate it if it does not contain non-hidden files (dotfiles are ignored). If no `my_site` argument is passed, Zola will try to populate the current directory.
+If the `my_site` directory already exists, Zola will only populate it if it contains only hidden files (dotfiles are ignored). If no `my_site` argument is passed, Zola will try to populate the current directory.
You can initialize a git repository and a Zola site directly from within a new folder:
@@ -29,7 +29,7 @@ $ zola init
## build
-This will build the whole site in the `public` directory after deleting it.
+This will build the whole site in the `public` directory (if this directory already exists, it is overwritten).
```bash
$ zola build
@@ -44,34 +44,33 @@ $ zola build --base-url $DEPLOY_URL
This is useful for example when you want to deploy previews of a site to a dynamic URL, such as Netlify
deploy previews.
-You can override the default output directory 'public' by passing a other value to the `output-dir` flag.
+You can override the default output directory `public` by passing another value to the `output-dir` flag.
```bash
$ zola build --output-dir $DOCUMENT_ROOT
```
-You can also point to another config file than `config.toml` like so - the position of the `config` option is important:
+You can also point to a config file other than `config.toml` like so (note that the position of the `config` option is important):
```bash
$ zola --config config.staging.toml build
```
-By defaults, drafts are not loaded. If you wish to include them, pass the `--drafts` flag.
+By default, drafts are not loaded. If you wish to include them, pass the `--drafts` flag.
## serve
This will build and serve the site using a local server. You can also specify
the interface/port combination to use if you want something different than the default (`127.0.0.1:1111`).
-You can also specify different addresses for the interface and base_url using `-u`/`--base-url`, for example
-if you are running zola in a Docker container.
+You can also specify different addresses for the interface and base_url using `--interface` and `-u`/`--base-url`, respectively, if for example you are running Zola in a Docker container.
Use the `--open` flag to automatically open the locally hosted instance in your
web browser.
-In the event you don't want zola to run a local webserver, you can use the `--watch-only` flag.
+In the event you don't want Zola to run a local webserver, you can use the `--watch-only` flag.
-Before starting, it will delete the public directory to ensure it starts from a clean slate.
+Before starting, Zola will delete the `public` directory to start from a clean slate.
```bash
$ zola serve
@@ -84,40 +83,40 @@ $ zola serve --watch-only
$ zola serve --open
```
-The serve command will watch all your content and will provide live reload, without
-hard refresh if possible.
+The serve command will watch all your content and provide live reload without
+a hard refresh if possible.
-Zola does a best-effort to live reload but some changes cannot be handled automatically. If you
-fail to see your change or get a weird error, try to restart `zola serve`.
+Some changes cannot be handled automatically and thus live reload may not always work. If you
+fail to see your change or get an error, try restarting `zola serve`.
-You can also point to another config file than `config.toml` like so - the position of the `config` option is important:
+You can also point to a config file other than `config.toml` like so (note that the position of the `config` option is important):
```bash
$ zola --config config.staging.toml serve
```
-By defaults, drafts are not loaded. If you wish to include them, pass the `--drafts` flag.
+By default, drafts are not loaded. If you wish to include them, pass the `--drafts` flag.
### check
The check subcommand will try to build all pages just like the build command would, but without writing any of the
-results to disk. Additionally, it will also check all external links present in Markdown files by trying to fetch
-them (links present in the template files will not be checked).
+results to disk. Additionally, it will also check all external links in Markdown files by trying to fetch
+them (links in the template files are not checked).
-By defaults, drafts are not loaded. If you wish to include them, pass the `--drafts` flag.
+By default, drafts are not loaded. If you wish to include them, pass the `--drafts` flag.
## Colored output
-Any of the three commands will emit colored output if your terminal supports it.
+Colored output is used if your terminal supports it.
-*Note*: coloring is automatically disabled when the output is redirected to a pipe or a file (ie. when the standard output is not a TTY).
+*Note*: coloring is automatically disabled when the output is redirected to a pipe or a file (i.e., when the standard output is not a TTY).
-You can disable this behavior by exporting one of the two following environment variables:
+You can disable this behavior by exporting one of the following two environment variables:
- `NO_COLOR` (the value does not matter)
- `CLICOLOR=0`
-Should you want to force the use of colors, you can set the following environment variable:
+To force the use of colors, you can set the following environment variable:
- `CLICOLOR_FORCE=1`
diff --git a/docs/content/documentation/getting-started/configuration.md b/docs/content/documentation/getting-started/configuration.md
index 30599143..00309f76 100644
--- a/docs/content/documentation/getting-started/configuration.md
+++ b/docs/content/documentation/getting-started/configuration.md
@@ -3,51 +3,51 @@ title = "Configuration"
weight = 4
+++
-The default configuration will be enough to get Zola running locally but not more than that.
-It follows the philosophy of only paying for what you need: almost everything is turned off by default.
+The default configuration is sufficient to get Zola running locally but not more than that.
+It follows the philosophy of paying for only what you need; almost everything is turned off by default.
-To change the config, edit the `config.toml` file.
-If you are not familiar with TOML, have a look at [the TOML Spec](https://github.com/toml-lang/toml)
-to learn about it.
+To change the configuration, edit the `config.toml` file.
+If you are not familiar with TOML, have a look at [the TOML spec](https://github.com/toml-lang/toml).
-Only one variable - `base_url` - is mandatory, everything else is optional. You can find all variables
-used by Zola config as well as their default values below:
+Only the `base_url` variable is mandatory; everything else is optional. All configuration variables
+used by Zola as well as their default values are listed below:
```toml
-# Base URL of the site, the only required config argument
+# The base URL of the site; the only required configuration variable.
base_url = "mywebsite.com"
-# Used in RSS by default
+# The site title and description; used in RSS by default.
title = ""
description = ""
-# The default language, used in RSS
+
+# The default language; used in RSS.
default_language = "en"
-# Theme name to use
+# The site theme to use.
theme = ""
-# Highlight all code blocks found
+# When set to "true", all code blocks are highlighted.
highlight_code = false
-# Which theme to use for the code highlighting.
-# See below for list of accepted values
+# The theme to use for code highlighting.
+# See below for list of allowed values.
highlight_theme = "base16-ocean-dark"
-# Whether to generate a RSS feed automatically
+# When set to "true", an RSS feed is automatically generated.
generate_rss = false
-# The number of articles to include in the RSS feed. Will include all items if
-# not set (the default).
+# The number of articles to include in the RSS feed. All items are included if
+# this limit is not set (the default).
# rss_limit = 20
-# Whether to copy or hardlink files in static/ directory. Useful for sites
-# whose static files are large. Note that for this to work, both static/ and
-# output directory need to be on the same filesystem. Also, theme's static/
-# files are always copies, regardles of this setting. False by default.
+# When set to "true", files in the `static` directory are hard-linked. Useful for large
+# static files. Note that for this to work, both `static` and the
+# output directory need to be on the same filesystem. Note that the theme's `static`
+# files are always copied, regardles of this setting.
# hard_link_static = false
-# The taxonomies to be rendered for that site and their configuration
+# The taxonomies to be rendered for the site and their configuration.
# Example:
# taxonomies = [
# {name = "tags", rss = true}, # each tag will have its own RSS feed
@@ -58,7 +58,7 @@ generate_rss = false
#
taxonomies = []
-# The additional languages for that site
+# The additional languages for the site.
# Example:
# languages = [
# {code = "fr", rss = true}, # there will be a RSS feed for French content
@@ -68,23 +68,24 @@ taxonomies = []
#
languages = []
-# Whether to compile the Sass files found in the `sass` directory
+# When set to "true", the Sass files in the `sass` directory are compiled.
compile_sass = false
-# Whether to build a search index out of the pages and section
-# content for the `default_language`
+# When set to "true", a search index is built from the pages and section
+# content for `default_language`.
build_search_index = false
-# A list of glob patterns specifying asset files to ignore when
-# processing the content directory.
-# Defaults to none, which means all asset files are copied over to the public folder.
+# A list of glob patterns specifying asset files to ignore when the content
+# directory is processed. Defaults to none, which means that all asset files are
+# copied over to the `public` directory.
# Example:
# ignored_content = ["*.{graphml,xlsx}", "temp.*"]
ignored_content = []
-# A list of directories to search for additional `.sublime-syntax` files in.
+# A list of directories used to search for additional `.sublime-syntax` files.
extra_syntaxes = []
+<<<<<<< HEAD
# Optional translation object. The key if present should be a language code.
# Example:
# default_language = "fr"
@@ -97,7 +98,7 @@ extra_syntaxes = []
# title = "A title"
-# Configure the link checker
+# Configuration of the link checker.
[link_checker]
# Skip link checking for external URLs that start with these prefixes
skip_prefixes = [
@@ -109,8 +110,6 @@ skip_anchor_prefixes = [
"https://caniuse.com/",
]
-# You can put any kind of data in there and it
-# will be accessible in all templates
[extra]
```
@@ -155,4 +154,4 @@ Zola currently has the following highlight themes available:
- [zenburn](https://github.com/colinta/zenburn)
Zola uses the Sublime Text themes, making it very easy to add more.
-If you want a theme not on that list, please open an issue or a pull request on the [Zola repo](https://github.com/getzola/zola).
+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).
diff --git a/docs/content/documentation/getting-started/directory-structure.md b/docs/content/documentation/getting-started/directory-structure.md
index 0bf979ed..7e003710 100644
--- a/docs/content/documentation/getting-started/directory-structure.md
+++ b/docs/content/documentation/getting-started/directory-structure.md
@@ -3,7 +3,7 @@ title = "Directory structure"
weight = 3
+++
-After running `zola init`, you should see the following structure in your folder:
+After running `zola init`, you should see the following structure in your directory:
```bash
@@ -18,34 +18,34 @@ After running `zola init`, you should see the following structure in your folder
5 directories, 1 file
```
-Here's a high level overview of each of these folders and `config.toml`.
+Here's a high-level overview of each of these directories and `config.toml`.
## `config.toml`
-A mandatory configuration file of Zola in TOML format.
-It is explained in details in the [Configuration page](@/documentation/getting-started/configuration.md).
+A mandatory Zola configuration file in TOML format.
+This file is explained in detail in the [configuration documentation](@/documentation/getting-started/configuration.md).
## `content`
-Where all your markup content lies: this will be mostly comprised of `.md` files.
-Each folder in the `content` directory represents a [section](@/documentation/content/section.md)
-that contains [pages](@/documentation/content/page.md) : your `.md` files.
+Contains all your markup content (mostly `.md` files).
+Each child directory of the `content` directory represents a [section](@/documentation/content/section.md)
+that contains [pages](@/documentation/content/page.md) (your `.md` files).
-To learn more, read [the content overview](@/documentation/content/overview.md).
+To learn more, read the [content overview page](@/documentation/content/overview.md).
## `sass`
Contains the [Sass](http://sass-lang.com) files to be compiled. Non-Sass files will be ignored.
-The directory structure of the `sass` folder will be preserved when copying over the compiled files: a file at
+The directory structure of the `sass` folder will be preserved when copying over the compiled files; for example, a file at
`sass/something/site.scss` will be compiled to `public/something/site.css`.
## `static`
-Contains any kind of files. All the files/folders in the `static` folder will be copied as-is in the output directory.
-If your static files are large you can configure Zola to [hard link](https://en.wikipedia.org/wiki/Hard_link) them
-instead of copying by setting `hard_link_static = true` in the config file.
+Contains any kind of file. All the files/directories in the `static` directory will be copied as-is to the output directory.
+If your static files are large, you can configure Zola to [hard link](https://en.wikipedia.org/wiki/Hard_link) them
+instead of copying them by setting `hard_link_static = true` in the config file.
## `templates`
-Contains all the [Tera](https://tera.netlify.com) templates that will be used to render this site.
-Have a look at the [Templates](@/documentation/templates/_index.md) to learn more about default templates
+Contains all the [Tera](https://tera.netlify.com) templates that will be used to render your site.
+Have a look at the [templates documentation](@/documentation/templates/_index.md) to learn more about default templates
and available variables.
## `themes`
-Contains themes that can be used for that site. If you are not planning to use themes, leave this folder empty.
-If you want to learn about themes, head to the [themes documentation](@/documentation/themes/_index.md).
+Contains themes that can be used for your site. If you are not planning to use themes, leave this directory empty.
+If you want to learn about themes, see the [themes documentation](@/documentation/themes/_index.md).
diff --git a/docs/content/documentation/getting-started/installation.md b/docs/content/documentation/getting-started/installation.md
index 0cf5a470..d60539ae 100644
--- a/docs/content/documentation/getting-started/installation.md
+++ b/docs/content/documentation/getting-started/installation.md
@@ -24,7 +24,7 @@ $ yay -S zola-bin
### Fedora
-Zola is available in official repositories since Fedora 29.
+Zola has been available in the official repositories since Fedora 29.
```sh
$ sudo dnf install zola
@@ -54,7 +54,7 @@ Zola is available on [Scoop](http://scoop.sh):
$ scoop install zola
```
-And [Chocolatey](https://chocolatey.org/):
+and [Chocolatey](https://chocolatey.org/):
```bash
$ choco install zola
@@ -63,10 +63,10 @@ $ choco install zola
Zola does not work in PowerShell ISE.
## From source
-To build it from source, you will need to have Git, [Rust (at least 1.36) and Cargo](https://www.rust-lang.org/)
-installed. You will also need additional dependencies to compile [libsass](https://github.com/sass/libsass):
+To build Zola from source, you will need to have Git, [Rust (at least 1.36) and Cargo](https://www.rust-lang.org/)
+installed. You will also need to meet additional dependencies to compile [libsass](https://github.com/sass/libsass):
-- OSX, Linux and other Unix: `make` (`gmake` on BSDs), `g++`, `libssl-dev`
+- OSX, Linux and other Unix-like operating systems: `make` (`gmake` on BSDs), `g++`, `libssl-dev`
- NixOS: Create a `shell.nix` file in the root of the cloned project with the following contents:
```nix
with import {};
@@ -79,7 +79,7 @@ installed. You will also need additional dependencies to compile [libsass](https
];
}
```
- - Then invoke `nix-shell`. This opens a shell with the above dependencies. You then run `cargo build --release` to build the project.
+ - Then, invoke `nix-shell`. This opens a shell with the above dependencies. Then, run `cargo build --release` to build the project.
- Windows (a bit trickier): updated `MSVC` and overall updated VS installation
From a terminal, you can now run the following command:
@@ -88,6 +88,6 @@ From a terminal, you can now run the following command:
$ cargo build --release
```
-The binary will be available in the `target/release` folder. You can move it in your `$PATH` to have the
+The binary will be available in the `target/release` directory. You can move it in your `$PATH` to have the
`zola` command available globally or in a directory if you want for example to have the binary in the
same repository as the site.
diff --git a/docs/content/documentation/templates/404.md b/docs/content/documentation/templates/404.md
index 3e18c342..eb0a5586 100644
--- a/docs/content/documentation/templates/404.md
+++ b/docs/content/documentation/templates/404.md
@@ -4,5 +4,4 @@ weight = 80
+++
Zola will look for a `404.html` file in the `templates` directory or
-use the built-in one. The default template is very basic and gets a simple
-variable in the context: the site `config`.
+use the built-in one. The default template is very basic and gets `config` in its context.
diff --git a/docs/content/documentation/templates/archive.md b/docs/content/documentation/templates/archive.md
index ee7f830e..467d12c6 100644
--- a/docs/content/documentation/templates/archive.md
+++ b/docs/content/documentation/templates/archive.md
@@ -3,8 +3,8 @@ title = "Archive"
weight = 90
+++
-Zola doesn't have a built-in way to display an archive page, a page showing
-all post titles ordered by year. However, this can be accomplished directly in the templates:
+Zola doesn't have a built-in way to display an archive page (a page showing
+all post titles ordered by year). However, this can be accomplished directly in the templates:
```jinja2
{% for year, posts in section.pages | group_by(attribute="year") %}
@@ -19,5 +19,5 @@ all post titles ordered by year. However, this can be accomplished directly in t
```
This snippet assumes that posts are sorted by date and that you want to display the archive
-in a descending order. If you want to show articles in a ascending order, simply add a `reverse` filter
-after the `group_by`.
+in descending order. If you want to show articles in ascending order, add a `reverse` filter
+after `group_by`.
diff --git a/docs/content/documentation/templates/overview.md b/docs/content/documentation/templates/overview.md
index 4a6b2aa2..04e86463 100644
--- a/docs/content/documentation/templates/overview.md
+++ b/docs/content/documentation/templates/overview.md
@@ -3,49 +3,49 @@ title = "Overview"
weight = 10
+++
-Zola uses the [Tera](https://tera.netlify.com) template engine and is very similar
-to Jinja2, Liquid or Twig.
+Zola uses the [Tera](https://tera.netlify.com) template engine, which is very similar
+to Jinja2, Liquid and Twig.
As this documentation will only talk about how templates work in Zola, please read
the [Tera template documentation](https://tera.netlify.com/docs#templates) if you want
to learn more about it first.
-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
-to print the whole context.
+All templates live in the `templates` directory. If you are not sure what variables are available in a template,
+you can place `{{ __tera_context }}` in the template to print the whole context.
-A few variables are available on all templates minus RSS and sitemap:
+A few variables are available on all templates except RSS and the sitemap:
- `config`: the [configuration](@/documentation/getting-started/configuration.md) without any modifications
-- `current_path`: the path (full URL without the `base_url`) of the current page, never starting with a `/`
-- `current_url`: the full URL for that page
-- `lang`: the language for that page, `null` if the page/section doesn't have a language set
+- `current_path`: the path (full URL without `base_url`) of the current page, never starting with a `/`
+- `current_url`: the full URL for the current page
+- `lang`: the language for the current page; `null` if the page/section doesn't have a language set
-The 404 template does not get `current_path` and `current_url` as it cannot know it.
+The 404 template does not get `current_path` and `current_url` (this information cannot be determined).
-## Standard Templates
+## Standard templates
By default, Zola will look for three templates: `index.html`, which is applied
to the site homepage; `section.html`, which is applied to all sections (any HTML
page generated by creating a directory within your `content` directory); and
-`page.html`, which is applied to all pages (any HTML page generated by creating a
+`page.html`, which is applied to all pages (any HTML page generated by creating an
`.md` file within your `content` directory).
The homepage is always a section (regardless of whether it contains other pages).
Thus, the `index.html` and `section.html` templates both have access to the
section variables. The `page.html` template has access to the page variables.
-The page and section variables are described in more detail in the next section of this documentation.
+The page and section variables are described in more detail in the next section.
-## Built-in Templates
-Zola comes with three built-in templates: `rss.xml`, `sitemap.xml`, and
-`robots.txt` (each described in their own section of this documentation).
+## Built-in templates
+Zola comes with three built-in templates: `rss.xml`, `sitemap.xml` and
+`robots.txt` (each is described in its own section of this documentation).
Additionally, themes can add their own templates, which will be applied if not
overridden. You can override built-in or theme templates by creating a template with
-same name in the correct path. For example, you can override the RSS template by
+the same name in the correct path. For example, you can override the RSS template by
creating a `templates/rss.xml` file.
-## Custom Templates
-In addition to the standard `index.html`, `section.html`, and `page.html` templates,
-you may also create custom templates by creating a `.html` file in the `templates`
-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:
+## Custom templates
+In addition to the standard `index.html`, `section.html` and `page.html` templates,
+you may also create custom templates by creating an `.html` file in the `templates`
+directory. These custom templates will not be used by default. Instead, a 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:
```md
+++
@@ -58,13 +58,14 @@ Custom templates are not required to live at the root of your `templates` direct
For example, `product_pages/with_pictures.html` is a valid template.
## Built-in filters
-Zola adds a few filters, in addition of the ones [ones already present](https://tera.netlify.com/docs#built-in-filters) in Tera.
+Zola adds a few filters in addition to [those](https://tera.netlify.com/docs/templates/#built-in-filters) already present
+in Tera.
### markdown
Converts the given variable to HTML using Markdown. This doesn't apply any of the
-features that Zola adds to Markdown: internal links, shortcodes etc won't work.
+features that Zola adds to Markdown; for example, internal links and shortcodes won't work.
-By default, the filter will wrap all text into a paragraph. To disable that, you can
+By default, the filter will wrap all text in a paragraph. To disable this behaviour, you can
pass `true` to the inline argument:
```jinja2
@@ -80,18 +81,23 @@ Decode the variable from base64.
## Built-in global functions
+<<<<<<< HEAD
Zola adds a few global functions to [those in Tera](https://tera.netlify.com/docs#built-in-functions) in order to make it easier to develop complex sites.
+=======
+Zola adds a few global functions to [those in Tera](https://tera.netlify.com/docs/templates/#built-in-functions)
+to make it easier to develop complex sites.
+>>>>>>> Simple clean up of documentation. (#849)
### `get_page`
-Takes a path to a `.md` file and returns the associated page
+Takes a path to an `.md` file and returns the associated page.
```jinja2
{% set page = get_page(path="blog/page2.md") %}
```
### `get_section`
-Takes a path to a `_index.md` file and returns the associated section
+Takes a path to an `_index.md` file and returns the associated section.
```jinja2
{% set section = get_section(path="blog/_index.md") %}
@@ -105,14 +111,14 @@ If you only need the metadata of the section, you can pass `metadata_only=true`
### ` get_url`
Gets the permalink for the given path.
-If the path starts with `@/`, it will be understood as an internal
-link like the ones used in markdown, starting from the root `content` directory.
+If the path starts with `@/`, it will be treated as an internal
+link like the ones used in Markdown, starting from the root `content` directory.
```jinja2
{% set url = get_url(path="@/blog/_index.md") %}
```
-This can also be used to get the permalinks for static assets for example if
+This can also be used to get the permalinks for static assets, for example if
we want to link to the file that is located at `static/css/app.css`:
```jinja2
@@ -131,7 +137,7 @@ by passing `cachebust=true` to the `get_url` function.
### `get_image_metadata`
-Gets metadata for an image. Today the only supported keys are `width` and `height`.
+Gets metadata for an image. Currently, the only supported keys are `width` and `height`.
```jinja2
{% set meta = get_image_metadata(path="...") %}
@@ -145,8 +151,8 @@ Gets the permalink for the taxonomy item found.
{% set url = get_taxonomy_url(kind="categories", name=page.taxonomies.category) %}
```
-The `name` will almost come from a variable but in case you want to do it manually,
-the value should be the same as the one in the front-matter, not the slugified version.
+`name` will almost always come from a variable but in case you want to do it manually,
+the value should be the same as the one in the front matter, not the slugified version.
### `get_taxonomy`
Gets the whole taxonomy of a specific kind.
@@ -160,7 +166,7 @@ Loads data from a file or URL. Supported file types include *toml*, *json* and *
Any other file type will be loaded as plain text.
The `path` argument specifies the path to the data file relative to your base directory, where your `config.toml` is.
-As a security precaution, If this file is outside of the main site directory, your site will fail to build.
+As a security precaution, if this file is outside the main site directory, your site will fail to build.
```jinja2
{% set data = load_data(path="content/blog/story/data.toml") %}
@@ -168,7 +174,7 @@ As a security precaution, If this file is outside of the main site directory, yo
The optional `format` argument allows you to specify and override which data type is contained
within the file specified in the `path` argument. Valid entries are `toml`, `json`, `csv`
-or `plain`. If the `format` argument isn't specified, then the paths extension is used.
+or `plain`. If the `format` argument isn't specified, then the path extension is used.
```jinja2
{% set data = load_data(path="content/blog/story/data.txt", format="json") %}
@@ -176,8 +182,8 @@ or `plain`. If the `format` argument isn't specified, then the paths extension i
Use the `plain` format for when your file has a toml/json/csv extension but you want to load it as plain text.
-For *toml* and *json* the data is loaded into a structure matching the original data file,
-however for *csv* there is no native notion of such a structure. Instead the data is separated
+For *toml* and *json*, the data is loaded into a structure matching the original data file;
+however, for *csv* there is no native notion of such a structure. Instead, the data is separated
into a data structure containing *headers* and *records*. See the example below to see
how this works.
@@ -207,14 +213,16 @@ template:
#### Remote content
-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`.
+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`.
```jinja2
{% set response = load_data(url="https://api.github.com/repos/getzola/zola") %}
{{ response }}
```
-By default, the response body will be returned with no parsing. This can be changed by using the `format` argument as below.
+By default, the response body will be returned with no parsing. This can be changed by using the `format` argument
+as below.
```jinja2
@@ -222,11 +230,13 @@ By default, the response body will be returned with no parsing. This can be chan
{{ response }}
```
-#### Data Caching
+#### Data caching
-Data file loading and remote requests are cached in memory during build, so multiple requests aren't made to the same endpoint.
-URLs are cached based on the URL, and data files are cached based on the files modified time.
-The format is also taken into account when caching, so a request will be sent twice if it's loaded with 2 different formats.
+Data file loading and remote requests are cached in memory during the build, so multiple requests aren't made
+to the same endpoint.
+URLs are cached based on the URL, and data files are cached based on the file modified time.
+The format is also taken into account when caching, so a request will be sent twice if it's loaded with two
+different formats.
### `trans`
Gets the translation of the given `key`, for the `default_language` or the `lang`uage given
diff --git a/docs/content/documentation/templates/pages-sections.md b/docs/content/documentation/templates/pages-sections.md
index d79bec50..f827a7df 100644
--- a/docs/content/documentation/templates/pages-sections.md
+++ b/docs/content/documentation/templates/pages-sections.md
@@ -3,11 +3,11 @@ title = "Sections and Pages"
weight = 20
+++
-Pages and sections are actually very similar.
+Templates for pages and sections are very similar.
## Page variables
Zola will try to load the `templates/page.html` template, the `page.html` template of the theme if one is used
-or will render the built-in template: a blank page.
+or render the built-in template (a blank page).
Whichever template you decide to render, you will get a `page` variable in your template
with the following fields:
@@ -60,8 +60,8 @@ translations: Array;
## Section variables
By default, Zola will try to load `templates/index.html` for `content/_index.md`
-and `templates/section.html` for others `_index.md` files. If there isn't
-one, it will render the built-in template: a blank page.
+and `templates/section.html` for other `_index.md` files. If there isn't
+one, it will render the built-in template (a blank page).
Whichever template you decide to render, you will get a `section` variable in your template
with the following fields:
@@ -103,7 +103,7 @@ translations: Array;
## Table of contents
-Both page and section templates have a `toc` variable which corresponds to an array of `Header`.
+Both page and section templates have a `toc` variable that corresponds to an array of `Header`.
A `Header` has the following fields:
```ts
@@ -121,9 +121,9 @@ children: Array;
## Translated content
-Both page and section have a `translations` field which corresponds to an array of `TranslatedContent`. If your site is not using multiple languages,
-this will always be an empty array.
-A `TranslatedContent` has the following fields:
+Both pages and sections have a `translations` field that corresponds to an array of `TranslatedContent`. If your
+site is not using multiple languages, this will always be an empty array.
+`TranslatedContent` has the following fields:
```ts
// The language code for that content, empty if it is the default language
diff --git a/docs/content/documentation/templates/pagination.md b/docs/content/documentation/templates/pagination.md
index 0c6c101c..3308b452 100644
--- a/docs/content/documentation/templates/pagination.md
+++ b/docs/content/documentation/templates/pagination.md
@@ -32,8 +32,8 @@ current_index: Number;
total_pages: Number;
```
-A pager is a page of the pagination: if you have 100 pages and are paginating 10 by 10, you will have 10 pagers containing
-each 10 pages.
+A pager is a page of the pagination; if you have 100 pages and paginate_by is set to 10, you will have 10 pagers each
+containing 10 pages.
## Section
diff --git a/docs/content/documentation/templates/robots.md b/docs/content/documentation/templates/robots.md
index caa3d57f..a6041f9c 100644
--- a/docs/content/documentation/templates/robots.md
+++ b/docs/content/documentation/templates/robots.md
@@ -6,8 +6,8 @@ weight = 70
Zola will look for a `robots.txt` file in the `templates` directory or
use the built-in one.
-Robots.txt is the simplest of all templates: it only gets the config
-and the default is what most site want:
+Robots.txt is the simplest of all templates: it only gets `config`
+and the default is what most sites want:
```jinja2
User-agent: *
diff --git a/docs/content/documentation/templates/rss.md b/docs/content/documentation/templates/rss.md
index 8be0a24d..d2e89f74 100644
--- a/docs/content/documentation/templates/rss.md
+++ b/docs/content/documentation/templates/rss.md
@@ -5,14 +5,14 @@ weight = 50
If the site `config.toml` file sets `generate_rss = true`, then Zola will
generate an `rss.xml` page for the site, which will live at `base_url/rss.xml`. To
-generate the `rss.xml` page, Zola will look for a `rss.xml` file in the `templates`
-directory or, if one does not exist, will use the use the built-in rss template.
+generate the `rss.xml` page, Zola will look for an `rss.xml` file in the `templates`
+directory or, if one does not exist, it will use the use the built-in rss template.
**Only pages with a date will be available.**
-The RSS template gets three variables in addition of the config:
+The RSS template gets three variables in addition to `config`:
- `feed_url`: the full url to that specific feed
- `last_build_date`: the date of the latest post
-- `pages`: see [the page variables](@/documentation/templates/pages-sections.md#page-variables) for
+- `pages`: see [page variables](@/documentation/templates/pages-sections.md#page-variables) for
a detailed description of what this contains
diff --git a/docs/content/documentation/templates/sitemap.md b/docs/content/documentation/templates/sitemap.md
index 74f0f5a1..decd397c 100644
--- a/docs/content/documentation/templates/sitemap.md
+++ b/docs/content/documentation/templates/sitemap.md
@@ -7,11 +7,12 @@ Zola will look for a `sitemap.xml` file in the `templates` directory or
use the built-in one.
If your site has more than 30 000 pages, it will automatically split
-the links into multiple sitemaps as recommended by [Google](https://support.google.com/webmasters/answer/183668?hl=en):
+the links into multiple sitemaps, as recommended by [Google](https://support.google.com/webmasters/answer/183668?hl=en):
> All formats limit a single sitemap to 50MB (uncompressed) and 50,000 URLs.
> If you have a larger file or more URLs, you will have to break your list into multiple sitemaps.
-> You can optionally create a sitemap index file (a file that points to a list of sitemaps) and submit that single index file to Google.
+> You can optionally create a sitemap index file (a file that points to a list of sitemaps) and submit
+> that single index file to Google.
In such a case, Zola will use a template called `split_sitemap_index.xml` to render the index sitemap.
diff --git a/docs/content/documentation/templates/taxonomies.md b/docs/content/documentation/templates/taxonomies.md
index 9b8a70fe..cfebf88e 100644
--- a/docs/content/documentation/templates/taxonomies.md
+++ b/docs/content/documentation/templates/taxonomies.md
@@ -8,7 +8,7 @@ Zola will look up the following files in the `templates` directory:
- `$TAXONOMY_NAME/single.html`
- `$TAXONOMY_NAME/list.html`
-First, a `TaxonomyTerm` has the following fields:
+First, `TaxonomyTerm` has the following fields:
```ts
name: String;
@@ -17,7 +17,7 @@ permalink: String;
pages: Array;
```
-and a `TaxonomyConfig`:
+and `TaxonomyConfig` has the following fields:
```ts
name: String,
@@ -30,7 +30,7 @@ rss: Bool;
### Taxonomy list (`list.html`)
-This template is never paginated and therefore get the following variables in all cases.
+This template is never paginated and therefore gets the following variables in all cases.
```ts
// The site config
@@ -64,5 +64,5 @@ term: TaxonomyTerm;
lang: String;
```
-A paginated taxonomy term will also get a `paginator` variable, see the [pagination page](@/documentation/templates/pagination.md)
-for more details on that.
+A paginated taxonomy term will also get a `paginator` variable; see the [pagination page]
+(@/documentation/templates/pagination.md) for more details.
diff --git a/docs/content/documentation/themes/creating-a-theme.md b/docs/content/documentation/themes/creating-a-theme.md
index 32bf10ae..05b93689 100644
--- a/docs/content/documentation/themes/creating-a-theme.md
+++ b/docs/content/documentation/themes/creating-a-theme.md
@@ -8,9 +8,9 @@ will want to use many [Tera blocks](https://tera.netlify.com/docs#inheritance) t
allow users to easily modify it.
## Getting started
-As mentioned, a theme is just like any site: start with running `zola init MY_THEME_NAME`.
+As mentioned, a theme is just like any site; start by running `zola init MY_THEME_NAME`.
-The only thing needed to turn that site into a theme is to add `theme.toml` configuration file with the
+The only thing needed to turn that site into a theme is to add a `theme.toml` configuration file with the
following fields:
```toml
@@ -42,11 +42,11 @@ homepage = "http://markdotto.com/"
repo = "https://www.github.com/mdo/hyde"
```
-A simple theme you can use as example is [Hyde](https://github.com/Keats/hyde).
+A simple theme you can use as an example is [Hyde](https://github.com/Keats/hyde).
## Working on a theme
As a theme is just a site, you can simply use `zola serve` and make changes to your
-theme, with live reloading working as expected.
+theme, with live reload working as expected.
Make sure to commit every directory (including `content`) in order for other people
to be able to build the theme from your repository.
@@ -65,7 +65,7 @@ of this site, the theme will require two more things:
- `README.md`: a thorough README explaining how to use the theme and any other information
of importance
-The first step is to make sure the theme is fulfilling those three requirements:
+The first step is to make sure that the theme meets the following three requirements:
- have a `screenshot.png` of the theme in action with a max size of around 2000x1000
- have a thorough `README.md` explaining how to use the theme and any other information
diff --git a/docs/content/documentation/themes/installing-and-using-themes.md b/docs/content/documentation/themes/installing-and-using-themes.md
index f7552d9f..977da4e5 100644
--- a/docs/content/documentation/themes/installing-and-using-themes.md
+++ b/docs/content/documentation/themes/installing-and-using-themes.md
@@ -15,24 +15,24 @@ $ 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
+update. Alternatively, you can download the files manually and place
them in a folder.
-You can find a list of themes [on this very website](@/themes/_index.md).
+You can find a list of themes [here](@/themes/_index.md).
## Using a theme
-Now that you have the theme in your `themes` directory, you only need to tell
-Zola to use it to get started by setting the `theme` variable of the
+Now that you have the theme in your `themes` directory, you need to tell
+Zola to use it by setting the `theme` variable in the
[configuration file](@/documentation/getting-started/configuration.md). The theme
-name has to be name of the directory you cloned the theme in.
+name has to be the name of the directory you cloned the theme in.
For example, if you cloned a theme in `themes/simple-blog`, the theme name to use
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`:
+directory. Here are a few examples of that, assuming that the theme name is `simple-blog`:
```plain
templates/pages/post.html -> replace themes/simple-blog/templates/pages/post.html
@@ -40,7 +40,7 @@ templates/macros.html -> replace themes/simple-blog/templates/macros.html
static/js/site.js -> replace themes/simple-blog/static/js/site.js
```
-You can also choose to only override parts of a page if a theme define some blocks by extending it. If we wanted
+You can also choose to only override parts of a page if a theme defines 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:
```
@@ -51,7 +51,7 @@ Some custom data
{% endblock %}
```
-Most themes will also provide some variables that are meant to be overriden: this happens in the `extra` section
+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`,
you can update your `config.toml` like so:
@@ -61,5 +61,5 @@ you can update your `config.toml` like so:
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
-files.
+You can modify files directly in the `themes` directory but this will make updating the theme harder and live reload
+won't work with these files.
diff --git a/docs/content/documentation/themes/overview.md b/docs/content/documentation/themes/overview.md
index 46abeb34..00066844 100644
--- a/docs/content/documentation/themes/overview.md
+++ b/docs/content/documentation/themes/overview.md
@@ -3,10 +3,9 @@ title = "Overview"
weight = 10
+++
-Zola has built-in support for themes in a way that are easy to customise
-but still easy to update if needed.
+Zola has built-in support for themes that makes it easy to customise and update them.
All themes can use the full power of Zola, from shortcodes to Sass compilation.
-A list of themes is available [on this very website](@/themes/_index.md).
+A list of themes is available [here](@/themes/_index.md).