Skip to content

Simplify required markup for Tabs

Sarah German requested to merge 1262-tabs-markdownlint into main

What does this MR do and why?

Adds a Nanoc filter to assist with creating Tabs components. This is useful because:

  • this removes need for HTML in markdown files (clearing up markdownlint warnings)
  • simplifies tab creation
  • enables easier linting (linting will come in a follow-up MR, see #1259 (closed))

Screenshots, screen recordings, or links to review app

No visual changes to the tabs themselves, but the way we create them in markdown changes:

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/gitlab-docs/-/blob/main/doc/setup.md.
  2. git checkout 1262-tabs-markdownlint
  3. Add some tabs on a markdown page, like this:
::Tabs

:::TabTitle Updog

Here's some content in tab one

:::TabTitle Tab Two

Here's some other content in tab 2

::EndTabs
  1. Recompile the site and view your page

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.

Edited by Sarah German

Merge request reports