hugo/docs/content/meta/release-notes.md
Cameron Moore f52b040ee1 docs: Draft of 0.16 release notes
Also included is an enhancement to the gh shortcode to support sending commit
hashes by prepending "0x" to the hash.
2016-03-21 14:08:39 +01:00

25 KiB
Raw Blame History

aliases lastmod date menu title weight
/doc/release-notes/
/meta/release-notes/
2016-03-12 2013-07-01
main
parent
about
Release Notes 10

0.16.0 TBD

Hugo now has:

  • 8700 (+2000) stars on GitHub
  • 284 (+50) contributors
  • 77 (+10) themes

New Features

  • Add emoji support {{<gh 1892>}}
  • Add themesDir option to configuration {{<gh 1556>}}
  • Add support for Go 1.6 block keyword in templates {{<gh 1832>}}
  • Partial static sync {{<gh 1644>}}
  • Source file based relative linking (a la Github) {{<gh 0x0f6b334b6715253b030c4e783b88e911b6e53e56>}}
  • Templates functions:
    • Add countwords and countrunes template funcs {{<gh 1440>}}
    • Add default template function {{<gh 1943>}}
    • Add hasPrefix template function {{<gh 1243>}}
    • Add humanize template function {{<gh 1450>}}
    • Add jsonify template function {{<gh 0x435e996c4fd48e9009ffa9f83a19fb55f0777dbd>}}
    • Add md5 and sha1 template functions {{<gh 1932>}}
    • Add replaceRE template function {{<gh 1845>}}
    • Add shuffle template function {{<gh 1942>}}
    • Add slice template function {{<gh 1902>}}

Enhancements

  • Print error when /index.html is zero-length {{<gh 947>}}
  • Enable dirname and filename bash autocompletion for more flags {{<gh 0x666ddd237791b56fd048992dca9a27d1af50a10e>}}
  • Improve error handling in commands {{<gh 1502>}}
  • Add sanity checks for hugo import jekyll {{<gh 1625 >}}
  • Add description to Page.Params {{<gh 1484>}}
  • Add async version of Google Analytics internal template {{<gh 1711>}}
  • Add autostart option to YouTube shortcode {{<gh 1784>}}
  • Set Date and Lastmod for main home page {{<gh 1903>}}
  • Allow URL with extension in frontmatter {{<gh 1923>}}
  • Add list support in Scratch {{<gh 0xeaba04e82bdfc5d4c29e970f11b4aab9cc0efeaa>}}
  • Add file option to gist shortcode {{<gh 1955>}}
  • Add config layout and content directory CLI options {{<gh 1698>}}
  • Add boolean value comparison to where template function {{<gh 0xf3c74c9db484c8961e70cb3458f9e41e7832fa12>}}

Fixes

  • Win32 and ARM builds fixed {{<gh 1716>}}
  • Copy static dir files without theme's static dir {{<gh 1656>}}
  • Make noTimes command flag work {{<gh 1657>}}
  • Change most global CLI flags into local ones {{<gh 1624>}}
  • Remove transformation of menu URLs {{<gh 1239>}}
  • Do not fail on unknown Jekyll file {{<gh 1705>}}
  • Use absolute path when editing with editor {{<gh 1589>}}
  • Fix hugo server "Watching for changes" path display {{<gh 1721>}}
  • Do not strip special characters out of URLs {{<gh 1292>}}
  • Fix RSSLink when uglyurls are enabled {{<gh 175>}}
  • Do not call watchConfig when not in watch mode {{<gh 1772>}}
  • Get BaseURL from viper in server mode {{<gh 1821>}}
  • Fix shortcode handling in RST {{<gh 1904>}}
  • Use default sitemap configuration for homepage {{<gh 1304>}}
  • Exit if specific port is unavailable in server mode {{<gh 1901>}}

0.15.0 November 25, 2015

The v0.15.0 Hugo release brings a lot of polish to Hugo. Exactly 6 months after the 0.14 release, Hugo has seen massive growth and changes. Most notably, this is Hugo's first release under the Apache 2.0 license. With this license change we hope to expand the great community around Hugo and make it easier for our many users to contribute. This release represents over 377 contributions by 87 contributors to the main Hugo repo and hundreds of improvements to the libraries Hugo uses. Hugo also launched a new theme showcase and participated in Hacktoberfest.

Hugo now has:

  • 6700 (+2700) stars on GitHub
  • 235 (+75) contributors
  • 65 (+30) themes

Template Improvements: This release takes Hugo to a new level of speed and usability. Considerable work has been done adding features and performance to the template system which now has full support of Ace, Amber and Go Templates.

Hugo Import: Have a Jekyll site, but dreaming of porting it to Hugo? This release introduces a new hugo import jekyllcommand that makes this easier than ever.

Performance Improvements: Just when you thought Hugo couldn't get any faster, Hugo continues to improve in speed while adding features. Notably Hugo 0.15 introduces the ability to render and serve directly from memory resulting in 30%+ lower render times.

Huge thanks to all who participated in this release. A special thanks to {{< gh "@bep" >}} who led the development of Hugo this release again, {{< gh "@anthonyfok" >}}, {{< gh "@eparis" >}}, {{< gh "@tatsushid" >}} and {{< gh "@DigitalCraftsman" >}}.

New features

  • new hugo import jekyll command. {{< gh 1469 >}}
  • The new Param convenience method on Page and Node can be used to get the most specific parameter value for a given key. {{< gh 1462 >}}
  • Several new information elements have been added to Page and Node:
    • RuneCount: The number of runes in the content, excluding any whitespace. This may be a good alternative to .WordCount for Japanese and other CJK languages where a word-split by spaces makes no sense. {{< gh 1266 >}}
    • RawContent: Raw Markdown as a string. One use case may be of embedding remarkjs.com slides.
    • IsHome: tells the truth about whether you're on the home page or not.

Improvements

  • hugo server now builds ~30%+ faster by rendering to memory instead of disk. To get the old behavior, start the server with --renderToDisk=true.
  • Hugo now supports dynamic reloading of the config file when watching.
  • We now use a custom-built LazyFileReader for reading file contents, which means we don't read media files in /content into memory anymore -- and file reading is now performed in parallel on multicore PCs. {{< gh 1181 >}}
  • Hugo is now built with Go 1.5 which, among many other improvements, have fixed the last known data race in Hugo. {{< gh 917 >}}
  • Paginator now also supports page groups. {{< gh 1274 >}}
  • Markdown improvements:
    • Hugo now supports GitHub-flavoured markdown code fences for highlighting for md-files (Blackfriday rendered markdown) and mmark files (MMark rendered markdown). {{< gh 362 1258 >}}
    • Several new Blackfriday options are added:
      • Option to disable Blackfriday's Smartypants.
      • Option for Blackfriday to open links in a new window/tab. {{< gh 1220 >}}
      • Option to disable Blackfriday's LaTeX style dashes {{< gh 1231 >}}
      • Definition lists extension support.
  • Scratch now has built-in map support.
  • We now fall back to link title for the default page sort. {{< gh 1299 >}}
  • Some notable new configuration options:
    • IgnoreFiles can be set with a list of Regular Expressions that matches files to be ignored during build. {{< gh 1189 >}}
    • PreserveTaxonomyNames, when set to true, will preserve what you type as the taxonomy name both in the folders created and the taxonomy key, but it will be normalized for the URL. {{< gh 1180 >}}
  • hugo gen can now generate man files, bash auto complete and markdown documentation
  • Hugo will now make suggestions when a command is mistyped
  • Shortcodes now have a boolean .IsNamedParams property. {{< gh 1597 >}}

New Template Features

  • All template engines:
    • The new dict function that could be used to pass maps into a template. {{< gh 1463 >}}
    • The new pluralize and singularize template funcs.
    • The new base64Decode and base64Encode template funcs.
    • The sort template func now accepts field/key chaining arguments and pointer values. {{< gh 1330 >}}
    • Several fixes for slicestr and substr, most importantly, they now have full utf-8-support. {{< gh 1190 1333 1347 >}}
    • The new last template function allows the user to select the last N items of a slice. {{< gh 1148 >}}
    • The new after func allows the user to select the items after the Nth item. {{< gh 1200 >}}
    • Add time.Time type support to the where, ge, gt, le, and lt template functions.
    • It is now possible to use constructs like where Values ".Param.key" nil to filter pages that doesn't have a particular parameter. {{< gh 1232 >}}
    • getJSON/getCSV: Add retry on invalid content. {{< gh 1166 >}}
    • The new readDir func lists local files. {{< gh 1204 >}}
    • The new safeJS function allows the embedding of content into JavaScript contexts in Go templates.
    • Get the main site RSS link from any page by accessing the .Site.RSSLink property. {{< gh 1566 >}}
  • Ace templates:
    • Base templates now also works in themes. {{< gh 1215 >}}.
    • And now also on Windows. {{< gh 1178 >}}
  • Full support for Amber templates including all template functions.
  • A built-in template for Google Analytics. {{< gh 1505 >}}
  • Hugo is now shipped with new built-in shortcodes: {{< gh 1576 >}}
    • youtube for YouTube videos
    • vimeo for Vimeo videos
    • gist for GitHub gists
    • tweet for Twitter Tweets
    • speakerdeck for Speakerdeck slides

Bugfixes

  • Fix data races in page sorting and page reversal. These operations are now also cached. {{< gh 1293 >}}
  • page.HasMenuCurrent() and node.HasMenuCurrent() now work correctly in multi-level nested menus.
  • Support Fish and Chips style section titles. Previously, this would end up as Fish And Chips. Now, the first character is made toupper, but the rest are preserved as-is. {{< gh 1176 >}}
  • Hugo now removes superfluous p-tags around shortcodes. {{< gh 1148 >}}

Notices

  • hugo server will watch by default now.
  • Some fields and methods were deprecated in 0.14. These are now removed, so the error message isn't as friendly if you still use the old values. So please change:
    • getJson to getJSON, getCsv to getCSV, safeHtml to safeHTML, safeCss to safeCSS, safeUrl to safeURL, Url to URL, UrlPath to URLPath, BaseUrl to BaseURL, Recent to Pages.

Known Issues

Using the Hugo v0.15 32-bit Windows or ARM binary, running hugo server would crash or hang due to a memory alignment issue in Afero. The bug was discovered shortly after the v0.15.0 release and has since been fixed by {{< gh "@tpng" >}}. If you encounter this bug, you may either compile Hugo v0.16-DEV from source, or use the following solution/workaround:

  • 64-bit Windows users: Please use hugo_0.15_windows_amd64.zip (amd64 == x86-64). It is only the 32-bit hugo_0.15_windows_386.zip that crashes/hangs (see {{< gh 1621 >}} and {{< gh 1628 >}}).
  • 32-bit Windows and ARM users: Please run hugo server --renderToDisk as a workaround until Hugo v0.16 is released (see “hugo server” returns runtime error on armhf and {{< gh 1716 >}}).

0.14.0 May 25, 2015

The v0.14.0 Hugo release brings of the most demanded features to Hugo. The foundation of Hugo is stabilizing nicely and a lot of polish has been added. Weve expanded support for additional content types with support for AsciiDoc, Restructured Text, HTML and Markdown. Some of these types depend on external libraries as there does not currently exist native support in Go. Weve tried to make the experience as seamless as possible. Look for more improvements here in upcoming releases.

A lot of work has been done to improve the user experience, with extra polish to the Windows experience. Hugo errors are more helpful overall and Hugo now can detect if its being run in Windows Explorer and provide additional instructions to run it via the command prompt.

The Hugo community continues to grow. Hugo has over 4000 stars on github, 165 contributors, 35 themes and 1000s of happy users. It is now the 5th most popular static site generator (by Stars) and has the 3rd largest contributor community.

This release represents over 240 contributions by 36 contributors to the main Hugo codebase.

Big shout out to {{< gh "@bep" >}} who led the development of Hugo this release, {{< gh "@anthonyfok" >}}, {{< gh "@eparis" >}}, {{< gh "@SchumacherFM" >}}, {{< gh "@RickCogley" >}} & {{< gh "@mdhender" >}} for their significant contributions and {{< gh "@tatsushid" >}} for his continuous improvements to the templates. Also a big thanks to all the theme creators. 11 new themes have been added since last release and the hugoThemes repo now has previews of all of them.

Hugo also depends on a lot of other great projects. A big thanks to all of our dependencies including: cobra, viper, blackfriday, pflag, HugoThemes, BurntSushi, goYaml, and the Go standard library.

New features

  • Support for all file types in content directory.
    • If dedicated file type handler isnt found it will be copied to the destination.
  • Add AsciiDoc support using external helpers.
  • Add experimental support for 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
  • Adding RelativeURLs = true to site config will now make all the relative URLs relative to the content root.
  • New template functions:
    • getenv
    • The string functions substr and slicestr
    • seq, a sequence generator very similar to its Gnu counterpart
    • 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!
  • 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
  • Add support for canonifyurls in srcset
  • Add shortcode support for HTML (content) files
  • Allow the same shortcode to be used with or without inline content
  • Configurable RSS output filename

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 paginator with uglyurls
  • Fix {{< gh 998 >}}, supporting UTF8 characters in Permalinks.

Notices

  • To get variable and function names in line with the rest of the Go community, a set of variable and function names has been deprecated: These will still work in 0.14, but will be removed in 0.15. What to do should be obvious by the build log; getJson to getJSON, getCsv to getCSV, safeHtml to safeHTML, safeCss to safeCSS, safeUrl to safeURL, Url to URL, UrlPath to URLPath, BaseUrl to BaseURL, Recent to Pages, Indexes to Taxonomies.

0.13.0 Feb 21, 2015

The v0.13.0 release is the largest Hugo release to date. The release introduced some long sought after features (pagination, sequencing, data loading, tons of template improvements) as well as major internal improvements. In addition to the code changes, the Hugo community has grown significantly and now has over 3000 stars on github, 134 contributors, 24 themes and 1000s of happy users.

This release represents 448 contributions by 65 contributors

A special shout out to {{< gh "@bep" >}} and {{< gh "@anthonyfok" >}} for their new role as Hugo maintainers and their tremendous contributions this release.

New major features

  • Support for data files in YAML, JSON, or TOML located in the data directory ({{< gh 885 >}})
  • Support for dynamic content by loading JSON & CSV from remote sources via GetJson and GetCsv in short codes or other layout files ({{< gh 748 >}})
  • Pagination support for home page, sections and taxonomies ({{< gh 750 >}})
  • Universal sequencing support
    • A new, generic Next/Prev functionality is added to all lists of pages (sections, taxonomies, etc.)
    • Add in-section Next/Prev content pointers
  • Scratch -- a "scratchpad" for your node- and page-scoped variables
  • Cross Reference support to easily link documents together with the ref and relref shortcodes.
  • Ace template engine support ({{< gh 541 >}})
  • A new shortcode token of {{</* */>}} (raw HTML) alongside the existing {{%/* */%}} (Markdown)
  • A top level Hugo variable (on Page & Node) is added with various build information
  • Several new ways to order and group content:
    • ByPublishDate
    • GroupByPublishDate(format, order)
    • GroupByParam(key, order)
    • GroupByParamDate(key, format, order)
  • Hugo has undergone a major refactoring, with a new handler system and a generic file system. This sounds and is technical, but will pave the way for new features and make Hugo even speedier

Notable enhancements to existing features

  • The shortcode handling is rewritten for speed and better error messages.
  • Several improvements to the template functions:
    • where is now even more powerful and accepts SQL-like syntax with the operators ==, eq; !=, <>, ne; >=, ge; >, gt; <=, le; <, lt; in, not in
    • where template function now also accepts dot chaining key argument (e.g. "Params.foo.bar")
  • New template functions:
    • apply
    • chomp
    • delimit
    • sort
    • markdownify
    • in and intersect
    • trim
    • replace
    • dateFormat
  • Several configurable improvements related to Markdown rendering:
    • Configuration of footnote rendering
    • Optional support for smart angled quotes, e.g. "Hugo" → «Hugo»
    • Enable descriptive header IDs
  • URLs in XML output is now correctly canonified ({{< gh 725 728 >}}, and part of {{< gh 789 >}})

Other improvements

  • Internal change to use byte buffer pool significantly lowering memory usage and providing measurable performance improvements overall
  • Changes to docs:
  • hugo new now copies the content in addition to the front matter
  • Improved unit test coverage
  • Fixed a lot of Windows-related path issues
  • Improved error messages for template and rendering errors
  • Enabled soft LiveReload of CSS and images ({{< gh 490 >}})
  • Various fixes in RSS feed generation ({{< gh 789 >}})
  • HasMenuCurrent and IsMenuCurrent is now supported on Nodes
  • A bunch of bug fixes

0.12.0 Sept 1, 2014

A lot has happened since Hugo v0.11.0 was released. Most of the work has been focused on polishing the theme engine and adding critical functionality to the templates.

This release represents over 90 code commits from 28 different contributors.

  • 10 new themes created by the community
  • Fully themable Partials
  • 404 template support in themes
  • Shortcode support in themes
  • Views support in themes
  • Inner shortcode content now treated as Markdown
  • Support for header ids in Markdown (# Header {#myid})
  • Where template function to filter lists of content, taxonomies, etc.
  • GroupBy & GroupByDate methods to group pages
  • Taxonomy pages list now sortable, filterable, limitable & groupable
  • General cleanup to taxonomies & documentation to make it more clear and consistent
  • Showcase returned and has been expanded
  • Pretty links now always have trailing slashes
  • BaseUrl can now include a subdirectory
  • Better feedback about draft & future post rendering
  • A variety of improvements to the website

0.11.0 May 28, 2014

This release represents over 110 code commits from 29 different contributors.


0.10.0 March 1, 2014

This release represents over 110 code commits from 29 different contributors.


0.9.0 November 15, 2013

This release represents over 220 code commits from 22 different contributors.

  • New command based interface similar to git (hugo server -s ./)
  • Amber template support
  • Aliases (redirects)
  • Support for top level pages (in addition to homepage)
  • Complete overhaul of the documentation site
  • Full Windows support
  • Better index support including ordering by content weight
  • Add params to site config, available in .Site.Params from templates
  • Friendlier json support
  • Support for html & xml content (with frontmatter support)
  • Support for summary content divider (<!--more-->)
  • HTML in summary (when using divider)
  • Added "Minutes to Read" functionality
  • Support for a custom 404 page
  • Cleanup of how content organization is handled
  • Loads of unit and performance tests
  • Integration with travis ci
  • Static directory now watched and copied on any addition or modification
  • Support for relative permalinks
  • Fixed watching being triggered multiple times for the same event
  • Watch now ignores temp files (as created by Vim)
  • Configurable number of posts on homepage
  • Front matter supports multiple types (int, string, date, float)
  • Indexes can now use a default template
  • Addition of truncated bool to content to determine if should show 'more' link
  • Support for linkTitles
  • Better handling of most errors with directions on how to resolve
  • Support for more date / time formats
  • Support for go 1.2
  • Support for first in templates

0.8.0 August 2, 2013

This release represents over 65 code commits from 6 different contributors.

  • Added support for pretty urls (filename/index.html vs filename.html)
  • Hugo supports a destination directory
  • Will efficiently sync content in static to destination directory
  • Cleaned up options.. now with support for short and long options
  • Added support for TOML
  • Added support for YAML
  • Added support for Previous & Next
  • Added support for indexes for the indexes
  • Better Windows compatibility
  • Support for series
  • Adding verbose output
  • Loads of bugfixes

0.7.0 July 4, 2013

  • Hugo now includes a simple server
  • First public release

0.6.0 July 2, 2013

  • Hugo includes an example documentation site which it builds

0.5.0 June 25, 2013

  • Hugo is quite usable and able to build spf13.com