tech-docs-gem
tech-docs-gem copied to clipboard
alphagov
Gem to distribute the tech docs project
## What If a heading includes for instance an apostrophe it gets converted to its entity reference number in the resulting id. So for instance ``` ## Turn on 'compatibility...
We can use the `warning_text` help with a plain sentence to output a warning: https://tdt-documentation.london.cloudapps.digital/amend_project/content/#insert-a-warning If we want to put more complicated markup into this helper it does not work,...
The GOV.UK Logo and the New Transport font should only be included when the documentation is going be hosted on a `gov.uk` domain. There's likely to be other organisations within...
The build fails often on master since it is trying to republish the gem when there's been no change to the version: ` Repushing of gem versions is not allowed....
If the last section on a page is not enough to full the viewport you can't get the header to be highlighted. This is particularly jarring if you link to...
If you have content above the first header in the page you can hit various oddities with the in-page-navigation. I'm thinking this happens because it only considers an item on...
On PaaS, we're currently seeing an issue where the links in the generated ToC contain incorrect anchors. For example if you go to the [PaaS docs](https://docs.cloud.service.gov.uk), and inspect the links...
The accessibility team recommended setting up automated testing for accessibility. alphagov/govuk-frontend uses [axe](https://axe-core.org/) but there are other options like [tenon](https://tenon.io/getcode.php) This would be useful for developing tech-docs-gem, but also for...
I was just playing around with your tech docs template (to check if this might be of interest for my private projects) and noticed the footer with the hardcoded license...
The interpretation of GOV.UK Elements typography styles may have been too literal. It states: ``` A 48px Bold heading A 36px Bold heading A 24px Bold heading A 19px Bold...
