Skip to content

Drop markdown formatting from tab titles

Sarah German requested to merge tabs-backtick-titles into main

What does this MR do and why?

When extra markdown formatting is added to tab titles, Hugo is printing the markdown tags with the tab name.

Hugo, like Nanoc, should just drop these.

Closes #111 (closed)

Screenshots, screen recordings, or links to review app

Before After
image image

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

  1. Configure a local GitLab Docs environment: https://gitlab.com/gitlab-org/technical-writing-group/gitlab-docs-hugo/-/blob/main/doc/setup.md.
  2. Visit a page where there are tabs with markdown in the tab titles, like this: http://localhost:1313/user/packages/maven_repository/#basic-http-authentication

Compare to the current dev site, where the bug is present: https://new.docs.gitlab.com/user/packages/maven_repository/#basic-http-authentication

Merge request acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Merge request reports