From b0470688f14bc964f4928a812f4c3dbd6123e2e7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B8rn=20Erik=20Pedersen?= Date: Mon, 17 Jul 2017 21:11:02 +0200 Subject: [PATCH] Use infinitive mood for titles Fixes #46 --- content/content-management/archetypes.md | 10 ++++---- content/content-management/authors.md | 10 ++++---- content/content-management/comments.md | 8 +++---- .../content-management/cross-references.md | 2 +- content/content-management/formats.md | 8 +++---- content/content-management/front-matter.md | 4 ++-- content/content-management/menus.md | 8 +++---- content/content-management/multilingual.md | 2 +- content/content-management/organization.md | 2 +- content/content-management/shortcodes.md | 6 ++--- content/content-management/taxonomies.md | 8 +++---- content/content-management/types.md | 6 ++--- content/content-management/urls.md | 5 ++-- content/contribute/development.md | 24 +++++++++---------- content/contribute/documentation.md | 8 +++---- content/functions/format.md | 2 +- content/functions/math.md | 2 +- content/functions/where.md | 6 ++--- content/getting-started/configuration.md | 6 ++--- content/getting-started/installing.md | 14 +++++------ content/getting-started/quick-start.md | 2 +- content/getting-started/usage.md | 6 ++--- .../deployment-with-rsync.md | 2 +- .../deployment-with-wercker.md | 24 +++++++++---------- .../hosting-on-github.md | 12 +++++----- .../hosting-on-netlify.md | 4 ++-- content/readfiles/dateformatting.md | 2 +- content/templates/base.md | 4 ++-- content/templates/data-templates.md | 6 ++--- content/templates/files.md | 6 ++--- content/templates/homepage.md | 2 +- content/templates/internal.md | 8 +++---- content/templates/introduction.md | 6 ++--- content/templates/lists.md | 12 +++++----- content/templates/ordering-and-grouping.md | 12 +++++----- content/templates/output-formats.md | 4 ++-- content/templates/pagination.md | 4 ++-- content/templates/partials.md | 2 +- content/templates/rss.md | 4 ++-- content/templates/section-templates.md | 2 +- content/templates/shortcode-templates.md | 4 ++-- content/templates/sitemap-template.md | 2 +- content/templates/taxonomy-templates.md | 14 +++++------ content/templates/views.md | 2 +- content/themes/customizing.md | 6 ++--- content/themes/installing-and-using-themes.md | 8 +++---- content/variables/page.md | 2 +- content/variables/taxonomy.md | 2 +- 48 files changed, 151 insertions(+), 154 deletions(-) diff --git a/content/content-management/archetypes.md b/content/content-management/archetypes.md index f58f5aeee..d6d30b3f3 100644 --- a/content/content-management/archetypes.md +++ b/content/content-management/archetypes.md @@ -84,7 +84,7 @@ Similar to the [lookup order for templates][lookup] in your `layouts` directory, If you wish to use archetypes that ship with a theme, the `theme` field must be specified in your [configuration file](/getting-started/configuration/). {{% /note %}} -## Choosing Your Archetype's Front Matter Format +## Choose Your Archetype's Front Matter Format By default, `hugo new` content files include front matter in the TOML format regardless of the format used in `archetypes/*.md`. @@ -94,7 +94,7 @@ You can specify a different default format in your site [configuration file][] f Default archetypes are convenient if your content's front matter stays consistent across multiple [content sections][sections]. -### Creating the Default Archetype +### Create the Default Archetype When you create a new Hugo project using `hugo new site`, you'll notice that Hugo has already scaffolded a file at `archetypes/default.md`. @@ -113,7 +113,7 @@ categories = ["web development"] If you get an `EOF error` when using `hugo new`, add a carriage return after the closing `+++` or `---` for your TOML or YAML front matter, respectively. (See the [troubleshooting article on EOF errors](/troubleshooting/eof-error/) for more information.) {{% /warning %}} -### Using the Default Archetype +### Use the Default Archetype With an `archetypes/default.md` in place, we can use the CLI to create a new post in the `posts` content section: @@ -146,7 +146,7 @@ You may notice that content files created with `hugo new` do not respect the ord Suppose your site's `posts` section requires more sophisticated front matter than what has been specified in `archetypes/default.md`. You can create a custom archetype for your posts at `archetypes/posts.md` that includes the full set of front matter to be added to the two default archetypes fields. -### Creating a Custom Archetype +### Create a Custom Archetype {{% code file="archetypes/posts.md"%}} ```toml @@ -158,7 +158,7 @@ categories = "" ``` {{% /code %}} -### Using a Custom Archetype +### Use a Custom Archetype With an `archetypes/posts.md` in place, you can use the Hugo CLI to create a new post with your preconfigured front matter in the `posts` content section: diff --git a/content/content-management/authors.md b/content/content-management/authors.md index 741a1e8c3..80a783912 100644 --- a/content/content-management/authors.md +++ b/content/content-management/authors.md @@ -63,7 +63,7 @@ The `social` section contains all the links to the social network accounts of an The `params` section can contain arbitrary data much like the same-named section in the config file. What it contains is up to you. -## Associating Content Through Identifiers +## Associate Content Through Identifiers Earlier it was mentioned that content can be associated with an author through their corresponding identifier. In our case, blogger Alice has the identifier `alice`. In the front matter of a content file, you can create a list of identifiers and assign it to the `authors` variable. Here are examples for `alice` using YAML and TOML, respectively. @@ -89,7 +89,7 @@ Nothing to read here. Move along... Future authors who might work on this blog post can append their identifiers to the `authors` array in the front matter as well. -## Working with Templates +## Work with Templates After a successful setup it's time to give some credit to the authors by showing them on the website. Within the templates Hugo provides a list of the author's profiles if they are listed in the `authors` variable within the front matter. @@ -108,7 +108,7 @@ Even if there are co-authors you may only want to show the main author. For this You can find a list of all template variables to access the profile information in [Author Variables](/variables/authors/). {{% /note %}} -### Linking Social Network Accounts +### Link Social Network Accounts As aforementioned, Hugo is able to generate links to profiles of the most popular social networks. The following social networks with their corrersponding identifiers are supported: `github`, `facebook`, `twitter`, `googleplus`, `pinterest`, `instagram`, `youtube` and `linkedin`. @@ -148,7 +148,7 @@ taxonomies: ``` -### Listing All Authors +### List All Authors In the next step we can create a template to list all authors of your website. Later, the list can be accessed at `www.example.com/authors/`. Create a new template in the `layouts/taxonomy/` directory called `authors.term.html`. This template will be exclusively used for this taxonomy. @@ -169,7 +169,7 @@ In the next step we can create a template to list all authors of your website. L `.Data.Terms` contains the identifiers of all authors and we can range over it to create a list with all author names. The `$profile` variable gives us access to the profile of the current author. This allows you to generate a nice info box with a thumbnail, a biography and social media links, like at the [end of a blog post](#linking-social-network-accounts-automatically). -### Listing Each Author's Publications +### List Each Author's Publications Last but not least, we have to create the second list that contains all publications of an author. Each list will be shown in its own page and can be accessed at `www.example.com/authors/`. Replace `` with a valid author identifier like `alice`. diff --git a/content/content-management/comments.md b/content/content-management/comments.md index 33009f32b..33387e570 100644 --- a/content/content-management/comments.md +++ b/content/content-management/comments.md @@ -21,11 +21,11 @@ Hugo ships with support for [Disqus](https://disqus.com/), a third-party service Your theme may already support Disqus, but if not, it is easy to add to your templates via [Hugo's built-in Disqus partial][disquspartial]. -## Adding Disqus +## Add Disqus Hugo comes with all the code you need to load Disqus into your templates. Before adding Disqus to your site, you'll need to [set up an account][disqussetup]. -### Configuring Disqus +### Configure Disqus Disqus comments require you set a single value in your [site's configuration file][configuration]. The following show the configuration variable in a `config.toml` and `config.yml`, respectively: @@ -43,11 +43,11 @@ For many websites, this is enough configuration. However, you also have the opti * `disqus_title` * `disqus_url` -### Rendering Hugo's Built-in Disqus Partial Template +### Render Hugo's Built-in Disqus Partial Template See [Partial Templates][partials] to learn how to add the Disqus partial to your Hugo website's templates. -## Commenting Alternatives +## Comments Alternatives There are a few alternatives to commenting on static sites for those who do not want to use Disqus: diff --git a/content/content-management/cross-references.md b/content/content-management/cross-references.md index fc12ea094..9a2795330 100644 --- a/content/content-management/cross-references.md +++ b/content/content-management/cross-references.md @@ -18,7 +18,7 @@ toc: true The `ref` and `relref` shortcodes link documents together, both of which are [built-in Hugo shortcodes][]. These shortcodes are also used to provide links to headings inside of your content, whether across documents or within a document. The only difference between `ref` and `relref` is whether the resulting URL is absolute (`http://1.com/about/`) or relative (`/about/`), respectively. -## Using `ref` and `relref` +## Use `ref` and `relref` ```md {{}} diff --git a/content/content-management/formats.md b/content/content-management/formats.md index ac9099426..ae6276db3 100644 --- a/content/content-management/formats.md +++ b/content/content-management/formats.md @@ -25,13 +25,13 @@ For Emacs users, [goorgeous](https://github.com/chaseadamsio/goorgeous) provides Before you begin writing your content in markdown, Blackfriday has a known issue [(#329)](https://github.com/russross/blackfriday/issues/329) with handling deeply nested lists. Luckily, there is an easy workaround. Use 4-spaces (i.e., tab) rather than 2-space indentations. {{% /note %}} -## Configuring BlackFriday Markdown Rendering +## Configure BlackFriday Markdown Rendering You can configure multiple aspects of Blackfriday as show in the following list. See the docs on [Configuration][config] for the full list of explicit directions you can give to Hugo when rendering your site. {{< readfile file="/content/readfiles/bfconfig.md" markdown="true" >}} -## Extending Markdown +## Extend Markdown Hugo provides some convenient methods for extending markdown. @@ -92,7 +92,7 @@ Hugo supports GitHub-flavored markdown's use of triple back ticks, as well as pr Mmark is a [fork of BlackFriday][mmark] and markdown superset that is well suited for writing [IETF documentation][ietf]. You can see examples of the syntax in the [Mmark GitHub repository][mmarkgh] or the full syntax on [Miek Gieben's website][]. -### Using Mmark +### Use Mmark As Hugo ships with Mmark, using the syntax is as easy as changing the extension of your content files from `.md` to `.mmark`. @@ -116,7 +116,7 @@ Thare are some features not available in Mmark; one example being that shortcode This is not an introduction into actually using MathJax to render typeset mathematics on your website. Instead, this page is a collection of tips and hints for one way to get MathJax working on a website built with Hugo. -### Enabling MathJax +### Enable MathJax The first step is to enable MathJax on pages that you would like to have typeset math. There are multiple ways to do this (adventurous readers can consult the [Loading and Configuring](http://docs.mathjax.org/en/latest/configuration.html) section of the MathJax documentation for additional methods of including MathJax), but the easiest way is to use the secure MathJax CDN by include a `