Skip to content

GitLab flavored markdown examples in docs to not render properly

If you visit the docs for GitLab Flavored Markdown (GFM) on docs.gitlab.com, the examples for several items to not actually render as they should. For instance, the Math markdown gives an example of:

This math is inline $`a^2+b^2=c^2`$.

This is on a separate line
```math
a^2+b^2=c^2
```

and then it attempts to show how it is rendered:

This math is inline a^2+b^2=c^2.

This is on a separate line

a^2+b^2=c^2

However, the example doesn't render on the docs.gitlab.com version of this document because that site does not include the KaTeX library like gitlab.com does. If you look at the same markdown file within the repo on gitlab.com it renders correctly. The same thing goes for the Mermaid examples.

Edited by Mike Greiling