Release v3.3.0

New features

There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.4.1.

1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend release notes for more information, or contact the GOV.UK Design System team.

Fixes

• #242: Make scrollable area keyboard (and voice) focusable (thanks @colinbm)

Release v3.2.1

Fixes

• #296: Fix Nokogiri Node.new deprecation warnings (thanks @timja)

Release v3.2.0

New features

You can now configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets.

Thanks @eddgrant for contributing this feature and the associated fixes.

This change was introduced in pull request #291: Support sites deployed on paths other than "/" (by generating relative links).

v3.1.0

New features

There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.

1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend 4.0.0 release note for more information.

v3.0.1

Fixes

We’ve made the following fixes to the tech docs gem in pull request #281: Don't break TOC when OpenAPI description includes headers:

• we now render OpenAPI Markdown with the same Markdown renderer as other documents
• table of contents (TOC) uses TechDocsHTMLRenderer to render the headings with IDs

Thanks to @jamietanna for contributing to this issue and its solution.

v3.0.0

Breaking changes

The search user experience is now more accessible for screenreader users. Search results are now on a separate page instead of a modal window.

Users can no longer see search results as they type. They must press the Return key or select the search button to see the search results page.

This was added in pull request #263: Change search to only show results after submit.

Fixes

• #265: Fix mark styles in Windows High Contrast Mode

v2.4.3

• #236: Fix search 'autocomplete' behaviour
• #203: Update vendored javascripts

v2.4.2

• #251 Fix missing <ul> in single page navigation

v2.4.1

• #248: Remove IE8 fallback PNG with broken image reference

v2.4.0

• Bump redcarpet to 3.5.1 to fix CVE-2020-26298
• #238: Move the aria-expanded attribute to the correct element
• #240: Update menu html structure so it's one single hierarchical list
• #244: Don't change the focus of the page on initial load
• #243: Fix focus state for links containing inline code
• #245: Fix focus state for search results ‘Close’ button
• #246: Update GOV.UK Frontend to v3.13.0