Skip to content

Releases: zkreations/hudocs

v2.0.0

Choose a tag to compare

@danieIabel danieIabel released this 23 Sep 00:07
48fda31

Hudocs 2.0.0

Hudocs 2.0.0 introduces a new content structure, updated shortcode APIs, a redesigned CSS architecture, and several new documentation features, with significant improvements to performance and accessibility.

Breaking Changes

Content structure

  • Documentation root: Documentation versions must now live inside content/docs/, for example content/docs/latest/ or content/docs/1.8/. Documentation content is no longer placed directly under content/.
  • Standalone content: Standalone pages, posts, and other non-documentation content now use their own content structure.

Shortcodes

  • Removed {{< table >}}: Standard Markdown tables are now handled by Hugo's native render-table.html hook, which provides responsive table containers.
  • Removed {{< code >}}: Code blocks now use standard fenced Chroma syntax.
  • Separator syntax: {{< columns >}} and {{< annotated >}} now use --- or <!-- split --> instead of <---->.
  • {{< tab >}}: Now works as an independent shortcode nested inside {{< tabs >}}. The tab title can be passed positionally or through title="...".
  • {{< pagelink >}}: Parameters have been updated to title and description (or subtitle). External-link indicators are now independent from the custom icon.
  • {{< hint >}}: The deprecated error type has been removed. Use danger or warning instead.

Configuration

Several [params] options have been renamed to use semantic prefixes:

Previous New
github_repo_edit docs_edit_url
main_icon brand_icon
main_logo brand_logo
badge_text docs_badge_text
badge_url docs_badge_url
expand_tree docs_expand_tree
pagination docs_pagination
date_format footer_date_format
copyright footer_copyright

CSS architecture

  • Styles are now organized into cascade layers: reset, base, layout, components, and utilities.
  • Color variables have been consolidated into semantic tokens such as --primary, --surface, --on-surface, and --outline.
  • Custom CSS overrides must now be placed in assets/scss/_custom.scss, outside the cascade layers.

Features

AI assistant

  • Added article-header actions for Open in ChatGPT and Open in Claude, configurable through docs_ai, docs_chatgpt, and docs_claude.

Blog and standalone content

  • Added support for blog posts with pagination through posts_paginate.
  • Added configurable post dates through posts_date_format.
  • Added post cards and RSS feed support.
  • Added support for standalone pages such as /about.
  • Added directory landing pages and blank layouts.

New shortcodes

  • {{< steps >}} — Numbered step-by-step guides.
  • {{< annotated >}} — Combines code, tabs, or tables with explanatory notes.
  • {{< types >}} — Formats data types, expressions, unions, and parameter structures with badge styles.
  • {{< tabs >}} — Tabbed content with automatic merging of consecutive syntax tabs.

Navigation and documentation

  • docs_expand_tree expands all documentation sections by default.

  • Added support for deeply nested documentation hierarchies.

  • Added a collapsible mobile table of contents with scrollspy.

  • Added native Hugo render hooks:

    • render-heading.html
    • render-image.html
    • render-link.html
    • render-table.html

Code themes

Added params.code_theme with six themes from Atom's Duotone project:

  • duotone-dark
  • duotone-dark-sky
  • duotone-dark-sea
  • duotone-dark-space
  • duotone-dark-earth
  • duotone-dark-forest

Performance

  • Migrated the search index to a columnar JSON format to reduce payload size.
  • Search scripts and FlexSearch now load on demand.
  • Copy buttons use event delegation through a single listener.
  • High-frequency partials now use partialCached.
  • The image render hook calculates intrinsic width and height and optimizes image loading.
  • The first image can be prioritized through Ordinal 0, #priority, or #eager.
  • Replaced physical margin and padding properties with CSS logical properties.
  • Reduced the number of media queries by using fluid layouts with clamp() and intrinsic flexbox sizing.
  • Improved build and deployment performance, reducing build times from approximately 10 seconds to 1 second.

Accessibility

  • Search dialog now follows the ARIA combobox pattern with keyboard navigation.
  • Added a Skip to content shortcut.
  • Sidebar navigation now uses role="tree".
  • Hints use localized role="note" and aria-label attributes.
  • Added aria-expanded and aria-controls to dropdowns and the mobile table of contents.
  • Table header cells now receive scope="col" automatically through render-table.html.
  • Smooth scrolling now respects prefers-reduced-motion.
  • localStorage access is protected against exceptions in restricted iframes and private browsing contexts.
  • Improved keyboard navigation across menus, tabs, and other interactive elements without requiring a mouse.

v1.8.0

Choose a tag to compare

@danieIabel danieIabel released this 10 Aug 02:12
d4e0666

What's New in 1.8.0

New Documentation & Configuration System

  • New installation, configuration, and deployment documentation.
  • Deployment guides for Netlify and Vercel.
  • Clearer configuration examples.
  • Out-of-the-box zero configuration with practically no adjustments needed.

Major Search Improvements

  • Improved search system performance.
  • Bug fixes.
  • XSS sanitization for search results.
  • The search script now loads only where required.
  • Search assets loaded locally.
  • Build-time icon generation.
  • Improved scrolling behavior for search results.

Performance Improvements

  • Theme handling optimization.
  • Added Inter as a new local font.
  • Preloading for font assets.
  • Removed unused font files.
  • Fine-tuned font weights and variables.
  • Removed external dependencies—everything loads locally during build time.

Accessibility Enhancements

  • Improved color contrast.
  • Updated color variables to better meet accessibility standards (WCAG).
  • Enhanced button visibility in dark mode.
  • Grayscale color adjustments.
  • Better heading readability.
  • Dark mode-adapted favicon.

Internationalization (i18n)

  • Formal configuration for English and Spanish.
  • Improvements to the language switcher.
  • Fixes in translation labels and examples.
  • Support for localized badge text.

More Configurable Badges

  • Boolean toggle activation.
  • Page-level custom text.
  • Site-level default text.
  • Localized default values.
  • Badge URLs customizable at both page and site levels.

Improved SEO

  • Enhanced SEO metadata across documentation pages.
  • Open Graph metadata fixes.
  • Better site URL and reference configuration.

Security

  • Content Security Policy (CSP) configuration enhancements.
  • Security headers configured for Netlify.
  • Removed obsolete robots.txt and sitemap.xml files.
  • Hardened search security through input sanitization.

Hugo Compatibility & Upgrade

  • Minimum required version bumped to Hugo 0.164.0.
  • Added go.mod and hugo.toml for modern module configuration.
  • Improvements to version and section handling.

Navigation & Component Improvements

  • Fixes in the version selector.
  • Better fallback behavior when no versions are available.
  • Fixes for button and pagelink shortcodes.
  • Icons upgraded to Meteor Icons 4.
  • Improved click-outside event handling.
  • Pagination improvements.

v1.7.0

Choose a tag to compare

@danieIabel danieIabel released this 21 Jul 22:53
2a53c5e
fix(flat-pages): prevent appending redirect pages to the list

v1.6.0

Choose a tag to compare

@danieIabel danieIabel released this 03 Jun 21:25
6b60f62
fix(security): update Content-Security-Policy hash in netlify.toml an…

v1.5.0

Choose a tag to compare

@danieIabel danieIabel released this 02 Jun 00:13
1f2573b
feat(i18n): integrate i18nText for copy button accessibility labels #8

v1.4.0

Choose a tag to compare

@danieIabel danieIabel released this 12 Apr 15:50
c54aa57
fix(header): update version links to use relLangURL for correct langu…

v1.3.0

Choose a tag to compare

@danieIabel danieIabel released this 12 Apr 07:22
0bb2453
refactor(search): refactor search logic to query across distinct cont…

v1.2.0

Choose a tag to compare

@danieIabel danieIabel released this 09 Apr 09:20
65b8c20
docs: update image preview

v1.1.0

Choose a tag to compare

@danieIabel danieIabel released this 14 Mar 11:48
60619af
fix: double SVG container in search results #5

v1.0.0

Choose a tag to compare

@danieIabel danieIabel released this 12 Jul 20:45
17ae008
fix: pagina principal segun idioma