Skip to content

Disable MD048 around problematic code block

Amy Qualls requested to merge aqualls-test-markdown-workaround into master

What does this MR do?

None of the code fencing suggestions at https://docs.gitlab.com/ee/user/markdown.html#gitlab-flavored-markdown-glfm have worked for the code block shown in https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/index.html#glfm_canonical_examplestxt due to the large number of backticks it contains.

For more context on why this code block is strange, and the ways I've tried to get around it, read !98493 (comment 1112912208).

In this merge request, I'm trying out disabling rule MD048 (code-fence-style) for this one code block, so I can try using tildes as delimiters rather than backticks. Maybe it will even work!

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports