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

docs(homepage): convert Markdown list to plain HTML list #29369

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented May 31, 2024

Changes

  • Convert Markdown list to plain HTML list

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! 🫠

Renovate homepage, shows expanded admonition with badly formatted 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])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@viceice
Copy link
Member

viceice commented May 31, 2024

I'll try to check the root cause the next days. not enough time now. sorry.

@rarkins
Copy link
Collaborator

rarkins commented May 31, 2024

Shall we merge though?

@HonkingGoose
Copy link
Collaborator Author

HonkingGoose commented May 31, 2024

I think we're safe to merge, as plain HTML elements should work, fingers crossed.

If plain HTML elements still render badly, we'll have to dive deeper for sure.

I look forward to your analysis later @viceice! ❤️

For future reference, here's a known-broken commit on the Renovate docs site:

@rarkins rarkins added this pull request to the merge queue May 31, 2024
Merged via the queue into renovatebot:main with commit d8aad7a May 31, 2024
37 checks passed
@HonkingGoose HonkingGoose deleted the docs/homepage-convert-markdown-to-html-list branch May 31, 2024 19:46
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 37.383.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@HonkingGoose
Copy link
Collaborator Author

The plain HTML list works well on the published docs. 🥳

I guess we need to use a specific number of spaces, or tabs, or other formatting for a Markdown-based list to work. We likely will need to tell Prettier to stay away from the custom formatting in the collapsible admonition.

I'll let @viceice figure out the correct Markdown, or root cause for why it does not work in Markdown. 🙂

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants