Releases: alphagov/tech-docs-gem
Release 3.5.0
Release v3.3.1
Fix
This change solves a potential security issue with HTML snippets. Pages indexed in search results have their entire contents indexed, including any HTML code snippets. These HTML snippets would appear in the search results unsanitised, making it possible to render arbitrary HTML or run arbitrary scripts.
You can see more detail about this issue at #323: Fix XSS vulnerability on search results page
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.
- Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
- 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
Release v3.2.1
Fixes
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.
- Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
- 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
TechDocsHTMLRendererto 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.
