From 428b5942c7bc3be75cb268a6a07e36d6915dd891 Mon Sep 17 00:00:00 2001 From: Spencer Burris Date: Fri, 4 Sep 2020 20:53:31 +0000 Subject: [PATCH] Fix documentation typos (#1157) --- docs/content/documentation/content/sass.md | 2 +- docs/content/documentation/content/taxonomies.md | 2 +- docs/content/documentation/deployment/gitlab-pages.md | 4 ++-- .../content/documentation/getting-started/cli-usage.md | 2 +- .../documentation/getting-started/configuration.md | 10 +++++----- docs/content/documentation/getting-started/overview.md | 4 ++-- docs/content/documentation/templates/overview.md | 4 ++-- .../themes/installing-and-using-themes.md | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/content/documentation/content/sass.md b/docs/content/documentation/content/sass.md index 0d3671b1..8764467e 100644 --- a/docs/content/documentation/content/sass.md +++ b/docs/content/documentation/content/sass.md @@ -3,7 +3,7 @@ title = "Sass" weight = 110 +++ -Sass is a popular CSS preprocessor that adds special features (e.g., variables, nested rules) to facilate the +Sass is a popular CSS preprocessor that adds special features (e.g., variables, nested rules) to facilitate the maintenance of large sets of CSS rules. If you're curious about what Sass is and why it might be useful for styling your static site, the following links may be of interest: diff --git a/docs/content/documentation/content/taxonomies.md b/docs/content/documentation/content/taxonomies.md index b7544b89..d6433575 100644 --- a/docs/content/documentation/content/taxonomies.md +++ b/docs/content/documentation/content/taxonomies.md @@ -56,7 +56,7 @@ categories = ["programming"] In a similar manner to how section and pages calculate their output path: - the taxonomy name is never slugified -- the taxonomy term (eg. as specific tag) is slugified when `slugify.taxonomies` is enabled (`"on"`, the default) in the configuration +- the taxonomy term (e.g. as specific tag) is slugified when `slugify.taxonomies` is enabled (`"on"`, the default) in the configuration The taxonomy pages are then available at the following paths: diff --git a/docs/content/documentation/deployment/gitlab-pages.md b/docs/content/documentation/deployment/gitlab-pages.md index 827ff90c..98a708a3 100644 --- a/docs/content/documentation/deployment/gitlab-pages.md +++ b/docs/content/documentation/deployment/gitlab-pages.md @@ -14,7 +14,7 @@ For example, assuming that the username is `john`, you have to create a project 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`. -This guide assumes that your zola project is located in the root of your repository. +This guide assumes that your Zola project is located in the root of your repository. ## Ensuring that the CI runner can access your theme @@ -32,7 +32,7 @@ $ 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 continuous 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. diff --git a/docs/content/documentation/getting-started/cli-usage.md b/docs/content/documentation/getting-started/cli-usage.md index 4a4b3b8b..95485a53 100644 --- a/docs/content/documentation/getting-started/cli-usage.md +++ b/docs/content/documentation/getting-started/cli-usage.md @@ -73,7 +73,7 @@ You can also specify different addresses for the interface and base_url using `- 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 web server, you can use the `--watch-only` flag. Before starting, Zola will delete the `public` directory to start from a clean slate. diff --git a/docs/content/documentation/getting-started/configuration.md b/docs/content/documentation/getting-started/configuration.md index b4368323..be8220b8 100644 --- a/docs/content/documentation/getting-started/configuration.md +++ b/docs/content/documentation/getting-started/configuration.md @@ -9,7 +9,7 @@ It follows the philosophy of paying for only what you need, almost everything is 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). -⚠️ If you add keys to your `config.toml`, you must pay attention to which toml section it belongs to. +⚠️ If you add keys to your `config.toml`, you must pay attention to which TOML section it belongs to. Here are the current `config.toml` sections: 1. main (unnamed) @@ -46,8 +46,8 @@ highlight_theme = "base16-ocean-dark" generate_feed = false # The filename to use for the feed. Used as the template filename, too. -# Defaults to "atom.xml", which has a builtin template that renders an Atom 1.0 feed. -# There is also a builtin template "rss.xml" that renders an RSS 2.0 feed. +# Defaults to "atom.xml", which has a built-in template that renders an Atom 1.0 feed. +# There is also a built-in template "rss.xml" that renders an RSS 2.0 feed. # feed_filename = "atom.xml" # The number of articles to include in the feed. All items are included if @@ -57,7 +57,7 @@ generate_feed = false # 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. +# files are always copied, regardless of this setting. # hard_link_static = false # The taxonomies to be rendered for the site and their configuration. @@ -111,7 +111,7 @@ skip_anchor_prefixes = [ ] # Various slugification strategies, see below for details -# Defauls to everything being a slug +# Defaults to everything being a slug [slugify] paths = "on" taxonomies = "on" diff --git a/docs/content/documentation/getting-started/overview.md b/docs/content/documentation/getting-started/overview.md index 38e54798..06e590dd 100644 --- a/docs/content/documentation/getting-started/overview.md +++ b/docs/content/documentation/getting-started/overview.md @@ -45,7 +45,7 @@ You will be asked a few questions. └── themes ``` -Let's start the zola development server with: +Let's start the Zola development server with: ```bash $ zola serve @@ -161,7 +161,7 @@ date = 2019-11-27 This is my first blog post. ``` -The *title* and *date* will be avaiable to us in the `blog-page.html` template as `{{ page.title }}` and `{{ page.date }}`, respectively. All text below the closing `+++` will be available to us as `{{ page.content }}`. +The *title* and *date* will be available to us in the `blog-page.html` template as `{{ page.title }}` and `{{ page.date }}`, respectively. All text below the closing `+++` will be available to us as `{{ page.content }}`. We now need to make the `blog-page.html` template. In the `templates` directory, create this file with the contents: diff --git a/docs/content/documentation/templates/overview.md b/docs/content/documentation/templates/overview.md index 8921c213..79245161 100644 --- a/docs/content/documentation/templates/overview.md +++ b/docs/content/documentation/templates/overview.md @@ -118,7 +118,7 @@ link like the ones used in Markdown, starting from the root `content` directory. {% set url = get_url(path="@/blog/_index.md") %} ``` -It accepts an optionnal parameter `lang` in order to compute a *language-aware URL* in multilingual websites. Assuming `config.base_url` is `"http://example.com"`, the following snippet will: +It accepts an optional parameter `lang` in order to compute a *language-aware URL* in multilingual websites. Assuming `config.base_url` is `"http://example.com"`, the following snippet will: - return `"http://example.com/blog/"` if `config.default_language` is `"en"` - return `"http://example.com/en/blog/"` if `config.default_language` is **not** `"en"` and `"en"` appears in `config.languages` @@ -260,4 +260,4 @@ Gets the translation of the given `key`, for the `default_language` or the `lang ### `resize_image` Resizes an image file. -Pease refer to [_Content / Image Processing_](@/documentation/content/image-processing/index.md) for complete documentation. +Please refer to [_Content / Image Processing_](@/documentation/content/image-processing/index.md) for complete documentation. diff --git a/docs/content/documentation/themes/installing-and-using-themes.md b/docs/content/documentation/themes/installing-and-using-themes.md index 49399664..e16c4827 100644 --- a/docs/content/documentation/themes/installing-and-using-themes.md +++ b/docs/content/documentation/themes/installing-and-using-themes.md @@ -31,7 +31,7 @@ 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` +Any file from the theme can be overridden by creating a file with the same path and name in your `templates` or `static` directory. Here are a few examples of that, assuming that the theme name is `simple-blog`: ```plain @@ -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 overridden. 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: