shithub: hugo

Download patch

ref: 05e42bc643f1840ed2ad9c2eff82a269d1381683
parent: 325009c3fd4ac90021897b7e3e025c14e70ce162
author: Bjørn Erik Pedersen <[email protected]>
date: Fri Nov 17 08:46:40 EST 2017

Squashed 'docs/' changes from e65df1059..a042b67b5

a042b67b5 Update installation instructions for Fedora, CentOS, Red Hat
e99dcb0b5 Document `:sections` placeholder for permalinks
f33c88a27 Fix and clarify documentation about Blackfriday extensions (mask)
5cab109c2 Add .Page.File documentation
62df7bb80 Add .Page.CurrentSection and .Page.Sections documentation
60b4414de Add .Page.Dir documentation
22038d1a8 shortcode-templates.md: Update year example
850d5ca41 Add note about theme versions in hosting-on-netlify.md
0509b8055 Update permalink example URL
c68d61d3a Mention the available 'width' argument in 'figure' shortcode
ed83b483a Update Nanobox deployment tutorial
a7422f35d shortcode-templates.md: Remove stray period
af2905fe4 Fix order of releases in news section
19d3ea064 Bump to 0.30.2
bbfa10343 Merge branch 'next'
36ed7cbe4 releaser: Prepare repository for 0.31-DEV
f689770f6 releaser: Add release notes to /docs for release of 0.30.2
0045e712a releaser: Bump versions for release of 0.30.2
a9efc3bbd Add slug to 0.30.1 relnotes
9cf47a4a1 Release 0.30.1
1fa0bb23d releaser: Prepare repository for 0.31-DEV
5582208b6 releaser: Add release notes to /docs for release of 0.30.1
09693d155 releaser: Bump versions for release of 0.30.1
58adf5d0d Merge commit '325009c3fd4ac90021897b7e3e025c14e70ce162'
4ef5dcb9b releaser: Prepare repository for 0.31-DEV
02938a788 releaser: Add release notes to /docs for release of 0.30.1
7cfd01fc6 releaser: Bump versions for release of 0.30.1
db3a68e24 Fix typo
95a5d8b46 Fix format of summaryLength in TOML example config
2ad649a92 Make terms in taxonomy examples more coherent
1fac1e662 Make a link specifically point to Pygments HTML Formatter docs
11ae6be03 Fix minor typos in v0.30 release notes

git-subtree-dir: docs
git-subtree-split: a042b67b5b8834ee8292849708cba724f5d6644e

--- a/config.toml
+++ b/config.toml
@@ -71,7 +71,7 @@
 [params]
   description = "The world’s fastest framework for building websites"
   ## Used for views in rendered HTML (i.e., rather than using the .Hugo variable)
-  release = "0.30"
+  release = "0.30.2"
   ## Setting this to true will add a "noindex" to *EVERY* page on the site
   removefromexternalsearch = false
   ## Gh repo for site footer (include trailing slash)
--- a/content/content-management/shortcodes.md
+++ b/content/content-management/shortcodes.md
@@ -88,6 +88,7 @@
 * `attr` (i.e., attribution)
 * `attrlink`
 * `alt`
+* `width`
 
 #### Example `figure` Input
 
--- a/content/content-management/syntax-highlighting.md
+++ b/content/content-management/syntax-highlighting.md
@@ -101,7 +101,7 @@
 : Highlight a space separated list of line numbers. For Chroma, you can provide a list of ranges, i.e. "3-8 10-20".
 
 
-The full set of supported options for Pygments is: `encoding`, `outencoding`, `nowrap`, `full`, `title`, `style`, `noclasses`, `classprefix`, `cssclass`, `cssstyles`, `prestyles`, `linenos`, `hl_lines`, `linenostart`, `linenostep`, `linenospecial`, `nobackground`, `lineseparator`, `lineanchors`, `linespans`, `anchorlinenos`, `startinline`. See the [Pygments Documentation](http://pygments.org/) for details.
+The full set of supported options for Pygments is: `encoding`, `outencoding`, `nowrap`, `full`, `title`, `style`, `noclasses`, `classprefix`, `cssclass`, `cssstyles`, `prestyles`, `linenos`, `hl_lines`, `linenostart`, `linenostep`, `linenospecial`, `nobackground`, `lineseparator`, `lineanchors`, `linespans`, `anchorlinenos`, `startinline`. See the [Pygments HTML Formatter Documentation](http://pygments.org/docs/formatters/#HtmlFormatter) for details.
 
 
 ## Generate Syntax Highlighter CSS
--- a/content/content-management/taxonomies.md
+++ b/content/content-management/taxonomies.md
@@ -54,19 +54,19 @@
 ```
 Actor                    <- Taxonomy
     Bruce Willis         <- Term
-        The Sixth Sense    <- Content
-        Unbreakable      <- Content
-        Moonrise Kingdom <- Content
+        The Sixth Sense  <- Value
+        Unbreakable      <- Value
+        Moonrise Kingdom <- Value
     Samuel L. Jackson    <- Term
-        Unbreakable      <- Content
-        The Avengers     <- Content
-        xXx              <- Content
+        Unbreakable      <- Value
+        The Avengers     <- Value
+        xXx              <- Value
 ```
 
 From the perspective of the content, the relationships would appear differently, although the data and labels used are the same:
 
 ```
-Unbreakable                 <- Content
+Unbreakable                 <- Value
     Actors                  <- Taxonomy
         Bruce Willis        <- Term
         Samuel L. Jackson   <- Term
@@ -73,7 +73,7 @@
     Director                <- Taxonomy
         M. Night Shyamalan  <- Term
     ...
-Moonrise Kingdom            <- Content
+Moonrise Kingdom            <- Value
     Actors                  <- Taxonomy
         Bruce Willis        <- Term
         Bill Murray         <- Term
--- a/content/content-management/urls.md
+++ b/content/content-management/urls.md
@@ -43,7 +43,7 @@
   post = "/:year/:month/:title/"
 {{< /code >}}
 
-Only the content under `post/` will have the new URL structure. For example, the file `content/post/sample-entry.md` with `date: 2017-02-27T19:20:00-05:00` in its front matter will render to `public/2017/02/sample-entry/index.html` at build time and therefore be reachable at `https://example.com/2013/11/sample-entry/`.
+Only the content under `post/` will have the new URL structure. For example, the file `content/post/sample-entry.md` with `date: 2017-02-27T19:20:00-05:00` in its front matter will render to `public/2017/02/sample-entry/index.html` at build time and therefore be reachable at `https://example.com/2017/02/sample-entry/`.
 
 ### Permalink Configuration Values
 
@@ -72,6 +72,9 @@
 
 `:section`
 : the content's section
+
+`:sections`
+: the content's sections hierarchy
 
 `:title`
 : the content's title
--- a/content/contribute/themes.md
+++ b/content/contribute/themes.md
@@ -105,7 +105,7 @@
 
 {{% note %}}
 1. This is different from the `theme.toml` file created by `hugo new theme` in Hugo versions before v0.14.
-2. Only `theme.toml` is accepted; ie. not `theme.yaml` andnot `theme.json`.
+2. Only `theme.toml` is accepted; ie. not `theme.yaml` and `theme.json`.
 {{% /note %}}
 
 ### Images
@@ -147,4 +147,4 @@
 {{% /note %}}
 
 [artistexample]: https://github.com/digitalcraftsman/hugo-artists-theme/tree/master/exampleSite
-[themeissuenew]: https://github.com/gohugoio/hugoThemes/issues/new
\ No newline at end of file
+[themeissuenew]: https://github.com/gohugoio/hugoThemes/issues/new
--- a/content/getting-started/configuration.md
+++ b/content/getting-started/configuration.md
@@ -252,7 +252,7 @@
 hasCJKLanguage =              false
 languageCode =                ""
 # the length of text to show in a .Summary
-summaryLength:              70
+summaryLength =              70
 layoutDir =                   "layouts"
 # Enable Logging
 log =                         false
--- a/content/getting-started/installing.md
+++ b/content/getting-started/installing.md
@@ -455,11 +455,9 @@
 
 ### Fedora, CentOS, and Red Hat
 
-* <https://copr.fedorainfracloud.org/coprs/spf13/Hugo/> (updated to Hugo v0.16)
-* <https://copr.fedorainfracloud.org/coprs/daftaupe/hugo/> (updated to Hugo v0.22); usually released a few days after the official Hugo release.
+* <https://copr.fedorainfracloud.org/coprs/daftaupe/hugo/>
 
 See the [related discussion in the Hugo forums][redhatforum].
-
 
 ## Upgrade Hugo
 
--- a/content/hosting-and-deployment/deployment-with-nanobox.md
+++ b/content/hosting-and-deployment/deployment-with-nanobox.md
@@ -21,8 +21,6 @@
 
 ![hugo with nanobox](/images/hosting-and-deployment/deployment-with-nanobox/hugo-with-nanobox.png)
 
-## Before You Begin
-
 Nanobox provides an entire end-to-end workflow for developing and deploying applications. Using Nanobox to deploy also means you'll use it to develop your application.
 
 {{% note %}}
@@ -39,14 +37,15 @@
 * [A Nanobox Account](https://nanobox.io) - Signup is free
 * [Nanobox Desktop](https://dashboard.nanobox.io/download) - The free desktop development tool
 * An account with a hosting provider such as:
-  - [AWS](https://aws.amazon.com/)
-  - [DigitalOcean](https://www.digitalocean.com/)
-  - [Linode](https://www.linode.com/)
-  - Azure (coming)
-  - Google (coming)
+  - [AWS](https://docs.nanobox.io/providers/hosting-accounts/aws/)
+  - [Google](https://docs.nanobox.io/providers/hosting-accounts/gcp/)
+  - [Azure](https://docs.nanobox.io/providers/hosting-accounts/azure/)
+  - [DigitalOcean](https://docs.nanobox.io/providers/hosting-accounts/digitalocean/)
+  - [Linode](https://docs.nanobox.io/providers/hosting-accounts/linode/)
+  - [More...](https://docs.nanobox.io/providers/hosting-accounts/)
   - [Roll Your Own](https://docs.nanobox.io/providers/create/)
 
-### Before We Begin
+### Before You Begin
 
 There are a few things to get out of the way before diving into the guide. To deploy, you'll need to make sure you have connected a host account to your Nanobox account, and launched a new application.
 
@@ -56,7 +55,7 @@
 
 #### Launch a New Application on Nanobox
 
-[Launching a new app on Nanobox](https://docs.nanobox.io/workflow/launch-app/) is very simple. Navigate to [Launch New App](https://dashboard.nanobox.io/apps/new) in the dashboard, and follow the steps there. You'll be asked to name your app, and select a host and region.
+[Launching a new app on Nanobox](https://docs.nanobox.io/workflow/launch-app/) is very simple. Navigate to [Launch New App](https://dashboard.nanobox.io/apps/new) in the dashboard, and follow the steps there. You'll be asked to name your app, and to select a host and region.
 
 With those out of the way you're ready to get started!
 
@@ -67,7 +66,7 @@
 If you already have a functioning Hugo app, you can skip to [Configure Hugo to run with Nanobox](#configure-hugo-to-run-with-nanobox)
 {{% /note %}}
 
-To get started, all you'll need an empty project directory. Create a directory wherever you want your application to live and `cd` into it:
+To get started, all you'll need is an empty project directory. Create a directory wherever you want your application to live and `cd` into it:
 
 `mkdir path/to/project && cd path/to/project`
 
@@ -101,7 +100,7 @@
 {{< /code >}}
 
 {{% note %}}
-If you already have a functioning Hugo app, which should now be configured, you can skip to [Deploying Hugo with Nanobox](#deploying-hugo-with-nanobox).
+If you already have a functioning Hugo app, after adding the boxfile, you can skip to [Deploying Hugo with Nanobox](#deploying-hugo-with-nanobox).
 {{% /note %}}
 
 ### Installing Hugo
@@ -108,7 +107,7 @@
 
 Nanobox uses Docker to create instant, isolated, development environments. Because of this, you'll need to make sure that during development you have Hugo available.
 
-Do this by add a custom install script at the root of your project that will install Hugo automatically for you:
+Do this by adding a custom install script at the root of your project that will install Hugo automatically for you:
 
 {{< code file="install.sh" >}}
 
@@ -131,7 +130,7 @@
 
 ### Generating a New Hugo App
 
-You'll generate your new application from inside a Nanobox console (this is why you don't need to worry about having Golang or Hugo installed).
+You'll generate your new application from inside the Nanobox VM (this is why you don't need to worry about having Golang or Hugo installed).
 
 Run the following command to drop into a Nanobox console (inside the VM) where your codebase is mounted:
 
@@ -141,7 +140,7 @@
 
 ![nanobox run](/images/hosting-and-deployment/deployment-with-nanobox/nanobox-run.png)
 
-Once inside here use the following steps to create a new Hugo application:
+Once inside the console use the following steps to create a new Hugo application:
 
 ```
 # cd into the /tmp dir to create an app
--- a/content/hosting-and-deployment/hosting-on-netlify.md
+++ b/content/hosting-and-deployment/hosting-on-netlify.md
@@ -114,6 +114,22 @@
 git submodule add https://github.com/<THEMECREATOR>/<THEMENAME>
 ```
 
+It is recommended to only use stable versions of a theme (if it’s versioned) and always check the changelog. This can be done by checking out a specific release within the theme's directory.
+
+Switch to the theme's directory and list all available versions:
+
+```
+cd themes/<theme>
+git tag
+# exit with q
+```
+
+You can checkout a specific version as follows:
+
+```
+git checkout tags/<version-name>
+```
+
 ## Next Steps
 
 You now have a live website served over https, distributed through CDN, and configured for continuous deployment. Dig deeper into the Netlify documentation:
--- a/content/news/0.30-relnotes-ready.md
+++ b/content/news/0.30-relnotes-ready.md
@@ -10,14 +10,14 @@
 ---
 
 	
-Hugo `0.30` is the **Race Car Edition**. Hugo is already very very fast, but much wants more. So we added **Fast Render Mode**. It is hard to explain, so start the Hugo development server with `hugo server` and start editing. Live reloads just got so much faster! The "how and what" is discussed in lenghts [other places](https://github.com/gohugoio/hugo/pull/3959), but the short version is that we now re-render only the parts of the site that you are working on.
+Hugo `0.30` is the **Race Car Edition**. Hugo is already very very fast, but much wants more. So we added **Fast Render Mode**. It is hard to explain, so start the Hugo development server with `hugo server` and start editing. Live reloads just got so much faster! The "how and what" is discussed at length in [other places](https://github.com/gohugoio/hugo/pull/3959), but the short version is that we now re-render only the parts of the site that you are working on.
 
-The second performance related feature is a follow up to the Template Metrics added in Hugo `0.29`. Now, if you add the flag `--templateMetricsHints`, we will calculate a score for how your partials can be cached (with the `partialCached` template func).
+The second performance-related feature is a follow-up to the Template Metrics added in Hugo `0.29`. Now, if you add the flag `--templateMetricsHints`, we will calculate a score for how your partials can be cached (with the `partialCached` template func).
 
 This release also more or less makes the really fast Chroma highlighter a complete alternative to Pygments. Most noteable is the new table `linenos` support ([7c30e2cb](https://github.com/gohugoio/hugo/commit/7c30e2cbb08fdf0e61f80c7f1aa29909aeca4211) [@bep](https://github.com/bep) [#3915](https://github.com/gohugoio/hugo/issues/3915)), which makes copy-and-paste code blocks much easier.
 
 This release represents **31 contributions by 10 contributors** to the main Hugo code base.
-[@bep](https://github.com/bep) leads the Hugo development with a significant amount of contributions, but also a big shoutout to [@moorereason](https://github.com/moorereason), [@digitalcraftsman](https://github.com/digitalcraftsman), and [@bmon](https://github.com/bmon) for their ongoing contributions.
+[@bep](https://github.com/bep) leads the Hugo development with a significant amount of contribution, but also a big shoutout to [@moorereason](https://github.com/moorereason), [@digitalcraftsman](https://github.com/digitalcraftsman), and [@bmon](https://github.com/bmon) for their ongoing contributions.
 And as always a big thanks to [@digitalcraftsman](https://github.com/digitalcraftsman) for his relentless work on keeping the documentation and the themes site in pristine condition.
 
 Many have also been busy writing and fixing the documentation in [hugoDocs](https://github.com/gohugoio/hugoDocs), 
@@ -32,7 +32,7 @@
 ## Notes
 
 * Running `hugo server` will now run with the new "Fast Render Mode" default on. To turn it off, run `hugo server --disableFastRender` or set `disableFastRender=true` in your site config.
-* There have been several fixes and enhancements in the Chroma highlighter. One is that it now creates Pygments compatible CSS classes, which means that you may want ot re-generate the stylesheet. See the [Syntax Highlighting Doc](https://gohugo.io/content-management/syntax-highlighting/).
+* There have been several fixes and enhancements in the Chroma highlighter. One is that it now creates Pygments compatible CSS classes, which means that you may want to re-generate the stylesheet. See the [Syntax Highlighting Doc](https://gohugo.io/content-management/syntax-highlighting/).
 
 ## Enhancements
 
@@ -60,5 +60,5 @@
 
 ## Fixes
 
-* Make sure `Date` and `PublishDate` is always set to a value if one is available [6a30874f](https://github.com/gohugoio/hugo/commit/6a30874f19610a38e846e120aac03c68e12f9b7b) [@bep](https://github.com/bep) [#3854](https://github.com/gohugoio/hugo/issues/3854)
+* Make sure `Date` and `PublishDate` are always set to a value if one is available [6a30874f](https://github.com/gohugoio/hugo/commit/6a30874f19610a38e846e120aac03c68e12f9b7b) [@bep](https://github.com/bep) [#3854](https://github.com/gohugoio/hugo/issues/3854)
 * Add correct config file name to verbose server log [15ec031d](https://github.com/gohugoio/hugo/commit/15ec031d9818d239bfbff525c00cd99cc3118a96) [@mdhender](https://github.com/mdhender) 
--- /dev/null
+++ b/content/news/0.30.1-relnotes-ready.md
@@ -1,0 +1,24 @@
+
+---
+date: 2017-10-19T00:00:00+02:00
+title: "0.30.1: Two Important Bugfixes!"
+description: "Fixes `hugo -w` and validator-broken Sitemap."
+categories: ["Releases"]
+slug: 0.30.1-relnotes
+images:
+- images/blog/hugo-bug-poster.png
+---
+
+	
+
+This is a bug-fix release with two important fixes.
+
+* Fix hugo -w [fa53b13c](https://github.com/gohugoio/hugo/commit/fa53b13ca0ffb1db6ed20f5353661d3f8a5fd455) [@bep](https://github.com/bep) [#3980](https://github.com/gohugoio/hugo/issues/3980)
+* Revert sitemap template change to make the Google validator happy [5109ed520](https://github.com/gohugoio/hugo/commit/5109ed520f2ddde815d50e7b31acbbfc57ce7719) [@bep](https://github.com/bep) [#3978](https://github.com/gohugoio/hugo/issues/3978)
+
+
+Hugo now has:
+
+* 20285+ [stars](https://github.com/gohugoio/hugo/stargazers)
+* 454+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors)
+* 180+ [themes](http://themes.gohugo.io/)
--- /dev/null
+++ b/content/news/0.30.2-relnotes-ready.md
@@ -1,0 +1,15 @@
+
+---
+date: 2017-10-19T12:00:00+02:00
+title: "0.30.2: One More Bugfix"
+description: "Fixes Fast Render mode when having sub-path in `baseURL`."
+slug: "0.30.2"
+categories: ["Releases"]
+images:
+- images/blog/hugo-bug-poster.png
+---
+This release fixes Fast Render mode with sub-path in baseURL [31641033](https://github.com/gohugoio/hugo/commit/3164103310fbca1211cfa9ce4a5eb7437854b6ad) [@bep](https://github.com/bep) [#3981](https://github.com/gohugoio/hugo/issues/3981).
+
+
+
+
--- a/content/readfiles/bfconfig.md
+++ b/content/readfiles/bfconfig.md
@@ -51,17 +51,15 @@
 
 `extensions`
 : default: **`[]`** <br>
-    Blackfriday flag: **`EXTENSION_*`** <br>
-    Purpose: Enable one or more Blackfriday's Markdown extensions (if they aren't Hugo defaults). <br>
+    Purpose: Enable one or more Blackfriday's Markdown extensions (**`EXTENSION_*`**). <br>
     Example: Include `hardLineBreak` in the list to enable Blackfriday's `EXTENSION_HARD_LINK_BREAK`. <br>
-    *See [Blackfriday extensions](#blackfriday-extensions) section for more information.*
+    *See [Blackfriday extensions](#blackfriday-extensions) section for information on all extensions.*
 
 `extensionsmask`
 : default: **`[]`** <br>
-    Blackfriday flag: **`EXTENSION_*`** <br>
-    Purpose: Enable one or more of Blackfriday's Markdown extensions (if they aren't Hugo defaults). <br>
+    Purpose: Disable one or more of Blackfriday's Markdown extensions (**`EXTENSION_*`**). <br>
     Example: Include `autoHeaderIds` as `false` in the list to disable Blackfriday's `EXTENSION_AUTO_HEADER_IDS`. <br>
-    *See [Blackfriday extensions](#blackfriday-extensions) section for more information.*
+    *See [Blackfriday extensions](#blackfriday-extensions) section for information on all extensions.*
 
 ## Blackfriday extensions
 
--- a/content/templates/shortcode-templates.md
+++ b/content/templates/shortcode-templates.md
@@ -124,7 +124,7 @@
 <img src="{{.Get "src" }}" alt="">
 {{ else }}
 <img src="{{.Get 0}}" alt="">
-{{ end }}.
+{{ end }}
 ```
 
 See the [example Vimeo shortcode][vimeoexample] below for `.IsNamedParams` in action.
@@ -150,7 +150,7 @@
 ```
 
 {{< code file="/layouts/shortcodes/year.html" >}}
-{{ .Page.Now.Year }}
+{{ now.Format "2006" }}
 {{< /code >}}
 
 ### Single Positional Example: `youtube`
--- a/content/variables/page.md
+++ b/content/variables/page.md
@@ -32,6 +32,9 @@
 `.Content`
 : the content itself, defined below the front matter.
 
+`.CurrentSection`
+: the page's current section. The value can be the page itself if it is a section or the homepage.
+
 `.Data`
 : the data specific to this type of page.
 
@@ -41,6 +44,9 @@
 `.Description`
 : the description for the page.
 
+`.Dir`
+: the path of the folder containing this content file. The path is relative to the `content` folder.
+
 `.Draft`
 : a boolean, `true` if the content is marked as a draft in the front matter.
 
@@ -47,6 +53,9 @@
 `.ExpiryDate`
 : the date on which the content is scheduled to expire; `.ExpiryDate` pulls from the `expirydate` field in a content's front matter. See also `.PublishDate`, `.Date`, and `.Lastmod`.
 
+`.File`
+: filesystem-related data for this content file. See also [File Variables][].
+
 `.FuzzyWordCount`
 : the approximate number of words in the content.
 
@@ -142,6 +151,9 @@
 `.Section`
 : the [section](/content-management/sections/) this content belongs to.
 
+`.Sections`
+: the [sections](/content-management/sections/) below this content.
+
 `.Site`
 : see [Site Variables](/variables/site/).
 
@@ -273,3 +285,4 @@
 ```
 
 [gitinfo]: /variables/git/
+[File Variables]: /variables/files/
--- a/netlify.toml
+++ b/netlify.toml
@@ -3,15 +3,15 @@
   command = "hugo"
 
 [context.production.environment]
-  HUGO_VERSION = "0.30"
+  HUGO_VERSION = "0.30.2"
   HUGO_ENV = "production"
   HUGO_ENABLEGITINFO = "true"
 
 [context.deploy-preview.environment]
-  HUGO_VERSION = "0.30"
+  HUGO_VERSION = "0.30.2"
 
 [context.branch-deploy.environment]
-  HUGO_VERSION = "0.30"
+  HUGO_VERSION = "0.30.2"
 
 [context.next.environment]
   HUGO_BASEURL = "https://next--gohugoio.netlify.com/"