docs(homepage): convert Markdown list to plain HTML list #29369
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Context
Helps with #29148, but does not close it.
I recently added a Markdown list to the homepage wrapped in a
<details>
tag, that lists the companies and projects that use Renovate. The goal is for screenreader users to expand the<details>
element and then "have the screenreader read the list". With a proper list you can step through the list items, and go backwards and forwards in the list. Here's the PR that added this change:The changes from the PR above are now live on the published docs, and the
<details>
admonition expands into a long string:- Prisma - Netlify - Envoy - Condé Nast - Microsoft - Atlassian - Sourcegraph - Mozilla - Deloitte - Telus - Yarn - HashiCorp - Automattic - Algolia - eBay - Cypress - Red Hat - Financial Times - Uber - Buildkite
. It should be a proper list! 🫠Maybe this problem is caused by my Markdown formatting? Or maybe I should force the correct rendering with
<ul
> and<li
> HTML elements.I'll try plain HTML elements first, to see if MkDocs and Material for MkDocs can render this properly.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: