diff options
Diffstat (limited to 'glfm_specification/output_spec/spec.html')
| -rw-r--r-- | glfm_specification/output_spec/spec.html | 191 |
1 files changed, 80 insertions, 111 deletions
diff --git a/glfm_specification/output_spec/spec.html b/glfm_specification/output_spec/spec.html index 2a4d03a3fdd..8149afe6124 100644 --- a/glfm_specification/output_spec/spec.html +++ b/glfm_specification/output_spec/spec.html @@ -242,89 +242,58 @@ <li><a href="#introduction">Introduction</a></li> <li> <a href="#gitlab-official-specification-markdown">GitLab Official Specification Markdown</a><ul> -<li><a href="#footnotes">Footnotes</a></li> <li><a href="#task-list-items">Task list items</a></li> <li><a href="#front-matter">Front matter</a></li> <li><a href="#table-of-contents">Table of contents</a></li> </ul> </li> </ul> -<h1 data-sourcepos="3:1-3:14" dir="auto"> +<hr data-sourcepos="3:1-3:3"> +<p data-sourcepos="4:1-6:3" dir="auto">title: GitLab Flavored Markdown (GLFM) Spec +version: alpha +...</p> +<h1 data-sourcepos="8:1-8:14" dir="auto"> <a id="user-content-introduction" class="anchor" href="#introduction" aria-hidden="true"></a>Introduction</h1> -<p data-sourcepos="5:1-5:84" dir="auto">TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section.</p> -<p data-sourcepos="7:1-10:75" dir="auto">NOTE: The example numbering in this document does not start at "1", because this official specification +<p data-sourcepos="10:1-10:284" dir="auto">GitLab Flavored Markdown (GLFM) extends the <a href="https://spec.commonmark.org/current/" rel="nofollow noreferrer noopener" target="_blank">CommonMark specification</a> and is considered a strict superset of CommonMark. It also incorporates the extensions defined by the <a href="https://github.github.com/gfm/" rel="nofollow noreferrer noopener" target="_blank">GitHub Flavored Markdown specification</a>.</p> +<p data-sourcepos="12:1-12:433" dir="auto">This specification will define the various official extensions that comprise GLFM. These extensions are GitLab independent - they do not require a GitLab server for parsing or interaction. The intent is to provide a specification that can be implemented in standard markdown editors. This includes many of the features listed in <a href="https://docs.gitlab.com/ee/user/markdown.html" rel="nofollow noreferrer noopener" target="_blank">user-facing documentation for GitLab Flavored Markdown</a>.</p> +<p data-sourcepos="14:1-14:69" dir="auto">The CommonMark and GitHub specifications will not be duplicated here.</p> +<p data-sourcepos="16:1-19:75" dir="auto">NOTE: The example numbering in this document does not start at "1", because this official specification only contains a subset of all the examples which are supported by GitLab Flavored Markdown. See <a href="https://gitlab.com/gitlab-org/gitlab/-/blob/master/glfm_specification/output_example_snapshots/snapshot_spec.html" rel="nofollow noreferrer noopener" target="_blank"><code>snapshot_spec.html</code></a> for a complete list of all examples, which are a superset of examples from:</p> -<ul data-sourcepos="12:1-16:0" dir="auto"> -<li data-sourcepos="12:1-12:12">CommonMark</li> -<li data-sourcepos="13:1-13:26">GitHub Flavored Markdown</li> -<li data-sourcepos="14:1-14:88">GitLab Flavored Markdown Official Specification (the same ones from this specifiation)</li> -<li data-sourcepos="15:1-16:0">GitLab Flavored Markdown Internal Extensions.</li> +<ul data-sourcepos="21:1-25:0" dir="auto"> +<li data-sourcepos="21:1-21:12">CommonMark</li> +<li data-sourcepos="22:1-22:26">GitHub Flavored Markdown</li> +<li data-sourcepos="23:1-23:88">GitLab Flavored Markdown Official Specification (the same ones from this specifiation)</li> +<li data-sourcepos="24:1-25:0">GitLab Flavored Markdown Internal Extensions.</li> </ul> <!-- BEGIN TESTS --> -<h1 data-sourcepos="18:1-18:40" dir="auto"> +<h1 data-sourcepos="27:1-27:40" dir="auto"> <a id="user-content-gitlab-official-specification-markdown" class="anchor" href="#gitlab-official-specification-markdown" aria-hidden="true"></a>GitLab Official Specification Markdown</h1> -<p data-sourcepos="20:1-23:104" dir="auto">Currently, only some of the GitLab-specific markdown features are -listed in this section. We may eventually add all -GitLab-specific features currently listed as supported in the +<p data-sourcepos="29:1-31:104" dir="auto">Note: This specification is a work in progress. Only some of the official GLFM extensions +are defined. We will continue to add any additional ones found in the <a href="https://docs.gitlab.com/ee/user/markdown.html" rel="nofollow noreferrer noopener" target="_blank">user-facing documentation for GitLab Flavored Markdown</a>.</p> -<p data-sourcepos="25:1-26:69" dir="auto">There is currently only this single top-level heading, but the +<p data-sourcepos="33:1-34:69" dir="auto">There is currently only this single top-level heading, but the examples may be split into multiple top-level headings in the future.</p> -<h2 data-sourcepos="28:1-28:12" dir="auto"> -<a id="user-content-footnotes" class="anchor" href="#footnotes" aria-hidden="true"></a>Footnotes</h2> -<p data-sourcepos="30:1-31:143" dir="auto">See -<a href="https://docs.gitlab.com/ee/user/markdown.html#footnotes" rel="nofollow noreferrer noopener" target="_blank">the footnotes section of the user-facing documentation for GitLab Flavored Markdown</a>.</p> -<div> -<div><a href="#example-674">Example 674</a></div> -<div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="36:1-40:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">footnote reference tag [^fortytwo]</span> -<span id="LC2" class="line" lang="plaintext"></span> -<span id="LC3" class="line" lang="plaintext">[^fortytwo]: footnote text</span></code></pre> -<copy-code></copy-code> -</div> -<div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="42:1-62:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p></span> -<span id="LC2" class="line" lang="plaintext">footnote reference tag</span> -<span id="LC3" class="line" lang="plaintext"><sup></span> -<span id="LC4" class="line" lang="plaintext"><a href="#fn-fortytwo-42" id="fnref-fortytwo-42" data-footnote-ref></span> -<span id="LC5" class="line" lang="plaintext">1</span> -<span id="LC6" class="line" lang="plaintext"></a></span> -<span id="LC7" class="line" lang="plaintext"></sup></span> -<span id="LC8" class="line" lang="plaintext"></p></span> -<span id="LC9" class="line" lang="plaintext"><section data-footnotes></span> -<span id="LC10" class="line" lang="plaintext"><ol></span> -<span id="LC11" class="line" lang="plaintext"><li id="fn-fortytwo-42"></span> -<span id="LC12" class="line" lang="plaintext"><p></span> -<span id="LC13" class="line" lang="plaintext">footnote text</span> -<span id="LC14" class="line" lang="plaintext"><a href="#fnref-fortytwo-42" data-footnote-backref></span> -<span id="LC15" class="line" lang="plaintext"></a></span> -<span id="LC16" class="line" lang="plaintext"></p></span> -<span id="LC17" class="line" lang="plaintext"></li></span> -<span id="LC18" class="line" lang="plaintext"></ol></span> -<span id="LC19" class="line" lang="plaintext"></section></span></code></pre> -<copy-code></copy-code> -</div> -</div> -<h2 data-sourcepos="65:1-65:18" dir="auto"> +<h2 data-sourcepos="36:1-36:18" dir="auto"> <a id="user-content-task-list-items" class="anchor" href="#task-list-items" aria-hidden="true"></a>Task list items</h2> -<p data-sourcepos="67:1-68:117" dir="auto">See +<p data-sourcepos="38:1-39:117" dir="auto">See <a href="https://docs.gitlab.com/ee/user/markdown.html#task-lists" rel="nofollow noreferrer noopener" target="_blank">Task lists</a> in the GitLab Flavored Markdown documentation.</p> -<p data-sourcepos="70:1-73:39" dir="auto">Task list items (checkboxes) are defined as a GitHub Flavored Markdown extension in a section above. +<p data-sourcepos="41:1-44:39" dir="auto">Task list items (checkboxes) are defined as a GitHub Flavored Markdown extension in a section above. GitLab extends the behavior of task list items to support additional features. Some of these features are in-progress, and should not yet be considered part of the official GitLab Flavored Markdown specification.</p> -<p data-sourcepos="75:1-75:85" dir="auto">Some of the behavior of task list items is implemented as client-side JavaScript/CSS.</p> -<p data-sourcepos="77:1-77:80" dir="auto">The following are some basic examples; more examples may be added in the future.</p> -<p data-sourcepos="79:1-79:16" dir="auto">Incomplete task:</p> +<p data-sourcepos="46:1-46:85" dir="auto">Some of the behavior of task list items is implemented as client-side JavaScript/CSS.</p> +<p data-sourcepos="48:1-48:80" dir="auto">The following are some basic examples; more examples may be added in the future.</p> +<p data-sourcepos="50:1-50:16" dir="auto">Incomplete task:</p> <div> -<div><a href="#example-675">Example 675</a></div> +<div><a href="#example-674">Example 674</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="84:1-86:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [ ] incomplete</span></code></pre> +<pre data-sourcepos="55:1-57:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [ ] incomplete</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="88:1-96:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> +<pre data-sourcepos="59:1-67:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> <span id="LC2" class="line" lang="plaintext"><li></span> <span id="LC3" class="line" lang="plaintext"><task-button/></span> <span id="LC4" class="line" lang="plaintext"><input type="checkbox" disabled/></span> @@ -334,15 +303,15 @@ GitLab Flavored Markdown specification.</p> <copy-code></copy-code> </div> </div> -<p data-sourcepos="99:1-99:15" dir="auto">Completed task:</p> +<p data-sourcepos="70:1-70:15" dir="auto">Completed task:</p> <div> -<div><a href="#example-676">Example 676</a></div> +<div><a href="#example-675">Example 675</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="104:1-106:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [x] completed</span></code></pre> +<pre data-sourcepos="75:1-77:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [x] completed</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="108:1-116:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> +<pre data-sourcepos="79:1-87:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> <span id="LC2" class="line" lang="plaintext"><li></span> <span id="LC3" class="line" lang="plaintext"><task-button/></span> <span id="LC4" class="line" lang="plaintext"><input type="checkbox" checked disabled/></span> @@ -352,15 +321,15 @@ GitLab Flavored Markdown specification.</p> <copy-code></copy-code> </div> </div> -<p data-sourcepos="119:1-119:18" dir="auto">Inapplicable task:</p> +<p data-sourcepos="90:1-90:18" dir="auto">Inapplicable task:</p> <div> -<div><a href="#example-677">Example 677</a></div> +<div><a href="#example-676">Example 676</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="124:1-126:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [~] inapplicable</span></code></pre> +<pre data-sourcepos="95:1-97:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [~] inapplicable</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="128:1-138:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> +<pre data-sourcepos="99:1-109:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> <span id="LC2" class="line" lang="plaintext"><li></span> <span id="LC3" class="line" lang="plaintext"><task-button/></span> <span id="LC4" class="line" lang="plaintext"><input type="checkbox" data-inapplicable disabled></span> @@ -372,18 +341,18 @@ GitLab Flavored Markdown specification.</p> <copy-code></copy-code> </div> </div> -<p data-sourcepos="141:1-142:50" dir="auto">Inapplicable task in a "loose" list. Note that the <code><del></code> tag is not applied to the +<p data-sourcepos="112:1-113:50" dir="auto">Inapplicable task in a "loose" list. Note that the <code><del></code> tag is not applied to the loose text; it has strikethrough applied with CSS.</p> <div> -<div><a href="#example-678">Example 678</a></div> +<div><a href="#example-677">Example 677</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="147:1-151:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [~] inapplicable</span> +<pre data-sourcepos="118:1-122:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">- [~] inapplicable</span> <span id="LC2" class="line" lang="plaintext"></span> <span id="LC3" class="line" lang="plaintext"> text in loose list</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="153:1-168:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> +<pre data-sourcepos="124:1-139:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><ul></span> <span id="LC2" class="line" lang="plaintext"><li></span> <span id="LC3" class="line" lang="plaintext"><p></span> <span id="LC4" class="line" lang="plaintext"><task-button/></span> @@ -400,23 +369,23 @@ loose text; it has strikethrough applied with CSS.</p> <copy-code></copy-code> </div> </div> -<h2 data-sourcepos="171:1-171:15" dir="auto"> +<h2 data-sourcepos="142:1-142:15" dir="auto"> <a id="user-content-front-matter" class="anchor" href="#front-matter" aria-hidden="true"></a>Front matter</h2> -<p data-sourcepos="173:1-174:121" dir="auto">See +<p data-sourcepos="144:1-145:121" dir="auto">See <a href="https://docs.gitlab.com/ee/user/markdown.html#front-matter" rel="nofollow noreferrer noopener" target="_blank">Front matter</a> in the GitLab Flavored Markdown documentation.</p> -<p data-sourcepos="176:1-177:95" dir="auto">Front matter is metadata included at the beginning of a Markdown document, preceding the content. +<p data-sourcepos="147:1-148:95" dir="auto">Front matter is metadata included at the beginning of a Markdown document, preceding the content. This data can be used by static site generators like Jekyll, Hugo, and many other applications.</p> -<p data-sourcepos="179:1-179:18" dir="auto">YAML front matter:</p> +<p data-sourcepos="150:1-150:18" dir="auto">YAML front matter:</p> <div> -<div><a href="#example-679">Example 679</a></div> +<div><a href="#example-678">Example 678</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="184:1-188:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">---</span> +<pre data-sourcepos="155:1-159:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">---</span> <span id="LC2" class="line" lang="plaintext">title: YAML front matter</span> <span id="LC3" class="line" lang="plaintext">---</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="190:1-196:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><pre></span> +<pre data-sourcepos="161:1-167:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><pre></span> <span id="LC2" class="line" lang="plaintext"><code></span> <span id="LC3" class="line" lang="plaintext">title: YAML front matter</span> <span id="LC4" class="line" lang="plaintext"></code></span> @@ -424,17 +393,17 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <copy-code></copy-code> </div> </div> -<p data-sourcepos="199:1-199:18" dir="auto">TOML front matter:</p> +<p data-sourcepos="170:1-170:18" dir="auto">TOML front matter:</p> <div> -<div><a href="#example-680">Example 680</a></div> +<div><a href="#example-679">Example 679</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="204:1-208:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">+++</span> +<pre data-sourcepos="175:1-179:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">+++</span> <span id="LC2" class="line" lang="plaintext">title: TOML front matter</span> <span id="LC3" class="line" lang="plaintext">+++</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="210:1-216:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><pre></span> +<pre data-sourcepos="181:1-187:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><pre></span> <span id="LC2" class="line" lang="plaintext"><code></span> <span id="LC3" class="line" lang="plaintext">title: TOML front matter</span> <span id="LC4" class="line" lang="plaintext"></code></span> @@ -442,11 +411,11 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <copy-code></copy-code> </div> </div> -<p data-sourcepos="219:1-219:18" dir="auto">JSON front matter:</p> +<p data-sourcepos="190:1-190:18" dir="auto">JSON front matter:</p> <div> -<div><a href="#example-681">Example 681</a></div> +<div><a href="#example-680">Example 680</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="224:1-230:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">;;;</span> +<pre data-sourcepos="195:1-201:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">;;;</span> <span id="LC2" class="line" lang="plaintext">{</span> <span id="LC3" class="line" lang="plaintext"> "title": "JSON front matter"</span> <span id="LC4" class="line" lang="plaintext">}</span> @@ -454,7 +423,7 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="232:1-240:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><pre></span> +<pre data-sourcepos="203:1-211:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><pre></span> <span id="LC2" class="line" lang="plaintext"><code></span> <span id="LC3" class="line" lang="plaintext">{</span> <span id="LC4" class="line" lang="plaintext"> "title": "JSON front matter"</span> @@ -464,11 +433,11 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <copy-code></copy-code> </div> </div> -<p data-sourcepos="243:1-243:66" dir="auto">Front matter blocks should be inserted at the top of the document:</p> +<p data-sourcepos="214:1-214:66" dir="auto">Front matter blocks should be inserted at the top of the document:</p> <div> -<div><a href="#example-682">Example 682</a></div> +<div><a href="#example-681">Example 681</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="248:1-254:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">text</span> +<pre data-sourcepos="219:1-225:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">text</span> <span id="LC2" class="line" lang="plaintext"></span> <span id="LC3" class="line" lang="plaintext">---</span> <span id="LC4" class="line" lang="plaintext">title: YAML front matter</span> @@ -476,43 +445,43 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="256:1-260:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p>text</p></span> +<pre data-sourcepos="227:1-231:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p>text</p></span> <span id="LC2" class="line" lang="plaintext"><hr></span> <span id="LC3" class="line" lang="plaintext"><h2>title: YAML front matter</h2></span></code></pre> <copy-code></copy-code> </div> </div> -<p data-sourcepos="263:1-263:74" dir="auto">Front matter block delimiters shouldn’t be preceded by space characters:</p> +<p data-sourcepos="234:1-234:74" dir="auto">Front matter block delimiters shouldn’t be preceded by space characters:</p> <div> -<div><a href="#example-683">Example 683</a></div> +<div><a href="#example-682">Example 682</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="268:1-272:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"> ---</span> +<pre data-sourcepos="239:1-243:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"> ---</span> <span id="LC2" class="line" lang="plaintext">title: YAML front matter</span> <span id="LC3" class="line" lang="plaintext">---</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="274:1-277:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><hr></span> +<pre data-sourcepos="245:1-248:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><hr></span> <span id="LC2" class="line" lang="plaintext"><h2>title: YAML front matter</h2></span></code></pre> <copy-code></copy-code> </div> </div> -<h2 data-sourcepos="280:1-280:20" dir="auto"> +<h2 data-sourcepos="251:1-251:20" dir="auto"> <a id="user-content-table-of-contents" class="anchor" href="#table-of-contents" aria-hidden="true"></a>Table of contents</h2> -<p data-sourcepos="282:1-284:46" dir="auto">See +<p data-sourcepos="253:1-255:46" dir="auto">See <a href="https://docs.gitlab.com/ee/user/markdown.html#table-of-contents" rel="nofollow noreferrer noopener" target="_blank">table of contents</a> in the GitLab Flavored Markdown documentation.</p> -<p data-sourcepos="286:1-290:23" dir="auto">NOTE: Because of this bug (<a href="https://gitlab.com/gitlab-org/gitlab/-/issues/359077" rel="nofollow noreferrer noopener" target="_blank">https://gitlab.com/gitlab-org/gitlab/-/issues/359077</a>), +<p data-sourcepos="257:1-261:23" dir="auto">NOTE: Because of this bug (<a href="https://gitlab.com/gitlab-org/gitlab/-/issues/359077" rel="nofollow noreferrer noopener" target="_blank">https://gitlab.com/gitlab-org/gitlab/-/issues/359077</a>), we cannot actually include the <code>TOC</code> tag with single brackets in backticks in this Markdown document, otherwise it would render a table of contents inline right here. So, it's been switched to <code>[</code> + <code>TOC</code> + <code>]</code> instead. This can be reverted once that bug is fixed.</p> -<p data-sourcepos="292:1-293:76" dir="auto">A table of contents is an unordered list that links to subheadings in the document. +<p data-sourcepos="263:1-264:76" dir="auto">A table of contents is an unordered list that links to subheadings in the document. Add either the <code>[[_TOC_]]</code> tag or the <code>[</code> + <code>TOC</code> + <code>]</code> tag on its own line.</p> <div> -<div><a href="#example-684">Example 684</a></div> +<div><a href="#example-683">Example 683</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="298:1-304:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">[TOC]</span> +<pre data-sourcepos="269:1-275:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">[TOC]</span> <span id="LC2" class="line" lang="plaintext"></span> <span id="LC3" class="line" lang="plaintext"># Heading 1</span> <span id="LC4" class="line" lang="plaintext"></span> @@ -520,7 +489,7 @@ Add either the <code>[[_TOC_]]</code> tag or the <code>[</code> + <code>TOC</cod <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="306:1-317:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><nav></span> +<pre data-sourcepos="277:1-288:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><nav></span> <span id="LC2" class="line" lang="plaintext"> <ul></span> <span id="LC3" class="line" lang="plaintext"> <li><a href="#heading-1">Heading 1</a></li></span> <span id="LC4" class="line" lang="plaintext"> <ul></span> @@ -534,9 +503,9 @@ Add either the <code>[[_TOC_]]</code> tag or the <code>[</code> + <code>TOC</cod </div> </div> <div> -<div><a href="#example-685">Example 685</a></div> +<div><a href="#example-684">Example 684</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="323:1-329:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">[[_TOC_]]</span> +<pre data-sourcepos="294:1-300:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">[[_TOC_]]</span> <span id="LC2" class="line" lang="plaintext"></span> <span id="LC3" class="line" lang="plaintext"># Heading 1</span> <span id="LC4" class="line" lang="plaintext"></span> @@ -544,7 +513,7 @@ Add either the <code>[[_TOC_]]</code> tag or the <code>[</code> + <code>TOC</cod <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="331:1-342:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><nav></span> +<pre data-sourcepos="302:1-313:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><nav></span> <span id="LC2" class="line" lang="plaintext"> <ul></span> <span id="LC3" class="line" lang="plaintext"> <li><a href="#heading-1">Heading 1</a></li></span> <span id="LC4" class="line" lang="plaintext"> <ul></span> @@ -557,12 +526,12 @@ Add either the <code>[[_TOC_]]</code> tag or the <code>[</code> + <code>TOC</cod <copy-code></copy-code> </div> </div> -<p data-sourcepos="345:1-346:5" dir="auto">A table of contents is a block element. It should preceded and followed by a blank +<p data-sourcepos="316:1-317:5" dir="auto">A table of contents is a block element. It should preceded and followed by a blank line.</p> <div> -<div><a href="#example-686">Example 686</a></div> +<div><a href="#example-685">Example 685</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="351:1-357:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">[[_TOC_]]</span> +<pre data-sourcepos="322:1-328:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext">[[_TOC_]]</span> <span id="LC2" class="line" lang="plaintext">text</span> <span id="LC3" class="line" lang="plaintext"></span> <span id="LC4" class="line" lang="plaintext">text</span> @@ -570,22 +539,22 @@ line.</p> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="359:1-362:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p>[[<em>TOC</em>]]text</p></span> +<pre data-sourcepos="330:1-333:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><p>[[<em>TOC</em>]]text</p></span> <span id="LC2" class="line" lang="plaintext"><p>text[TOC]</p></span></code></pre> <copy-code></copy-code> </div> </div> -<p data-sourcepos="365:1-365:60" dir="auto">A table of contents can be indented with up to three spaces.</p> +<p data-sourcepos="336:1-336:60" dir="auto">A table of contents can be indented with up to three spaces.</p> <div> -<div><a href="#example-687">Example 687</a></div> +<div><a href="#example-686">Example 686</a></div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="370:1-374:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"> [[_TOC_]]</span> +<pre data-sourcepos="341:1-345:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="example" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"> [[_TOC_]]</span> <span id="LC2" class="line" lang="plaintext"></span> <span id="LC3" class="line" lang="plaintext"># Heading 1</span></code></pre> <copy-code></copy-code> </div> <div class="gl-relative markdown-code-block js-markdown-code"> -<pre data-sourcepos="376:1-383:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><nav></span> +<pre data-sourcepos="347:1-354:32" lang="plaintext" class="code highlight js-syntax-highlight language-plaintext" data-canonical-lang="" v-pre="true"><code><span id="LC1" class="line" lang="plaintext"><nav></span> <span id="LC2" class="line" lang="plaintext"> <ul></span> <span id="LC3" class="line" lang="plaintext"> <li><a href="#heading-1">Heading 1</a></li></span> <span id="LC4" class="line" lang="plaintext"> </ul></span> |