Add style guide caveat for syntax highlighting
What does this MR do?
In !161836 (merged), I got reminded of something I'd forgotten: the [
character, rendered inside inline HTML, like <kbd>[</kbd>
, breaks syntax highlighting even though the end result renders correctly. (thread)
In https://docs.gitlab.com/ee/user/project/repository/code_suggestions/supported_extensions.html#view-multiple-code-suggestions, here's what I found:
String | Syntax highlighting? |
Page display? |
---|---|---|
[ (without backticks) |
(broken) |
|
[ wrapped in backticks, inside <kbd> tags |
(backticks shown) |
|
[ (HTML entity [ without backticks) |
It makes sense: the syntax highlighter sees an unescaped [
character as the beginning of a link, and borks the highlighting until the end of the next link on the page, like this:
Let's save the next person from some sadness.
Related issues
Related to A few small edits and a keyboard fix (!161836 - merged) where I stumbled into this problem
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product availability details under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.