Skip to content

Releases: alex-shpak/hugo-book

v13

19 Oct 13:43

Choose a tag to compare

Notable changes

  • Theme is moving back to non-semver versioning.
  • Logic to display ToC has been modified once again.
  • Improved consistency of handling shortcode attributes
  • A lot of small changes improving keyboard navigation, readability and accessibility
  • Color theming have been improved with more CSS vars
  • New 404 page
  • New option to configure portable links behaviour: off, error or warning
  • Multiple spacing updated to give more uniform look
  • All icons are covered now by translatable alt texts.

v12

26 Sep 21:11

Choose a tag to compare

v12

This is pretty large breaking release in theme, partially discussed in #748

Breaking changes

  • Theme now requires Hugo version 0.146.0 that has updated templating system and many templates have been moved around. If you do not have custom template overrides you should not be affected.
  • BookCommitPath and BookEditPath are not templates and need to be updated.
  • Release branch have been moved from master to main

Notable new features

  • Support for automated previous and next pages in documentation.
  • Support for .Site.Copyright.
  • New shortcodes image, card, badge, asciinema.
  • Image shortcode allows to zoom in on image with pure CSS!
  • Improved whitespace handling in shortcodes, so they work nicely when nested.
  • Updated portable links and images with better support for page and site resources.
  • Icons support in menus, bring your own icons in assets/icons folder, limited to svg for now.
  • A landing page layout!
  • Codeblocks support for mermaid and katex.
  • Custom font have been removed from the theme, relying on system-ui from now on.
  • Thumbnail support and redesign of blog pages.
  • Support for Github style hint / notices in markdown

Contributions

Full Changelog: v11.0.0...v12.0.0

v11

30 May 19:47

Choose a tag to compare

v11

Notable changes

  • Theme requires hugo 0.134
  • Auto-generate ID for tabs by @orsinium in #649
  • fix: Fixed edit page support for multilang books by @Rojax in #630
  • Add scrollbar-gutter: stable by @mrled in #703

What's Changed

Translations

Big thank you to all contributors!
Full Changelog: v10...v11.0.0

v10

18 May 11:00

Choose a tag to compare

v10

Notable changes

Theme uses fusejs as page search engine.
Theme requires at least hugo 0.124.

New translations

Italian (#356)
Amharic (#444)

Other changes and fixes

This release contains various improvmenet for RTL pages support. (#350, #354, #349)
New bookHref parameter to navigate from generated menu to a specific link. (#440)
Allow site title customisation. (#384)

Big thank you to all contributors!
Full Changelog: v9...v10

v9

03 May 20:17

Choose a tag to compare

v9

Notable changes

  • Collapsed menus can be navigated without changing page!
  • Most SCSS vars were migration to CSS vars.
  • MermaidJS configuration can be customized.
  • Lead image can be now added to posts via image: frontmatter.
  • New partials: before and after toc.

New translations

  • Traditional Chinese (#335)
  • Turkish (#300)

Other changes and fixes

  • Post title rendering is now using proper partial.
  • Collapsible menus are now changing arrow on toggle (#332).
  • Link to SCM is now pointing to main branch by default.
  • Edit link can be more customized.
  • Bug Fix: Empty .Site.Params.contentDir (#312)
  • Button shortcode can now render markdown (#308)
  • Set default content direction to ltr (#307)
  • New 'BookOnlyTranslated' property to display only links to translated pages (#303)
  • MermaidJS upgraded to v8.9.0 (#305)
  • New page param: bookSearchExclude to exclude pages from search index

Big thank you to all contributors!

v8

07 Jul 21:23

Choose a tag to compare

v8
  • Minimum required version of Hugo is 0.68.
  • Translations
    • pt.yaml (#199).
    • nb.yaml (#219).
    • ua.yaml.
    • cn translation is renamed to 'zh'.
  • New features
    • Added RTL support.
    • Added anchors to markdown headings.
    • Introduced service-worker and offline cache (as experimental feature).
    • New partial: docs/date adding support for date customization.
    • Added details shortcode as replacement for expand shortcode.
  • Other changes and improvements
    • Improved accessibility and keyboard navigation.
    • MermaidJS updated to version 8.4.8.
    • Page title generation is now cross-platform.
    • Added hreflang metadata is to pages.
    • Language switch now uses .Permalink for multi-domain websites.
    • Visited links are highlighted only in markdown.
    • New 404.html page design.
    • Multiple fixes in numbered.scss plugin.

v7

23 Mar 19:10

Choose a tag to compare

v7

New release! 🎉

  • Minimum required version of Hugo is 0.65.
  • Docs template is now default for all pages. #157
  • Support for portable links! Without {{< relref >}} shortcode!
  • More translations
  • Default text color is black now, for better accessibility.
  • Better language switch (keyboard access).
  • Button shortcode redesign.
  • Added page counters for tags (and other taxonomy)
  • Added hugo native menus support https://gohugo.io/content-management/menus/
  • New content-before and content-after inject partials, #150
  • Whitespace fixes in tabs and columns shortcodes
  • Tap on body will now close side menu in mobile view #154
  • Added expand indicator in collapsed section, #155
  • inject/footer partial has been moved under footer tag, #161
  • 404.html now has link to site home #178
  • Improved description generation #177, #176
  • Fixed taxonomy link with spaces or non-urlizeable characters #140

v6

04 Feb 21:43

Choose a tag to compare

v6

There are potential breaking changes!

  • Required hugo version is 0.60.
  • Added support for white icons in dark mode.
  • ToC levels are now controlled by hugo: markup.tableOfContents and BookToC is a boolean now.
  • Introduced comments support (#120)
  • There are changes in partials and templates, there are new header, footer, menu, comments templates that can be overwritten.
  • There is now support for taxonomies (tags, categories, etc) (#66).
  • ToC is now displayed on mobile devices as well (#121).
  • New translations (help needed!).
  • Search can be focused with s or / keys (#135).
  • There is new option to disable menu scroll reset (#90).
  • Fix: KaTeX shortcode got display/inline modes to embed into markdown (#117).
  • Fix: Printing in Firefox (#127) https://bugzilla.mozilla.org/show_bug.cgi?id=939897.
  • Fix: dates is not showed in posts if not specified (#113).
  • Fix: edit page URLs on Windows (#116).
  • Fix: disabling JavaScript regression (#90).

Big thank to all contributors!

v5

01 Dec 13:52

Choose a tag to compare

v5
  • Search is now powered by flexsearch.js
  • Hugo required version is 0.56
  • #92, use 'em' units for markdown line-height
  • #94, Add printing styles
  • #87, Add support for multilang search index generation
  • #93, Multilingual support
  • #100, Make h4, h5 and h6 bolder and increase font size

v4

27 Oct 13:03

Choose a tag to compare

v4

There is big list of changes and presumably breaking changes as well.

  • Fixes in search object serialization and index creation.
  • Fix in file-tree menu rendering. Breaking change. #70
  • Site logo feature. #71
  • New katex shortcode. KaTeX.
  • New hint shortcode
  • Table of content is now enabled for posts as well.
  • Improved SCSS file layout allowing easier vars/styles overrides
  • SCSS plugins: dark theme and numbered markdown headings.
  • Search is migrated to flexsearch adding multi-language support.
  • Also many small fixes and html and css.
  • Updates to documentation