Releases: alex-shpak/hugo-book
Releases · alex-shpak/hugo-book
v13
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
alttexts.
v12
This is pretty large breaking release in theme, partially discussed in #748
Breaking changes
- Theme now requires Hugo version
0.146.0that has updated templating system and many templates have been moved around. If you do not have custom template overrides you should not be affected. BookCommitPathandBookEditPathare not templates and need to be updated.- Release branch have been moved from
mastertomain
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/iconsfolder, limited tosvgfor now. - A landing page layout!
- Codeblocks support for
mermaidandkatex. - Custom font have been removed from the theme, relying on
system-uifrom now on. - Thumbnail support and redesign of blog pages.
- Support for Github style hint / notices in markdown
Contributions
- Add BookFavicon param to readme by @mrled in #726
- Feature: Add next and previous page links by @alex-shpak in #747
- Create sw.yaml by @mtemakuni320 in #732
- Added support for ```mermaid by @CharlesPhilippeLabbe in #729
- use fonts from static/fonts instead of google fonts by @jrpie in #724
- toc-show.html: enforce default value true for .Site.Params.BookToc by @dilyanpalauzov in #755
- i18n: Add Bulgarian translation by @dilyanpalauzov in #754
Full Changelog: v11.0.0...v12.0.0
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
- Fix link in README by @leoheitmannruiz in #618
- Update README.md by @michael-schmetter in #655
- Fix deprecation warnings by @deining in #653
- Fix for spaces being removed during "minify" build for "mermaid" snippet by @FuadEfendi in #613
- fix: hreflang for link rel=alternate uses site language code by @anatawa12 in #654
- Bug fix: wrong number for nested titles in TOC; add number for mobile TOC by @loikein in #555
- Three hugo deprecations by @mvtango in #664
- Docs: Change tabs shortcode example to permit unsafe=false by @vadcx in #689
- fix: change article title from h2 to h1 in single.html by @go-bai in #694
- fix: correct hint shortcodes rendering in lists by @sfavazza in #699
- fix: links to fragment on same page should not be made portable by @DvdGiessen in #707
Translations
- Add Dutch translations by @DvdGiessen in #631
- Create oc.yaml by @ensag-dev in #682
- Add Polish translations by @SaQQ in #690
- Update pt.yaml by @Blackspirits in #715
- Create pt-BR.yaml by @Blackspirits in #717
Big thank you to all contributors!
Full Changelog: v10...v11.0.0
v10
Notable changes
Theme uses fusejs as page search engine.
Theme requires at least hugo 0.124.
New translations
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
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
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
mainbranch 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
- Minimum required version of Hugo is
0.68. - Translations
- New features
- Added RTL support.
- Added anchors to markdown headings.
- Introduced service-worker and offline cache (as experimental feature).
- New partial:
docs/dateadding support for date customization. - Added
detailsshortcode as replacement forexpandshortcode.
- Other changes and improvements
- Improved accessibility and keyboard navigation.
- MermaidJS updated to version
8.4.8. - Page title generation is now cross-platform.
- Added
hreflangmetadata is to pages. - Language switch now uses
.Permalinkfor multi-domain websites. - Visited links are highlighted only in markdown.
- New
404.htmlpage design. - Multiple fixes in
numbered.scssplugin.
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-beforeandcontent-afterinject partials, #150 - Whitespace fixes in
tabsandcolumnsshortcodes - Tap on body will now close side menu in mobile view #154
- Added expand indicator in collapsed section, #155
inject/footerpartial has been moved under footer tag, #161404.htmlnow has link to site home #178- Improved description generation #177, #176
- Fixed taxonomy link with spaces or non-urlizeable characters #140
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.tableOfContentsandBookToCis a boolean now. - Introduced comments support (#120)
- There are changes in partials and templates, there are new
header,footer,menu,commentstemplates 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
sor/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
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
katexshortcode. KaTeX. - New
hintshortcode - 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
flexsearchadding multi-language support. - Also many small fixes and html and css.
- Updates to documentation