diff options
Diffstat (limited to 'doc/user/markdown.md')
| -rw-r--r-- | doc/user/markdown.md | 44 |
1 files changed, 17 insertions, 27 deletions
diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 17b91eb9483..d29369f142c 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -343,6 +343,9 @@ backslash <code>\</code>. Otherwise the diff highlight does not render corre ### Math +> - LaTeX-compatible fencing [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21757) in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `markdown_dollar_math`. Disabled by default. Enabled on GitLab.com. +> - LaTeX-compatible fencing [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/371180) in GitLab 15.8. Feature flag `markdown_dollar_math` removed. + [View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#math). Math written in LaTeX syntax is rendered with [KaTeX](https://github.com/KaTeX/KaTeX). @@ -350,8 +353,10 @@ _KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX. This syntax also works for the Asciidoctor `:stem: latexmath`. For details, see the [Asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support). -Math written between dollar signs with backticks (``$`...`$``) is rendered -inline with the text. Math written in a [code block](#code-spans-and-blocks) with +Math written between dollar signs with backticks (``$`...`$``) or single dollar signs (`$...$`) +is rendered inline with the text. + +Math written between double dollar signs (`$$...$$`) or in a [code block](#code-spans-and-blocks) with the language declared as `math` is rendered on a separate line: ````markdown @@ -362,6 +367,14 @@ This math is on a separate line: ```math a^2+b^2=c^2 ``` + +This math is on a separate line: $$a^2+b^2=c^2$$ + +This math is on a separate line: + +$$ +a^2+b^2=c^2 +$$ ```` This math is inline: $`a^2+b^2=c^2`$. @@ -372,25 +385,6 @@ This math is on a separate line: a^2+b^2=c^2 ``` -#### LaTeX-compatible fencing - -> Introduced in GitLab 15.4 [with a flag](../administration/feature_flags.md) named `markdown_dollar_math`. Disabled by default. Enabled on GitLab.com. - -[View this topic in GitLab](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/user/markdown.md#latex-compatible-fencing). - -FLAG: -On self-managed GitLab, by default this feature is not available. To make it available per group, -ask an administrator to [enable the feature flag](../administration/feature_flags.md) named `markdown_dollar_math`. -On GitLab.com, this feature is available. -The feature is not ready for production use. - -Math written between dollar signs (`$...$`) is rendered -inline with the text. Math written between double dollar signs (`$$...$$`) is rendered -on a separate line: - -````markdown -This math is inline: $a^2+b^2=c^2$. - This math is on a separate line: $$a^2+b^2=c^2$$ This math is on a separate line: @@ -398,10 +392,6 @@ This math is on a separate line: $$ a^2+b^2=c^2 $$ -```` - -<!-- Uncomment the example below when the flag is enabled on GitLab.com --> -<!-- This math is inline: $a^2+b^2=c^2$. This math is on a separate line: $$a^2+b^2=c^2$$ @@ -409,7 +399,7 @@ This math is on a separate line: $$ a^2+b^2=c^2 -$$ --> +$$ ### Task lists @@ -1668,7 +1658,7 @@ Watch the following video walkthrough of this feature: See the video: <a href="https://www.youtube.com/watch?v=12yWKw1AdKY">Demo: JSON Tables in Markdown</a>. </div> <figure class="video-container"> - <iframe src="https://www.youtube.com/embed/12yWKw1AdKY" frameborder="0" allowfullscreen="true"> </iframe> + <iframe src="https://www.youtube-nocookie.com/embed/12yWKw1AdKY" frameborder="0" allowfullscreen> </iframe> </figure> The `items` attribute is a list of objects representing the data points. |