Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tech docs converts punctuation to HTML entities in IDs #183

Open
hannalaakso opened this issue Apr 16, 2020 · 0 comments
Open

Tech docs converts punctuation to HTML entities in IDs #183

hannalaakso opened this issue Apr 16, 2020 · 0 comments

Comments

@hannalaakso
Copy link
Member

hannalaakso commented Apr 16, 2020

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 mode'

results in the URL https://frontend.design-system.service.gov.uk/compatibility-mode/#39-compatibility-mode-39

and

## Find out which version you're using

becomes https://frontend.design-system.service.gov.uk/updating-with-npm/#find-out-which-version-you-39-re-using

Why fix this

The URLs end up looking pretty weird, this might or might not be an issue for users.

@hannalaakso hannalaakso transferred this issue from alphagov/govuk-frontend-docs Apr 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant