Skip to content

docs: Render single-line code blocks

Mark Florian requested to merge 2102-work-around-one-line-code-blocks into main

What does this MR do?

docs: Render single-line code blocks

This is a workaround for #2102 (closed), whereby single-line code blocks render as one or more [object Object] instead of the actual syntax highlighted code block on initial page load.

Addresses #2102 (closed).

This is the Fish shell command I used to apply this change:

for md in src/**/*.md
    sed -zi 's|```html\n\([^\n]*\)\n```|<!-- Empty initial line is a workaround for https://gitlab.com/gitlab-org/gitlab-ui/-/issues/2102 -->\n```html\n\n\1\n```|g' $md
end

Screenshots

Before After
Screenshot_2023-03-29_at_17-31-44_utilities___friendly-wrap_-_Default___Storybook Screenshot_2023-03-29_at_17-31-37_utilities___friendly-wrap_-_Default___Storybook

Does this MR meet the acceptance criteria?

Conformity

  • Code review guidelines.
  • GitLab UI's contributing guidlines.
  • If it changes a Pajamas-compliant component's look & feel, the MR has been reviewed by a UX designer.
  • If it changes GitLab UI's documentation guidelines, the MR has been reviewed by a Technical Writer.
  • If the MR changes a component's API, integration MR(s) have been opened in the following projects to ensure that the @gitlab/ui package can be upgraded quickly after the changes are released:
  • Added the ~"component:*" label(s) if applicable.

Security

If this MR contains changes to processing or storing of credentials or tokens, authorization and authentication methods and other items described in the security review guidelines:

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • Security reports checked/validated by a reviewer from the AppSec team

Accessibility

If this MR adds or modifies a component, take a few moments to review the following:

  • All actions and functionality can be done with a keyboard.
  • Links, buttons, and controls have a visible focus state.
  • All content is presented in text or with a text equivalent. For example, alt text for SVG, or aria-label for icons that have meaning or perform actions.
  • Changes in a component’s state are announced by a screen reader. For example, changing aria-expanded="false" to aria-expanded="true" when an accordion is expanded.
  • Color combinations have sufficient contrast.
Edited by Mark Florian

Merge request reports