From af3230aa5bacf5b87e7da2ee44f6a372466af1de Mon Sep 17 00:00:00 2001 From: Ryan Watters Date: Mon, 3 Apr 2017 10:34:58 -0500 Subject: [PATCH] Fix typos and add explanation on configuration.md --- content/functions/adddate.md | 4 ---- content/functions/dict.md | 2 +- content/getting-started/configuration.md | 11 ++++++++--- content/getting-started/directory-structure.md | 2 +- content/news/release-notes.md | 1 - content/readfiles/bfconfig.md | 2 +- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/content/functions/adddate.md b/content/functions/adddate.md index aadc2b0c4..5c8b97e94 100644 --- a/content/functions/adddate.md +++ b/content/functions/adddate.md @@ -51,7 +51,3 @@ Let's assume you want to grab Tweets from the last two years and present them in {{ end }} ``` {{% /code %}} - - - - diff --git a/content/functions/dict.md b/content/functions/dict.md index 0a1a735d0..220279e59 100644 --- a/content/functions/dict.md +++ b/content/functions/dict.md @@ -41,7 +41,7 @@ Important {{.important}} {{.content}} ``` -`dict` also allows you to create a map on the fly to pass into your [partial templates][partials] +`dict` also allows you to create a map on the fly to pass into your [partial templates][partials]: {{% code file="dict-create-map.html" %}} ```golang diff --git a/content/getting-started/configuration.md b/content/getting-started/configuration.md index 02148f94d..e575908a9 100644 --- a/content/getting-started/configuration.md +++ b/content/getting-started/configuration.md @@ -17,13 +17,17 @@ aliases: [/overview/source-directory/,/overview/configuration/] toc: true --- -The [directory structure][dirs] of a Hugo website—or more precisely, the source organization of files containing the website's content and templates—provides most of the configuration information that Hugo needs in order to statically generate a finished website. +The [directory structure][] of a Hugo website—or more precisely, the source organization of files containing the website's content and templates—provides most of the configuration information that Hugo needs in order to statically generate a finished website. Because of Hugo's preference for sane defaults, many websites may not need a configuration file. Hugo is designed to recognize certain typical usage patterns (and even expects them by default). ## Configuration Lookup Order -Hugo searches for a configuration file in the root of your website's source directory as a default behavior. First, it looks for a `./config.toml` file. If that's not present, it will seek a `./config.yaml` file, followed by a `./config.json` file. +Similar to the template [lookup order][], Hugo has a default set of rules for searching for a configuration file in the root of your website's source directory as a default behavior: + +1. `./config.toml` +2. `./config.yaml` +3. `./config.json` In your `config` file, you can direct Hugo as to how you want your website rendered, control your website's menus, and arbitrarily define site-wide parameters specific to your project. @@ -383,8 +387,9 @@ blackfriday: * [JSON Spec][json] [`.Site.Params`]: /variables/site/ -[dirs]: /getting-started/directory-structure +[directory structure]: /getting-started/directory-structure [json]: /documents/ecma-404-json-spec.pdf +[lookup order]: /templates/lookup-order/ [templates]: /templates/ [toml]: https://github.com/toml-lang/toml [yaml]: http://yaml.org/spec/ \ No newline at end of file diff --git a/content/getting-started/directory-structure.md b/content/getting-started/directory-structure.md index ca5680aa7..58b81cb95 100644 --- a/content/getting-started/directory-structure.md +++ b/content/getting-started/directory-structure.md @@ -61,7 +61,7 @@ used by Hugo when generating your website. You can write these files in YAML, JS : stores all the static content for your future website: images, CSS, JavaScript, etc. When Hugo builds your site, all assets inside your static directory are copied over as-is. A good example of using the `static` folder is for [verifying site ownership on Google Search Console][searchconsole], where you want Hugo to copy over a complete HTML file without modifying its content. {{% note %}} -Hugo does not currently ship with an asset pipeline ([#3207](https://github.com/spf13/hugo/issues/3207)). You can solicit support from the community in the [Hugo forums](https://discuss.gohugo.io) or check out a few of the [Hugo starter kits](/tools/starter-kits/) for examples of how Hugo developers are managing these assets. +Hugo does not currently ship with an asset pipeline ([#3207](https://github.com/spf13/hugo/issues/3207)). You can solicit support from the community in the [Hugo forums](https://discuss.gohugo.io) or check out a few of the [Hugo starter kits](/tools/starter-kits/) for examples of how Hugo developers are managing static assets. {{% /note %}} diff --git a/content/news/release-notes.md b/content/news/release-notes.md index 7502638d3..f0403fc81 100644 --- a/content/news/release-notes.md +++ b/content/news/release-notes.md @@ -15,7 +15,6 @@ weight: 30 #rem draft: false aliases: [/meta/release-notes/] toc: true -notesforauthors: --- ## **0.19** February 27th 2017 diff --git a/content/readfiles/bfconfig.md b/content/readfiles/bfconfig.md index 79c3f6628..818bf079a 100644 --- a/content/readfiles/bfconfig.md +++ b/content/readfiles/bfconfig.md @@ -52,4 +52,4 @@ : default: **`[]`**
Blackfriday flag: **`EXTENSION_*`**
Purpose: Enable one or more of Blackfriday's Markdown extensions (if they aren't Hugo defaults).
- Example: Include `autoHeaderIds` in the list of disable Blackfriday's `EXTENSION_AUTO_HEADER_IDS`. \ No newline at end of file + Example: Include `autoHeaderIds` as `false` in the list to disable Blackfriday's `EXTENSION_AUTO_HEADER_IDS`. \ No newline at end of file