diff options
| author | Anthony Fok <foka@debian.org> | 2015-08-04 12:00:08 -0600 |
|---|---|---|
| committer | Anthony Fok <foka@debian.org> | 2015-08-04 12:00:08 -0600 |
| commit | 5505ac0d72d53e49df67fabed2446344d3fe52ee (patch) | |
| tree | 7118daa018d9d49b9836112107651cd5e392c1ea | |
| parent | b0416e9befb98c916f2fd80c2bcbb9cde5b72f95 (diff) | |
doc: Strip trailing whitespace; other revisions
Make some random and non-comprehensive changes to the
template functions documentation to make them more
consistent.
29 files changed, 217 insertions, 206 deletions
@@ -101,7 +101,7 @@ We welcome your contributions. To make the process as seamless as possible, we a * Run `go fmt` * Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request. * This [blog article](http://chris.beams.io/posts/git-commit/) is a good resource for learning how to write good commit messages, the most important part being that each commit message should have a title/subject in imperative mode without trailing period: *"Return error on wrong use of the Paginator"*, **NOT** *"Returning some error."* Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*. Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*. - * Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) (Linux) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing. + * Make sure `go test ./...` passes, and `go build` completes. Our [Travis CI loop](https://travis-ci.org/spf13/hugo) (Linux) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing. ### Building Hugo with Your Changes diff --git a/docs/content/content/organization.md b/docs/content/content/organization.md index 9a218c0f8..aa6b9ed49 100644 --- a/docs/content/content/organization.md +++ b/docs/content/content/organization.md @@ -145,12 +145,12 @@ When a `url` is provided, it will be used exactly. Using `url` will ignore the **section** = which type the content is by default -* based on content location +* based on content location * front matter overrides **slug** = name.ext or name/ -* based on content-name.md +* based on content-name.md * front matter overrides **path** = section + path to file excluding slug diff --git a/docs/content/extras/aliases.md b/docs/content/extras/aliases.md index 830e81ef8..23af612e2 100644 --- a/docs/content/extras/aliases.md +++ b/docs/content/extras/aliases.md @@ -19,11 +19,11 @@ Luckily, redirects can be handled easily with _aliases_ in Hugo. ## Example -Given a post on your current Hugo site, with a path of: +Given a post on your current Hugo site, with a path of: ``content/posts/my-awesome-blog-post.md`` -... you create an "aliases" section in the frontmatter of your post, and add previous paths to that. +... you create an "aliases" section in the frontmatter of your post, and add previous paths to that. ### TOML frontmatter @@ -50,7 +50,7 @@ aliases: --- ~~~ -Now when you visit any of the locations specified in aliases, _assuming the same site domain_, you'll be redirected to the page they are specified on. +Now when you visit any of the locations specified in aliases, _assuming the same site domain_, you'll be redirected to the page they are specified on. ## Important Behaviors @@ -63,9 +63,9 @@ any content with the same location.* ## How Hugo Aliases Work -When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target. +When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target. -Assuming a baseurl of `mysite.tld`, the contents of the html file will look something like: +Assuming a baseurl of `mysite.tld`, the contents of the html file will look something like: ~~~html <!DOCTYPE html> diff --git a/docs/content/extras/comments.md b/docs/content/extras/comments.md index 6be5ade44..c969b91b5 100644 --- a/docs/content/extras/comments.md +++ b/docs/content/extras/comments.md @@ -80,7 +80,7 @@ A few alternatives exist to [Disqus](https://disqus.com/): * [isso](http://posativ.org/isso/) (Self-hosted, Python) * [Kaiju](https://github.com/spf13/kaiju) -## Kaiju +## Kaiju [Kaiju](https://github.com/spf13/kaiju) is an open-source project started by [spf13](http://spf13.com/) (Hugo’s author) to bring easy and fast real time discussions to the web. diff --git a/docs/content/extras/datafiles.md b/docs/content/extras/datafiles.md index 983b7bbb1..bec4f7dd2 100644 --- a/docs/content/extras/datafiles.md +++ b/docs/content/extras/datafiles.md @@ -23,7 +23,7 @@ Data Files can also be used in [themes](/themes/overview/), but note: If the sam As explained in [Source Organization](/overview/source-directory/), the `data` folder is where you can store additional data for Hugo to use when generating your site. These files must be YAML, JSON or TOML files (using either the `.yml`, `.yaml`, `.json` or `toml` extension) and the data will be accessible as a `map` in `.Site.Data`. -**The keys in this map will be a dot chained set of _path_, _filename_ and _key_ in file (if applicable).** +**The keys in this map will be a dot chained set of _path_, _filename_ and _key_ in file (if applicable).** This is best explained with an example: @@ -56,7 +56,7 @@ discography = [ "1991 - Live In New York City, Volumes 1-7.", "1999 - Rare Collection (compilation)", "2003 - Punk Jazz: The Jaco Pastorius Anthology (compilation)", -"2007 - The Essential Jaco Pastorius (compilation)" +"2007 - The Essential Jaco Pastorius (compilation)" ] ``` @@ -101,4 +101,4 @@ To render the `Short Description` in your `layout` File following code is requir <div>Short Description of {{.Site.Data.User0123.Name}}: <p>{{ index .Site.Data.User0123 "Short Description" | markdownify }}</p></div> ``` -Note the use of the `markdownify` template function. This will send the description through the Blackfriday Markdown rendering engine.
\ No newline at end of file +Note the use of the `markdownify` template function. This will send the description through the Blackfriday Markdown rendering engine. diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md index 2c3f37641..5ffaaf45d 100644 --- a/docs/content/extras/highlighting.md +++ b/docs/content/extras/highlighting.md @@ -12,9 +12,9 @@ weight: 90 toc: true --- -Hugo provides the ability for you to highlight source code in _two different ways_ — either pre-processed server side from your content, or to defer the processing to the client side, using a JavaScript library. +Hugo provides the ability for you to highlight source code in _two different ways_ — either pre-processed server side from your content, or to defer the processing to the client side, using a JavaScript library. -**The advantage of server side** is that it doesn’t depend on a JavaScript library and consequently works very well when read from an RSS feed. +**The advantage of server side** is that it doesn’t depend on a JavaScript library and consequently works very well when read from an RSS feed. **The advantage of client side** is that it doesn’t cost anything when building your site and some of the highlighting scripts available cover more languages than Pygments does. @@ -38,7 +38,7 @@ Hugo gives you two options that you can set with the variable `pygmentsuseclasse ### Usage -Highlighting is carried out via the in-built shortcode `highlight`. `highlight` takes exactly one required parameter of language, and requires a closing shortcode. Note that `highlight` is _not_ used for client-side javascript highlighting. +Highlighting is carried out via the in-built shortcode `highlight`. `highlight` takes exactly one required parameter of language, and requires a closing shortcode. Note that `highlight` is _not_ used for client-side javascript highlighting. ### Example @@ -88,7 +88,7 @@ The keywords are the same you would using with Pygments from the command line, s ### Disclaimers - * Pygments is relatively slow and _causes a performance hit when building your site_, but Hugo has been designed to cache the results to disk. + * Pygments is relatively slow and _causes a performance hit when building your site_, but Hugo has been designed to cache the results to disk. * Languages available depends on your Pygments installation. ## Client-side @@ -118,7 +118,7 @@ In your `./layouts/partials/` (or `./layouts/chrome/`) folder, depending on your ### Prism example -Prism is another popular highlighter library, used on some major sites. Similar to Highlight.js, you simply load `prism.css` in your `<head>` via whatever Hugo partial template is creating that part of your pages, like so: +Prism is another popular highlighter library, used on some major sites. Similar to Highlight.js, you simply load `prism.css` in your `<head>` via whatever Hugo partial template is creating that part of your pages, like so: ```html ... @@ -126,7 +126,7 @@ Prism is another popular highlighter library, used on some major sites. Similar ... ``` -... and add `prism.js` near the bottom of your `<body>` tag, again in whatever Hugo partial template is appropriate for your site or theme. +... and add `prism.js` near the bottom of your `<body>` tag, again in whatever Hugo partial template is appropriate for your site or theme. ```html ... @@ -139,9 +139,9 @@ In this example, the local paths indicate that your own copy of these files are ### Using Client-side highlighting -To use client-side highlighting, most of these javascript libraries expect your code to be wrapped in semantically correct `<code>` tags, with the language expressed in a class attribute on the `<code>` tag, such as `class="language-abc"`, where the `abc` is the code the highlighter script uses to represent that language. +To use client-side highlighting, most of these javascript libraries expect your code to be wrapped in semantically correct `<code>` tags, with the language expressed in a class attribute on the `<code>` tag, such as `class="language-abc"`, where the `abc` is the code the highlighter script uses to represent that language. -The script would be looking for classes like `language-go`, `language-html`, or `language-css`. If you look at the page's source, it would be marked up like so: +The script would be looking for classes like `language-go`, `language-html`, or `language-css`. If you look at the page's source, it would be marked up like so: ~~~html <pre> diff --git a/docs/content/extras/localfiles.md b/docs/content/extras/localfiles.md index 843082df9..2cfcda49e 100644 --- a/docs/content/extras/localfiles.md +++ b/docs/content/extras/localfiles.md @@ -14,14 +14,14 @@ weight: 110 ## Traversing Local Files -Hugo includes a way to traverse local files. -This is done using the 'ReadDir' function. +Hugo includes a way to traverse local files. +This is done using the 'ReadDir' function. ## Using ReadDir ReadDir takes a single string input that is relative to the root directory of the site. It returns an array of [os.FileInfo](https://golang.org/pkg/os/#FileInfo) -Let's create a shortcode to build a file index with links using ReadDir. +Let's create a shortcode to build a file index with links using ReadDir. 'fileindex.html' @@ -38,7 +38,7 @@ Let's create a shortcode to build a file index with links using ReadDir. <td> <a href="{{$url}}{{.Name | urlize }}"> {{.Name}}</a> </td> - </tr> + </tr> {{ end }} </table> diff --git a/docs/content/extras/menus.md b/docs/content/extras/menus.md index 9daaff609..99fdc753c 100644 --- a/docs/content/extras/menus.md +++ b/docs/content/extras/menus.md @@ -11,7 +11,7 @@ weight: 60 --- Hugo has a simple yet powerful menu system that permits content to be -placed in menus with a good degree of control without a lot of work. +placed in menus with a good degree of control without a lot of work. *TIP:* If all you want is a simple menu for your sections, see [Section Menu for "the Lazy Blogger"]({{< relref "#section-menu-for-the-lazy-blogger" >}}). @@ -121,11 +121,11 @@ And the equivalent example `config.yaml`: Pre: "<i class='fa fa-road'></i>" Weight: -100 URL: "/getting-started/" - --- + --- **NOTE:** The URLs must be relative to the context root. If the `BaseURL` is `http://example.com/mysite/`, then the URLs in the menu must not include the context root `mysite`. - + ## Nesting All nesting of content is done via the `parent` field. @@ -146,7 +146,7 @@ and all content entries are attached to one of these entries via the Hugo makes no assumptions about how your rendered HTML will be structured. Instead, it provides all of the functions you will need to be -able to build your menu however you want. +able to build your menu however you want. The following is an example: @@ -213,7 +213,7 @@ This will create a menu with all the sections as menu items and all the sections In the above, the menu item is marked as active if on the current section's list page or on a page in that section. -The above is all that's needed. But if you want custom menu items, e.g. changing weight or name, you can define them manually in the site config, i.e. `config.toml`: +The above is all that's needed. But if you want custom menu items, e.g. changing weight or name, you can define them manually in the site config, i.e. `config.toml`: ``` [[menu.main]] diff --git a/docs/content/extras/shortcodes.md b/docs/content/extras/shortcodes.md index 4ef7ec81f..b4f8ab466 100644 --- a/docs/content/extras/shortcodes.md +++ b/docs/content/extras/shortcodes.md @@ -200,7 +200,7 @@ A shortcode with `.Inner` content can be used wihout the inline content, and wit The variable `.Params` contains the list of parameters in case you need to do more complicated things than `.Get`. -You can also use the variable `.Page` to access all the normal [Page Variables](/templates/variables/). +You can also use the variable `.Page` to access all the normal [Page Variables](/templates/variables/). ## Single Positional Example: youtube diff --git a/docs/content/extras/urls.md b/docs/content/extras/urls.md index 20bf27d8b..ccbcdf225 100644 --- a/docs/content/extras/urls.md +++ b/docs/content/extras/urls.md @@ -28,7 +28,7 @@ or use the `--uglyUrls=true` flag on the command line. If you want a specific piece of content to have an exact URL, you can specify this in the front matter under the `url` key. See [Content -Organization](/content/organization/) for more details. +Organization](/content/organization/) for more details. ## Canonicalization diff --git a/docs/content/meta/release-notes.md b/docs/content/meta/release-notes.md index 30470ead8..14908b2b3 100644 --- a/docs/content/meta/release-notes.md +++ b/docs/content/meta/release-notes.md @@ -47,7 +47,7 @@ them](https://github.com/spf13/hugoThemes/blob/master/README.md#theme-list). Hugo also depends on a lot of other great projects. A big thanks to all of our dependencies inclding: [cobra](https://github.com/spf13/cobra), -[viper](https://github.com/spf13/viper), +[viper](https://github.com/spf13/viper), [blackfriday](https://github.com/russross/blackfriday), [pflag](https://github.com/spf13/pflag), [HugoThemes](https://github.com/spf13/hugothemes), @@ -55,10 +55,10 @@ Hugo also depends on a lot of other great projects. A big thanks to all of our d [goYaml](https://github.com/go-yaml/yaml/tree/v2), and the Go standard library. ## New features -* Support for all file types in content directory. +* Support for all file types in content directory. * If dedicated file type handler isn’t found it will be copied to the destination. * Add `AsciiDoc` support using external helpers. -* Add experimental support for [`Mmark`](https://github.com/miekg/mmark) markdown processor +* Add experimental support for [`Mmark`](https://github.com/miekg/mmark) markdown processor * Bash autocomplete support via `genautocomplete` command * Add section menu support for a [Section Menu for "the Lazy Blogger"]({{< relref "extras/menus.md#section-menu-for-the-lazy-blogger" >}}) * Add support for `Ace` base templates @@ -70,7 +70,7 @@ Hugo also depends on a lot of other great projects. A big thanks to all of our d * `absURL` and `relURL`, both of which takes the `BaseURL` setting into account ## Improvements -* Highlighting with `Pygments` is now cached to disk -- expect a major speed boost if you use it! +* Highlighting with `Pygments` is now cached to disk -- expect a major speed boost if you use it! * More Pygments highlighting options, including `line numbers` * Show help information to Windows users who try to double click on `hugo.exe`. * Add `bind` flag to `hugo server` to set the interface to which the server will bind @@ -82,7 +82,7 @@ Hugo also depends on a lot of other great projects. A big thanks to all of our d ## Bugfixes * Fix panic with paginator and zero pages in result set. * Fix crossrefs on Windows. -* Fix `eq` and `ne` template functions when used with a raw number combined with the result of `add`, `sub` etc. +* Fix `eq` and `ne` template functions when used with a raw number combined with the result of `add`, `sub` etc. * Fix paginator with uglyurls * Fix [#998](https://github.com/spf13/hugo/issues/988), supporting UTF8 characters in Permalinks. @@ -125,7 +125,7 @@ maintainers and their tremendous contributions this release. * `Scratch` -- [a "scratchpad"](/extras/scratch) for your node- and page-scoped variables * [Cross Reference](/extras/crossreferences/) support to easily link documents - together with the ref and relref shortcodes. + together with the ref and relref shortcodes. * [Ace](http://ace.yoss.si/) template engine support ([#541][]) * A new [shortcode](/extras/shortcodes/) token of `{{</* */>}}` (raw HTML) alongside the existing `{{%/* */%}}` (Markdown) @@ -143,7 +143,7 @@ maintainers and their tremendous contributions this release. ### Notable enhancements to existing features * The [shortcode](/extras/shortcodes/) handling is rewritten for speed and - better error messages. + better error messages. * Several improvements to the [template functions](/templates/functions/): * `where` is now even more powerful and accepts SQL-like syntax with the operators `==`, `eq`; `!=`, `<>`, `ne`; `>=`, `ge`; `>`, `gt`; `<=`, @@ -156,7 +156,7 @@ maintainers and their tremendous contributions this release. * `delimit` * `sort` * `markdownify` - * `in` and `intersect` + * `in` and `intersect` * `trim` * `replace` * `dateFormat` diff --git a/docs/content/overview/configuration.md b/docs/content/overview/configuration.md index 8b7c84aed..84aa7b8ca 100644 --- a/docs/content/overview/configuration.md +++ b/docs/content/overview/configuration.md @@ -80,7 +80,7 @@ Following is a list of Hugo-defined variables that you can configure and their c # include content with publishdate in the future buildFuture: false # enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. - relativeURLs: false + relativeURLs: false canonifyURLs: false # config file (default is path/config.yaml|json|toml) config: "config.toml" diff --git a/docs/content/overview/usage.md b/docs/content/overview/usage.md index b3fdfc7b5..b340a5adf 100644 --- a/docs/content/overview/usage.md +++ b/docs/content/overview/usage.md @@ -15,16 +15,16 @@ weight: 30 Make sure either `hugo` is in your `PATH` or provide a path to it. <pre><code class="hljs nohighlight">$ hugo help - + Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io -Usage: +Usage: hugo [flags] hugo [command] -Available Commands: +Available Commands: server Hugo runs its own webserver to render the files version Print the version number of Hugo config Print the site configuration diff --git a/docs/content/showcase/arianv.md b/docs/content/showcase/arianv.md index 96d8512ac..24f14b298 100644 --- a/docs/content/showcase/arianv.md +++ b/docs/content/showcase/arianv.md @@ -9,5 +9,5 @@ tags: - personal - blog thumbnail: /img/arianv-tn.png -title: Arian's Portfolio +title: Arian's Portfolio --- diff --git a/docs/content/taxonomies/overview.md b/docs/content/taxonomies/overview.md index ed5d287c3..caa4ade27 100644 --- a/docs/content/taxonomies/overview.md +++ b/docs/content/taxonomies/overview.md @@ -37,7 +37,7 @@ and all of the content attached to those terms. **Taxonomy:** A categorization that can be used to classify content -**Term:** A key within that taxonomy +**Term:** A key within that taxonomy **Value:** A piece of content assigned to that Term diff --git a/docs/content/templates/404.md b/docs/content/templates/404.md index cac845459..4c3f29dc9 100644 --- a/docs/content/templates/404.md +++ b/docs/content/templates/404.md @@ -15,7 +15,9 @@ weight: 100 --- When using Hugo with [GitHub Pages](http://pages.github.com/), you can provide -your own template for a [custom 404 error page](https://help.github.com/articles/custom-404-pages/) by creating a 404.html template file in your `/layouts` folder. When Hugo generates your site, the `404.html` file will be placed in the root. +your own template for a [custom 404 error page](https://help.github.com/articles/custom-404-pages/) +by creating a 404.html template file in your `/layouts` folder. +When Hugo generates your site, the `404.html` file will be placed in the root. 404 pages are of the type **"node"** and have all the [node variables](/layout/variables/) available to use in the templates. @@ -43,10 +45,10 @@ This is a basic example of a 404.html template: ### Automatic Loading -Your 404.html file can be set to load automatically when a visitor enters a mistaken URL path, dependent upon the web serving environment you are using. For example: +Your 404.html file can be set to load automatically when a visitor enters a mistaken URL path, dependent upon the web serving environment you are using. For example: -* _Github Pages_ - it's automatic. +* _GitHub Pages_ - it's automatic. * _Apache_ - one way is to specify `ErrorDocument 404 /404.html` in an `.htaccess` file in the root of your site. -* _Nginx_ - you might specify `error_page 404 = /404.html;` in your `nginx.conf` file. +* _Nginx_ - you might specify `error_page 404 = /404.html;` in your `nginx.conf` file. * _Amazon AWS S3_ - when setting a bucket up for static web serving, you can specify the error file. diff --git a/docs/content/templates |