From 1a6edbcf63a96f3db0ed9f9230368e2bb132f707 Mon Sep 17 00:00:00 2001 From: Vincent Prouillet Date: Tue, 26 Nov 2019 20:18:59 +0100 Subject: [PATCH] Fix some doc changes --- .../content/documentation/content/image-processing/index.md | 2 +- docs/content/documentation/content/linking.md | 2 +- docs/content/documentation/content/overview.md | 2 +- docs/content/documentation/content/page.md | 4 ++-- docs/content/documentation/content/sass.md | 6 +++--- docs/content/documentation/content/section.md | 4 ++-- docs/content/documentation/deployment/netlify.md | 2 +- docs/content/documentation/getting-started/cli-usage.md | 2 +- 8 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/content/documentation/content/image-processing/index.md b/docs/content/documentation/content/image-processing/index.md index e26f2dd4..bd860c37 100644 --- a/docs/content/documentation/content/image-processing/index.md +++ b/docs/content/documentation/content/image-processing/index.md @@ -121,7 +121,7 @@ The `resize_image()` can be used multiple times and/or in loops. It is designed This can be used along with `assets` [page metadata](@/documentation/templates/pages-sections.md) to create picture galleries. The `assets` variable holds paths to all assets in the directory of a page with resources -(see [asset co-location](@/documentation/content/overview.md#asset-co-location)); if you have files other than images you +(see [asset colocation](@/documentation/content/overview.md#asset-colocation)); if you have files other than images you will need to filter them out in the loop first like in the example below. This can be used in shortcodes. For example, we can create a very simple html-only clickable diff --git a/docs/content/documentation/content/linking.md b/docs/content/documentation/content/linking.md index 3416d466..793f7087 100644 --- a/docs/content/documentation/content/linking.md +++ b/docs/content/documentation/content/linking.md @@ -28,7 +28,7 @@ can also be useful for migration of existing sites with different header id sche links working. ## Anchor insertion -It is possible to have Zola automatically insert anchor links next to the heading, as you can see on this site +It is possible to have Zola automatically insert anchor links next to the heading, as you can see on this documentation if you hover a title. This option is set at the section level: the `insert_anchor_links` variable on the diff --git a/docs/content/documentation/content/overview.md b/docs/content/documentation/content/overview.md index 239acd97..560c8e99 100644 --- a/docs/content/documentation/content/overview.md +++ b/docs/content/documentation/content/overview.md @@ -37,7 +37,7 @@ one page (`something.md`), the `landing` section has no pages and the `blog` sec Sections can be nested indefinitely. -## Asset co-location +## Asset colocation The `content` directory is not limited to markup files. It's natural to want to co-locate a page and some related assets, such as images or spreadsheets. Zola supports this pattern out of the box for both sections and pages. diff --git a/docs/content/documentation/content/page.md b/docs/content/documentation/content/page.md index d614d081..bd1b3781 100644 --- a/docs/content/documentation/content/page.md +++ b/docs/content/documentation/content/page.md @@ -25,7 +25,7 @@ character in a filename on Windows. As you can see, creating an `about.md` file is equivalent to creating an `about/index.md` file. The only difference between the two methods is that creating the `about` directory allows you to use asset co-location, as discussed in the -[overview](@/documentation/content/overview.md#asset-co-location) section. +[overview](@/documentation/content/overview.md#asset-colocation) section. ## Front matter @@ -37,7 +37,7 @@ Although none of the front matter variables are mandatory, the opening and closi Here is an example page with all the available variables. The values provided below are the default values. -```TOML +```toml title = "" description = "" diff --git a/docs/content/documentation/content/sass.md b/docs/content/documentation/content/sass.md index 37698b57..634bfc54 100644 --- a/docs/content/documentation/content/sass.md +++ b/docs/content/documentation/content/sass.md @@ -34,9 +34,9 @@ structure and base name into the `public` folder: Files with a leading underscore in the name are not placed into the `public` folder, but can still be used as `@import` dependencies. For more information, see the "Partials" section of -[Sass Basics](https://sass-lang.com/guide#partials). +[Sass Basics](https://sass-lang.com/guide). -Files with the `scss` extension use ["Sassy CSS" syntax](http://sass-lang.com/documentation/#Formatting), -while files with the `sass` extension use the ["indented" syntax](http://sass-lang.com/documentation/file.INDENTED_SYNTAX.html). +Files with the `scss` extension use "Sassy CSS" syntax, +while files with the `sass` extension use the "indented" syntax: . Zola will return an error if `scss` and `sass` files with the same base name exist in the same folder to avoid confusion -- see the example above. diff --git a/docs/content/documentation/content/section.md b/docs/content/documentation/content/section.md index 3fc4252c..ae1a8bb7 100644 --- a/docs/content/documentation/content/section.md +++ b/docs/content/documentation/content/section.md @@ -15,7 +15,7 @@ not have any content or metadata. If you would like to add content or metadata, `_index.md` file; your `index.html` template will then have access to that content and metadata. Any non-Markdown file in a section directory is added to the `assets` collection of the section, as explained in the -[content overview](@/documentation/content/overview.md#asset-co-location). These files are then available in the +[content overview](@/documentation/content/overview.md#asset-colocation). These files are then available in the Markdown file using relative links. ## Front matter @@ -34,7 +34,7 @@ Here is an example `_index.md` with all the available variables. The values prov default values. -```TOML +```toml title = "" description = "" diff --git a/docs/content/documentation/deployment/netlify.md b/docs/content/documentation/deployment/netlify.md index d2c3f275..64029913 100644 --- a/docs/content/documentation/deployment/netlify.md +++ b/docs/content/documentation/deployment/netlify.md @@ -28,7 +28,7 @@ However, if you want to use everything that Netlify gives you, you should also p 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] # 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. diff --git a/docs/content/documentation/getting-started/cli-usage.md b/docs/content/documentation/getting-started/cli-usage.md index a70300d4..8ba95d3f 100644 --- a/docs/content/documentation/getting-started/cli-usage.md +++ b/docs/content/documentation/getting-started/cli-usage.md @@ -1,6 +1,6 @@ +++ title = "CLI usage" -weight = 20 +weight = 2 +++ Zola only has 4 commands: `init`, `build`, `serve` and `check`.