From: Bjørn Erik Pedersen Date: Wed, 3 Jan 2018 09:19:56 +0000 (+0100) Subject: Merge commit 'eb738cd35cca1ffc68c5ed688dbe2a19108e8761' X-Git-Tag: v0.32.2~5 X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=2aa4c009eec3375f56740f90917f5bee6a72c7f5;p=brevno-suite%2Fhugo Merge commit 'eb738cd35cca1ffc68c5ed688dbe2a19108e8761' --- 2aa4c009eec3375f56740f90917f5bee6a72c7f5 diff --cc docs/content/about/new-in-032/index.md index 00000000,00000000..0ae93b55 new file mode 100644 --- /dev/null +++ b/docs/content/about/new-in-032/index.md @@@ -1,0 -1,0 +1,209 @@@ ++--- ++title: Hugo 0.32 HOWTO ++description: About page bundles, image processing and more. ++date: 2017-12-28 ++keywords: [ssg,static,performance,security] ++menu: ++ docs: ++ parent: "about" ++ weight: 10 ++weight: 10 ++sections_weight: 10 ++draft: false ++aliases: [] ++toc: true ++images: ++- images/blog/sunset.jpg ++--- ++ ++ ++{{% note %}} ++This documentation belongs in other places in this documentation site, but is put here first ... to get something up and running fast. ++{{% /note %}} ++ ++ ++Also see this demo project from [bep](https://github.com/bep/), the clever Norwegian behind these new features: ++ ++* http://hugotest.bep.is/ ++* https://github.com/bep/hugotest (source) ++ ++## Page Resources ++ ++### Organize Your Content ++ ++{{< figure src="/images/hugo-content-bundles.png" title="Pages with image resources" >}} ++ ++The content folder above shows a mix of content pages (`md` (i.e. markdown) files) and image resources. ++ ++{{% note %}} ++You can use any file type as a content resource as long as it is a MIME type recognized by Hugo (`json` files will, as one example, work fine). If you want to get exotic, you can define your [own media type](/templates/output-formats/#media-types). ++{{% /note %}} ++ ++The 3 page bundles marked in red explained from top to bottom: ++ ++1. The home page with one image resource (`1-logo.png`) ++2. The blog section with two images resources and two pages resources (`content1.md`, `content2.md`). Note that the `_index.md` represents the URL for this section. ++3. An article (`hugo-is-cool`) with a folder with some images and one content resource (`cats-info.md`). Note that the `index.md` represents the URL for this article. ++ ++The content files below `blog/posts` are just regular standalone pages. ++ ++{{% note %}} ++Note that changes to any resource inside the `content` folder will trigger a reload when running in watch (aka server or live reload mode), it will even work with `--navigateToChanged`. ++{{% /note %}} ++ ++#### Sort Order ++ ++* Pages are sorted according to standard Hugo page sorting rules. ++* Images and other resources are sorted in lexicographical order. ++ ++### Handle Page Resources in Templates ++ ++ ++#### List all Resources ++ ++```html ++{{ range .Resources }} ++

++{{ end }} ++``` ++ ++For an absolute URL, use `.Permalink`. ++ ++**Note:** The permalink will be relative to the content page, respecting permalink settings. Also, included page resources will not have a value for `RelPermalink`. ++ ++#### List All Resources by Type ++ ++```html ++{{ with .Resources.ByType "image" }} ++{{ end }} ++ ++``` ++ ++Type here is `page` for pages, else the main type in the MIME type, so `image`, `json` etc. ++ ++#### Get a Specific Resource ++ ++```html ++{{ $logo := .Resources.GetByPrefix "logo" }} ++{{ with $logo }} ++{{ end }} ++``` ++ ++#### Include Page Resource Content ++ ++```html ++{{ with .Resources.ByType "page" }} ++{{ range . }} ++

++{{ .Content }} ++{{ end }} ++{{ end }} ++ ++``` ++ ++ ++## Image Processing ++ ++The `image` resource implements the methods `Resize`, `Fit` and `Fill`: ++ ++Resize ++: Resize to the given dimension, `{{ $logo.Resize "200x" }}` will resize to 200 pixels wide and preserve the aspect ratio. Use `{{ $logo.Resize "200x100" }}` to control both height and width. ++ ++Fit ++: Scale down the image to fit the given dimensions, e.g. `{{ $logo.Fit "200x100" }}` will fit the image inside a box that is 200 pixels wide and 100 pixels high. ++ ++Fill ++: Resize and crop the image given dimensions, e.g. `{{ $logo.Fill "200x100" }}` will resize and crop to width 200 and height 100 ++ ++ ++{{% note %}} ++Image operations in Hugo currently **do not preserve EXIF data** as this is not supported by Go's [image package](https://github.com/golang/go/search?q=exif&type=Issues&utf8=%E2%9C%93). This will be improved on in the future. ++{{% /note %}} ++ ++ ++### Image Processing Examples ++ ++_The photo of the sunset used in the examples below is Copyright [BjÃ¸rn Erik Pedersen](https://commons.wikimedia.org/wiki/User:Bep) (Creative Commons Attribution-Share Alike 4.0 International license)_ ++ ++ ++{{< imgproc sunset Resize "300x" >}} ++ ++{{< imgproc sunset Fill "90x120 left" >}} ++ ++{{< imgproc sunset Fill "90x120 right" >}} ++ ++{{< imgproc sunset Fit "90x90" >}} ++ ++{{< imgproc sunset Resize "300x q10" >}} ++ ++ ++This is the shortcode used in the examples above: ++ ++ ++{{< code file="layouts/shortcodes/imgproc.html" >}} ++{{< readfile file="layouts/shortcodes/imgproc.html" >}} ++{{< /code >}} ++ ++And it is used like this: ++ ++```html ++{{}} ++``` ++ ++### Image Processing Options ++ ++In addition to the dimensions (e.g. `200x100`) where either height or width can be omitted, Hugo supports a set of additional image options: ++ ++Anchor ++: Only relevant for `Fill`. This is useful for thumbnail generation where the main motive is located in, say, the left corner. Valid are `Center`, `TopLeft`, `Top`, `TopRight`, `Left`, `Right`, `BottomLeft`, `Bottom`, `BottomRight`. Example: `{{ $logo.Fill "200x100 BottomLeft" }}` ++ ++JPEG Quality ++: Only relevant for JPEG images, values 1 to 100 inclusive, higher is better. Default is 75. `{{ $logo.Resize "200x q50" }}` ++ ++Rotate ++: Rotates an image by the given angle counter-clockwise. The rotation will be performed first to get the dimensions correct. `{{ $logo.Resize "200x r90" }}`. The main use of this is to be able to manually correct for [EXIF orientation](https://github.com/golang/go/issues/4341) of JPEG images. ++ ++Resample Filter ++: Filter used in resizing. Default is `Box`, a simple and fast resampling filter appropriate for downscaling. See https://github.com/disintegration/imaging for more. If you want to trade quality for faster processing, this may be a option to test. ++ ++ ++ ++### Performance ++ ++Processed images are stored below `/resources` (can be set with `resourceDir` config setting). This folder is deliberately placed in the project, as it is recommended to check these into source control as part of the project. These images are not "Hugo fast" to generate, but once generated they can be reused. ++ ++If you change your image settings (e.g. size), remove or rename images etc., you will end up with unused images taking up space and cluttering your project. ++ ++To clean up, run: ++ ++```bash ++hugo --gc ++``` ++ ++ ++{{% note %}} ++**GC** is short for **Garbage Collection**. ++{{% /note %}} ++ ++ ++## Configuration ++ ++### Default Image Processing Config ++ ++You can configure an `imaging` section in `config.toml` with default image processing options: ++ ++```toml ++[imaging] ++# Default resample filter used for resizing. Default is Box, ++# a simple and fast averaging filter appropriate for downscaling. ++# See https://github.com/disintegration/imaging ++resampleFilter = "box" ++ ++# Defatult JPEG quality setting. Default is 75. ++quality = 68 ++``` ++ ++ ++ ++ ++ diff --cc docs/content/about/new-in-032/sunset.jpg index 00000000,00000000..7d7307be new file mode 100644 Binary files differ diff --cc docs/content/content-management/organization.md index a239c562,00000000..6a854c25 mode 100644,000000..100644 --- a/docs/content/content-management/organization.md +++ b/docs/content/content-management/organization.md @@@ -1,225 -1,0 +1,233 @@@ +--- +title: Content Organization +linktitle: Organization +description: Hugo assumes that the same structure that works to organize your source content is used to organize the rendered site. +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-01 +categories: [content management,fundamentals] +keywords: [sections,content,organization] +menu: + docs: + parent: "content-management" + weight: 10 +weight: 10 #rem +draft: false +aliases: [/content/sections/] +toc: true +--- + +{{< youtube 0GZxidrlaRM >}} + ++## Content Bundles and Image Processing ++ ++See [This Page](/about/new-in-032/). We will get the relevant parts of the rest of the Hugo docs updated. Eventually. ++ ++{{< todo >}} ++Remove the above when done. ++{{< /todo >}} ++ +## Organization of Content Source + +In Hugo, your content should be organized in a manner that reflects the rendered website. + +While Hugo supports content nested at any level, the top levels (i.e. `content/`) are special in Hugo and are considered the content type used to determine layouts etc. To read more about sections, including how to nest them, see [sections][]. + +Without any additional configuration, the following will just work: + +``` +. +âââ content + âââ about + | âââ _index.md // <- https://example.com/about/ + âââ post + | âââ firstpost.md // <- https://example.com/post/firstpost/ + | âââ happy + | | âââ ness.md // <- https://example.com/post/happy/ness/ + | âââ secondpost.md // <- https://example.com/post/secondpost/ + âââ quote + âââ first.md // <- https://example.com/quote/first/ + âââ second.md // <- https://example.com/quote/second/ +``` + +## Path Breakdown in Hugo + + +The following demonstrates the relationships between your content organization and the output URL structure for your Hugo website when it renders. These examples assume you are [using pretty URLs][pretty], which is the default behavior for Hugo. The examples also assume a key-value of `baseurl = "https://example.com"` in your [site's configuration file][config]. + +### Index Pages: `_index.md` + +`_index.md` has a special role in Hugo. It allows you to add front matter and content to your [list templates][lists]. These templates include those for [section templates][], [taxonomy templates][], [taxonomy terms templates][], and your [homepage template][]. + +{{% note %}} +**Tip:** You can get a reference to the content and metadata in `_index.md` using the [`.Site.GetPage` function](/functions/getpage/). +{{% /note %}} + +You can keep one `_index.md` for your homepage and one in each of your content sections, taxonomies, and taxonomy terms. The following shows typical placement of an `_index.md` that would contain content and front matter for a `posts` section list page on a Hugo website: + + +``` +. url +. â¢--^-â£ +. path slug +. â¢--^-â£â¢---^---â£ +. filepath +. â¢------^------â£ +content/posts/_index.md +``` + +At build, this will output to the following destination with the associated values: + +``` + + url ("/posts/") + â¢-^-â£ + baseurl section ("posts") +â¢--------^---------â£â¢-^-â£ + permalink +â¢----------^-------------â£ +https://example.com/posts/index.html +``` + +The [sections][] can be nested as deeply as you need. The important part to understand is, that to make the section tree fully navigational, at least the lower-most section needs a content file. (i.e. `_index.md`). + + +### Single Pages in Sections + +Single content files in each of your sections are going to be rendered as [single page templates][singles]. Here is an example of a single `post` within `posts`: + + +``` + path ("posts/my-first-hugo-post.md") +. â¢-----------^------------â£ +. section slug +. â¢-^-â£â¢--------^----------â£ +content/posts/my-first-hugo-post.md +``` + +At the time Hugo builds your site, the content will be output to the following destination: + +``` + + url ("/posts/my-first-hugo-post/") + â¢------------^----------â£ + baseurl section slug +â¢--------^--------â£â¢-^--â£â¢-------^---------â£ + permalink +â¢--------------------^---------------------â£ +https://example.com/posts/my-first-hugo-post/index.html +``` + + +## Paths Explained + +The following concepts will provide more insight into the relationship between your project's organization and the default behaviors of Hugo when building the output website. + +### `section` + +A default content type is determined by a piece of content's section. `section` is determined by the location within the project's `content` directory. `section` *cannot* be specified or overridden in front matter. + +### `slug` + +A content's `slug` is either `name.extension` or `name/`. The value for `slug` is determined by + +* the name of the content file (e.g., `lollapalooza.md`) OR +* front matter overrides + +### `path` + +A content's `path` is determined by the section's path to the file. The file `path` + +* is based on the path to the content's location AND +* does not include the slug + +### `url` + +The `url` is the relative URL for the piece of content. The `url` + +* is based on the content's location within the directory structure OR +* is defined in front matter and *overrides all the above* + +## Override Destination Paths via Front Matter + +Hugo believes that you organize your content with a purpose. The same structure that works to organize your source content is used to organize the rendered site. As displayed above, the organization of the source content will be mirrored in the destination. + +There are times where you may need more control over your content. In these cases, there are fields that can be specified in the front matter to determine the destination of a specific piece of content. + +The following items are defined in this order for a specific reason: items explained further down in the list will override earlier items, and not all of these items can be defined in front matter: + +### `filename` + +This isn't in the front matter, but is the actual name of the file minus the extension. This will be the name of the file in the destination (e.g., `content/posts/my-post.md` becomes `example.com/posts/my-post/`). + +### `slug` + +When defined in the front matter, the `slug` can take the place of the filename for the destination. + +{{< code file="content/posts/old-post.md" >}} +--- +title: New Post +slug: "new-post" +--- +{{< /code >}} + +This will render to the following destination according to Hugo's default behavior: + +``` +example.com/posts/new-post/ +``` + +### `section` + +`section` is determined by a content's location on disk and *cannot* be specified in the front matter. See [sections][] for more information. + +### `type` + +A content's `type` is also determined by its location on disk but, unlike `section`, it *can* be specified in the front matter. See [types][]. This can come in especially handy when you want a piece of content to render using a different layout. In the following example, you can create a layout at `layouts/new/mylayout.html` that Hugo will use to render this piece of content, even in the midst of many other posts. + +{{< code file="content/posts/my-post.md" >}} +--- +title: My Post +type: new +layout: mylayout +--- +{{< /code >}} + + + + + +### `url` + +A complete URL can be provided. This will override all the above as it pertains to the end destination. This must be the path from the baseURL (starting with a `/`). `url` will be used exactly as it provided in the front matter and will ignore the `--uglyURLs` setting in your site configuration: + +{{< code file="content/posts/old-url.md" >}} +--- +title: Old URL +url: /blog/new-url/ +--- +{{< /code >}} + +Assuming your `baseURL` is [configured][config] to `https://example.com`, the addition of `url` to the front matter will make `old-url.md` render to the following destination: + +``` +https://example.com/blog/new-url/ +``` + +You can see more information on how to control output paths in [URL Management][urls]. + +[config]: /getting-started/configuration/ +[formats]: /content-management/formats/ +[front matter]: /content-management/front-matter/ +[getpage]: /functions/getpage/ +[homepage template]: /templates/homepage/ +[homepage]: /templates/homepage/ +[lists]: /templates/lists/ +[pretty]: /content-management/urls/#pretty-urls +[section templates]: /templates/section-templates/ +[sections]: /content-management/sections/ +[singles]: /templates/single-page-templates/ +[taxonomy templates]: /templates/taxonomy-templates/ +[taxonomy terms templates]: /templates/taxonomy-templates/ +[types]: /content-management/types/ +[urls]: /content-management/urls/ diff --cc docs/content/news/0.32-relnotes-ready.md index 4a2f500f,00000000..c0a93d8e mode 100644,000000..100644 --- a/docs/content/news/0.32-relnotes-ready.md +++ b/docs/content/news/0.32-relnotes-ready.md @@@ -1,93 -1,0 +1,95 @@@ + +--- +date: 2017-12-31 - title: "0.32" - description: "0.32" - slug: "0.32" ++title: "Hugo 0.32: Page Bundles and Image Processing!" ++description: "Images and other resources with page-relative links, resize, scale and crop images, and much more." ++slug: "0.32-relnotes" +categories: ["Releases"] ++images: ++- images/blog/hugo-32-poster.png +--- + + Hugo `0.32` features **Page Bundles and Image Processing** by [@bep](https://github.com/bep), which is very cool and useful on so many levels. Read about it in more detail in the [Hugo documentation](https://gohugo.io/about/new-in-032/), but some of the highlights include: + +* Automatic bundling of a content page with its resources. Resources can be anything: Images, `JSON` files ... and also other content pages. +* A `Resource` will have its `RelPermalink` and `Permalink` relative to the "owning page". This makes the complete article with both text and images portable (just send a ZIP file with a folder to your editor), and it can be previewed directly on GitHub. +* Powerful and simple to use image processing with the new `.Resize`, `.Fill`, and `.Fit` methods on the new `Image` resource. +* Full support for symbolic links inside `/content`, both for regular files and directories. + +The built-in benchmarks in Hugo show that this is also the [fastest and most memory effective](https://gist.github.com/bep/2a9bbd221de2da5d39c8b32085c658f7) Hugo version to date. But note that the build time total reported in the console is now adjusted to be the *real total*, including the copy of static files. So, if it reports more milliseconds, it is still most likely faster ... + +This release represents **30 contributions by 7 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 [@betaveros](https://github.com/betaveros), [@chaseadamsio](https://github.com/chaseadamsio), and [@kropp](https://github.com/kropp). And as always 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), +which has received **17 contributions by 7 contributors**. A special thanks to [@bep](https://github.com/bep), [@felicianotech](https://github.com/felicianotech), [@maiki](https://github.com/maiki), and [@carlchengli](https://github.com/carlchengli) for their work on the documentation site. + +Hugo now has: + +* 22061+ [stars](https://github.com/gohugoio/hugo/stargazers) +* 454+ [contributors](https://github.com/gohugoio/hugo/graphs/contributors) +* 193+ [themes](http://themes.gohugo.io/) + +Today is **New Year's Eve.** It is the last day of 2017, a year that have seen a **string of pearls of Hugo releases**, making Hugo _the_ top choice for website development: + +* 0.32, December 2017: **Page Bundles and Image Processing** edition. +* 0.31, November 2017: The Language **Multihost Edition!** with one `baseURL` per language. +* 0.30, October 2017: The Race Car Edition with the **Fast Render Mode**. +* 0.29, September 2017: Added **Template Metrics**. +* 0.28, September 2017: **Blistering fast and native syntax highlighting** from [Chroma](https://github.com/alecthomas/chroma). +* 0.27, September 2017: Fast and flexible **Related Content.** +* 0.26, August 2017: The **Language Style Edition** with AP Style or Chicago Style Title Case and Â« French Guillemets Â». +* 0.25, July 2017: The **Kinder Surprise** edition added, among other cool things, `hugo server --navigateToChanged` which navigates to the content page you start editing. +* 0.24, June 2017: Was **The Revival of the Archetypes!** Now archetype files, i.e. the content file templates, can include template syntax with all of Hugo's functions and variables. +* 0.23, June 2017: Hugo moved to it's own GitHub organization, **gohugoio**. +* 0.22, June 2017: Added **nested sections**, a long sought after feature. +* 0.21, May 2017: Full support for shortcodes per output format (think **AMP**). +* 0.20, April 2017: Was all about **Custom Output Formats**. +* 0.19, February 2017: Native Emacs Org-mode content support and lots of internal upgrades. + +## Notes + +* The build total in the console is now the ... total (i.e. it now includes both the copy of the static files and the Hugo build). So if your Hugo site seems to build slightly slower, it is in reality probably slightly faster than before this release. +* Images and other static resources in folders with "_index.md" will have its `RelPermalink` relative to its page. +* Images and other static resources in or below "index.md" folders will have its `RelPermalink` relative to its page (respecting permalink settings etc.) +* Content pages in or below "index.md" will not get their own `URL`, but will be part of the `.Resources` collection of its page. +* `.Site.Files` is deprecated. +* Hugo no longer minfies CSS files inside `/content`. This was an undocumented "proof of concept feature". We may revisit the "assets handling" in a future release. +* `Page.GetParam`does not lowercase your result anymore. If you really want to lowercase your params, do it with `.GetParam "myparam" | lower` or similar. + +Previously deprecated that will now `ERROR`: + +* `disable404`: Use `disableKinds=["404"]` +* `disableRSS`: Use `disableKinds=["RSS"]` +* `disableSitemap`: Use `disableKinds=["sitemap"]` +* `disableRobotsTXT`: Use `disableKinds=["robotsTXT"]` + +## Enhancements + +* Add `.Title` and `.Page` to `MenuEntry` [9df3736f](https://github.com/gohugoio/hugo/commit/9df3736fec164c51d819797416dc263f2869be77) [@rmetzler](https://github.com/rmetzler) [#2784](https://github.com/gohugoio/hugo/issues/2784) +* Add `Pandoc` support [e69da7a4](https://github.com/gohugoio/hugo/commit/e69da7a4cb725987f153707bf2fc59c135007e2a) [@betaveros](https://github.com/betaveros) [#234](https://github.com/gohugoio/hugo/issues/234) +* Implement Page bundling and image handling [3cdf19e9](https://github.com/gohugoio/hugo/commit/3cdf19e9b7e46c57a9bb43ff02199177feb55768) [@bep](https://github.com/bep) [#3651](https://github.com/gohugoio/hugo/issues/3651)[#3158](https://github.com/gohugoio/hugo/issues/3158)[#1014](https://github.com/gohugoio/hugo/issues/1014)[#2021](https://github.com/gohugoio/hugo/issues/2021)[#1240](https://github.com/gohugoio/hugo/issues/1240)[#3757](https://github.com/gohugoio/hugo/issues/3757) +* Make `chomp` return the type it receives [22cd89ad](https://github.com/gohugoio/hugo/commit/22cd89adc4792a3b55389d38acd4acfae3786775) [@kropp](https://github.com/kropp) [#2187](https://github.com/gohugoio/hugo/issues/2187) +* Reuse the `BlackFriday` config instance when possible [db4b7a5c](https://github.com/gohugoio/hugo/commit/db4b7a5c6742c75f9cd9627d3b054d3a72802ec8) [@bep](https://github.com/bep) +* Remove the goroutines from the shortcode lexer [24369410](https://github.com/gohugoio/hugo/commit/243694102a60da2fb1050020f68384539f9f9ef5) [@bep](https://github.com/bep) +* Improve site benchmarks [051fa343](https://github.com/gohugoio/hugo/commit/051fa343d06d6c070df742f7cbd125432fcab665) [@bep](https://github.com/bep) +* Update `Chroma` to `v0.2.0` [79892101](https://github.com/gohugoio/hugo/commit/7989210120dbde78da3741e2ef01b13f4aa78692) [@bep](https://github.com/bep) [#4087](https://github.com/gohugoio/hugo/issues/4087) +* Update `goorgeous` to `v1.1.0` [7f2ae3ef](https://github.com/gohugoio/hugo/commit/7f2ae3ef39f27a9bd26ddb9258b073a840faf491) [@chaseadamsio](https://github.com/chaseadamsio) +* Add test for homepage content for all rendering engines [407c2402](https://github.com/gohugoio/hugo/commit/407c24020ef2db90cf33fd07e7522b2257013722) [@bep](https://github.com/bep) [#4166](https://github.com/gohugoio/hugo/issues/4166) +* Add output formats definition to benchmarks [a2d81ce9](https://github.com/gohugoio/hugo/commit/a2d81ce983d45b5742c93bd472503c88286f099a) [@bep](https://github.com/bep) + +## Fixes + +### Templates + +* Do not unescape input to `highlight` [c067f345](https://github.com/gohugoio/hugo/commit/c067f34558b82455b63b9ce8f5983b4b4849c7cf) [@bep](https://github.com/bep) [#4179](https://github.com/gohugoio/hugo/issues/4179) +* Properly close image file in `imageConfig` [6d79beb5](https://github.com/gohugoio/hugo/commit/6d79beb5f67dbb54d7714c3195addf9d8e3924e8) [@bep](https://github.com/bep) + * Fix `opengraph` video range template [23f69efb](https://github.com/gohugoio/hugo/commit/23f69efb3914946b39ce673fcc0f2e3a9ed9d878) [@drlogout](https://github.com/drlogout) [#4136](https://github.com/gohugoio/hugo/issues/4136) +* Fix `humanize` for multi-byte runes [e7652180](https://github.com/gohugoio/hugo/commit/e7652180a13ce149041c48a1c2754c471df569c8) [@bep](https://github.com/bep) [#4133](https://github.com/gohugoio/hugo/issues/4133) + +### Other + +* Fix broken live reload without a server port. [25114986](https://github.com/gohugoio/hugo/commit/25114986086e5877a0b4108d8cf5e4e95f377241) [@sainaen](https://github.com/sainaen) [#4141](https://github.com/gohugoio/hugo/issues/4141) +* Make sure all language homes are always re-rendered in fast render mode [72903be5](https://github.com/gohugoio/hugo/commit/72903be587e9c4e3644f60b11e26238ec03da2db) [@bep](https://github.com/bep) [#4125](https://github.com/gohugoio/hugo/issues/4125) +* Do not `tolower` result from Page.GetParam [1c114d53](https://github.com/gohugoio/hugo/commit/1c114d539b0755724443fe28c90b12fe2a19085a) [@bep](https://github.com/bep) [#4187](https://github.com/gohugoio/hugo/issues/4187) diff --cc docs/content/news/0.32.1-relnotes-ready.md index 2a05ff64,00000000..80e90e6e mode 100644,000000..100644 --- a/docs/content/news/0.32.1-relnotes-ready.md +++ b/docs/content/news/0.32.1-relnotes-ready.md @@@ -1,22 -1,0 +1,19 @@@ + +--- +date: 2018-01-02 - title: "0.32.1" - description: "0.32.1" - slug: "0.32.1" ++title: "0.32.1: Two bugfixes" ++description: "Fixes image processing in shortcodes." ++slug: "0.32.1-relnotes" +categories: ["Releases"] +images: +- images/blog/hugo-bug-poster.png - +--- + - - +This fixes 2 bugs from the Hugo 0.32 release. + +* Fix image processing from shortcodes in non-server mode. [@bep](https://github.com/bep) [#4202](https://github.com/gohugoio/hugo/issues/4202) +* Fix broken `hugo --renderToMemory`. Note that this is only useful for benchmark testing, as there is no easy way to actually view the result. [d36d71ed](https://github.com/gohugoio/hugo/commit/d36d71edd3b04df3b34edf4d108e3995a244c4f0) [@bep](https://github.com/bep) [#4212](https://github.com/gohugoio/hugo/issues/4212) + + + + diff --cc docs/content/variables/page.md index 76cf0e83,00000000..eb4699a4 mode 100644,000000..100644 --- a/docs/content/variables/page.md +++ b/docs/content/variables/page.md @@@ -1,285 -1,0 +1,285 @@@ +--- +title: Page Variables +linktitle: +description: Page-level variables are defined in a content file's front matter, derived from the content's file location, or extracted from the content body itself. +date: 2017-02-01 +publishdate: 2017-02-01 +lastmod: 2017-02-01 +categories: [variables and params] +keywords: [pages] +draft: false +menu: + docs: + parent: "variables" + weight: 20 +weight: 20 +sections_weight: 20 +aliases: [/variables/page/] +toc: true +--- + +The following is a list of page-level variables. Many of these will be defined in the front matter, derived from file location, or extracted from the content itself. + +{{% note "`.Scratch`" %}} +See [`.Scratch`](/functions/scratch/) for page-scoped, writable variables. +{{% /note %}} + +## Page Variables + +.AlternativeOutputFormats +: contains all alternative formats for a given page; this variable is especially useful `link rel` list in your site's ``. (See [Output Formats](/templates/output-formats/).) + +.Content +: the content itself, defined below the front matter. + +.Data +: the data specific to this type of page. + +.Date +: the date associated with the page; `.Date` pulls from the `date` field in a content's front matter. See also `.ExpiryDate`, `.PublishDate`, and `.Lastmod`. + +.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. + +.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. + +.Hugo +: see [Hugo Variables](/variables/hugo/). + +.IsHome +: `true` in the context of the [homepage](/templates/homepage/). + +.IsNode +: always `false` for regular content pages. + +.IsPage +: always `true` for regular content pages. + +.IsTranslated +: `true` if there are translations to display. + +.Keywords +: the meta keywords for the content. + +.Kind +: the page's *kind*. Possible return values are `page`, `home`, `section`, `taxonomy`, or `taxonomyTerm`. Note that there are also `RSS`, `sitemap`, `robotsTXT`, and `404` kinds, but these are only available during the rendering of each of these respective page's kind and therefore *not* available in any of the `Pages` collections. + +.Lang +: language taken from the language extension notation. + +.Language +: a language object that points to the language's definition in the site +`config`. + +.Lastmod +: the date the content was last modified. `.Lastmod` pulls from the `lastmod` field in a content's front matter. + + - If `lastmod` is not set, and `.GitInfo` feature is disabled, the front matter `date` field will be used. + - If `lastmod` is not set, and `.GitInfo` feature is enabled, `.GitInfo.AuthorDate` will be used instead. + +See also `.ExpiryDate`, `.Date`, `.PublishDate`, and [`.GitInfo`][gitinfo]. + +.LinkTitle +: access when creating links to the content. If set, Hugo will use the `linktitle` from the front matter before `title`. + +.Next +: pointer to the following content (based on the `publishdate` field in front matter). + +.NextInSection +: pointer to the following content within the same section (based on `publishdate` field in front matter). + +.OutputFormats +: contains all formats, including the current format, for a given page. Can be combined the with [`.Get` function](/functions/get/) to grab a specific format. (See [Output Formats](/templates/output-formats/).) + +.Pages +: a collection of associated pages. This value will be `nil` for regular content pages. `.Pages` is an alias for `.Data.Pages`. + +.Permalink +: the Permanent link for this page; see [Permalinks](/content-management/urls/) + +.Plain +: the Page content stripped of HTML tags and presented as a string. + +.PlainWords +: the Page content stripped of HTML as a `[]string` using Go's [`strings.Fields`](https://golang.org/pkg/strings/#Fields) to split `.Plain` into a slice. + +.Prev +: Pointer to the previous content (based on `publishdate` in front matter). + +.PrevInSection +: Pointer to the previous content within the same section (based on `publishdate` in front matter). For example, `{{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}`. + +.PublishDate +: the date on which the content was or will be published; `.Publishdate` pulls from the `publishdate` field in a content's front matter. See also `.ExpiryDate`, `.Date`, and `.Lastmod`. + +.RSSLink +: link to the taxonomies' RSS link. + +.RawContent +: raw markdown content without the front matter. Useful with [remarkjs.com]( +http://remarkjs.com) + +.ReadingTime +: the estimated time, in minutes, it takes to read the content. + +.Ref +: returns the permalink for a given reference (e.g., `.Ref "sample.md"`). `.Ref` does *not* handle in-page fragments correctly. See [Cross References](/content-management/cross-references/). + +.RelPermalink +: the relative permanent link for this page. + +.RelRef +: returns the relative permalink for a given reference (e.g., `RelRef +"sample.md"`). `.RelRef` does *not* handle in-page fragments correctly. See [Cross References](/content-management/cross-references/). + +.Site +: see [Site Variables](/variables/site/). + +.Summary +: a generated summary of the content for easily showing a snippet in a summary view. The breakpoint can be set manually by inserting  at the appropriate place in the content page. See [Content Summaries](/content-management/summaries/) for more details. + +.TableOfContents +: the rendered [table of contents](/content-management/toc/) for the page. + +.Title +: the title for this page. + +.Translations +: a list of translated versions of the current page. See [Multilingual Mode](/content-management/multilingual/) for more information. + +.Truncated +: a boolean, `true` if the `.Summary` is truncated. Useful for showing a "Read more..." link only when necessary. See [Summaries](/content-management/summaries/) for more information. + +.Type +: the [content type](/content-management/types/) of the content (e.g., `post`). + +.URL +: the URL for the page relative to the web root. Note that a `url` set directly in front matter overrides the default relative URL for the rendered page. + +.UniqueID +: the MD5-checksum of the content file's path. + +.Weight +: assigned weight (in the front matter) to this content, used in sorting. + +.WordCount +: the number of words in the content. + +## Section Variables and Methods + +Also see [Sections](/content-management/sections/). + +{{< readfile file="/content/readfiles/sectionvars.md" markdown="true" >}} + +## Page-level Params + +Any other value defined in the front matter in a content file, including taxonomies, will be made available as part of the `.Params` variable. + +``` +--- +title: My First Post - date: date: 2017-02-20T15:26:23-06:00 ++date: 2017-02-20T15:26:23-06:00 +categories: [one] +tags: [two,three,four] +``` + +With the above front matter, the `tags` and `categories` taxonomies are accessible via the following: + +* `.Params.tags` +* `.Params.categories` + +{{% note "Casing of Params" %}} +Page-level `.Params` are *only* accessible in lowercase. +{{% /note %}} + +The `.Params` variable is particularly useful for the introduction of user-defined front matter fields in content files. For example, a Hugo website on book reviews could have the following front matter in `/content/review/book01.md`: + +``` +--- +... +affiliatelink: "http://www.my-book-link.here" +recommendedby: "My Mother" +... +--- +``` + +These fields would then be accessible to the `/themes/yourtheme/layouts/review/single.html` template through `.Params.affiliatelink` and `.Params.recommendedby`, respectively. + +Two common situations where this type of front matter field could be introduced is as a value of a certain attribute like `href=""` or by itself to be displayed as text to the website's visitors. + +{{< code file="/themes/yourtheme/layouts/review/single.html" >}} +

Buy this book

It was recommended by {{ .Params.recommendedby }}.

+{{< /code >}} + +This template would render as follows, assuming you've set [`uglyURLs`](/content-management/urls/) to `false` in your [site `config`](/getting-started/configuration/): + +{{< output file="yourbaseurl/review/book01/index.html" >}} +

Buy this book

It was recommended by my Mother.

+{{< /output >}} + +{{% note %}} +See [Archetypes](/content-management/archetypes/) for consistency of `Params` across pieces of content. +{{% /note %}} + +### The `.Param` Method + +In Hugo, you can declare params in individual pages and globally for your entire website. A common use case is to have a general value for the site param and a more specific value for some of the pages (i.e., a header image): + +``` +{{ $.Param "header_image" }} +``` + +The `.Param` method provides a way to resolve a single value according to it's definition in a page parameter (i.e. in the content's front matter) or a site parameter (i.e., in your `config`). + +### Access Nested Fields in Front Matter + +When front matter contains nested fields like the following: + +``` +--- +author: + given_name: John + family_name: Feminella + display_name: John Feminella +--- +``` +`.Param` can access these fields by concatenating the field names together with a dot: + +``` +{{ $.Param "author.display_name" }} +``` + +If your front matter contains a top-level key that is ambiguous with a nested key, as in the following case: + +``` +--- +favorites.flavor: vanilla +favorites: + flavor: chocolate +--- +``` + +The top-level key will be preferred. Therefore, the following method, when applied to the previous example, will print `vanilla` and not `chocolate`: + +``` +{{ $.Param "favorites.flavor" }} +=> vanilla +``` + +[gitinfo]: /variables/git/ +[File Variables]: /variables/files/ diff --cc docs/layouts/shortcodes/imgproc.html index 00000000,00000000..f0ab4c8e new file mode 100644 --- /dev/null +++ b/docs/layouts/shortcodes/imgproc.html @@@ -1,0 -1,0 +1,19 @@@ ++{{ $original := .Page.Resources.GetByPrefix (.Get 0) }} ++{{ $command := .Get 1 }} ++{{ $options := .Get 2 }} ++{{ if eq $command "Fit"}} ++{{ .Scratch.Set "image" ($original.Fit $options) }} ++{{ else if eq $command "Resize"}} ++{{ .Scratch.Set "image" ($original.Resize $options) }} ++{{ else if eq $command "Fill"}} ++{{ .Scratch.Set "image" ($original.Fill $options) }} ++{{ else }} ++{{ errorf "Invalid image processing command: Must be one of Fit, Fill or Resize."}} ++{{ end }} ++{{ $image := .Scratch.Get "image" }} ++

diff --cc docs/netlify.toml index c4d592e1,00000000..901acdbb mode 100644,000000..100644 --- a/docs/netlify.toml +++ b/docs/netlify.toml @@@ -1,18 -1,0 +1,18 @@@ +[build] + publish = "public" + command = "hugo" + +[context.production.environment] - HUGO_VERSION = "0.31.1" ++ HUGO_VERSION = "0.32.1" + HUGO_ENV = "production" + HUGO_ENABLEGITINFO = "true" + +[context.deploy-preview.environment] - HUGO_VERSION = "0.31.1" ++ HUGO_VERSION = "0.32.1" + +[context.branch-deploy.environment] - HUGO_VERSION = "0.31.1" ++ HUGO_VERSION = "0.32.1" + +[context.next.environment] + HUGO_BASEURL = "https://next--gohugoio.netlify.com/" + HUGO_ENABLEGITINFO = "true" diff --cc docs/resources/_gen/images/about/new-in-032/sunset_hu59e56ffff1bc1d8d122b1403d34e039f_90587_300x0_resize_q10_box_center.jpg index 00000000,00000000..8736f037 new file mode 100644 Binary files differ diff --cc docs/resources/_gen/images/about/new-in-032/sunset_hu59e56ffff1bc1d8d122b1403d34e039f_90587_300x0_resize_q75_box_center.jpg index 00000000,00000000..47d62fce new file mode 100644 Binary files differ diff --cc docs/resources/_gen/images/about/new-in-032/sunset_hu59e56ffff1bc1d8d122b1403d34e039f_90587_90x120_fill_q75_box_left.jpg index 00000000,00000000..f9e21824 new file mode 100644 Binary files differ diff --cc docs/resources/_gen/images/about/new-in-032/sunset_hu59e56ffff1bc1d8d122b1403d34e039f_90587_90x120_fill_q75_box_right.jpg index 00000000,00000000..fb96b61b new file mode 100644 Binary files differ diff --cc docs/resources/_gen/images/about/new-in-032/sunset_hu59e56ffff1bc1d8d122b1403d34e039f_90587_90x90_fit_q75_box_center.jpg index 00000000,00000000..b8ad2659 new file mode 100644 Binary files differ diff --cc docs/static/images/blog/sunset.jpg index 00000000,00000000..7d7307be new file mode 100644 Binary files differ

{{ .Title }}

Buy this book

Buy this book