diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-17 09:10:33 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-17 09:10:33 +0300 |
commit | 7118851f0272b099335a34d8ca18a045aa5de51d (patch) | |
tree | 4ef50130a82a7b544936b9a298eb2c0e4968ec2e /glfm_specification | |
parent | b24742b7ed7add26a843d31207113610774fed4c (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'glfm_specification')
-rw-r--r-- | glfm_specification/example_snapshots/examples_index.yml | 48 | ||||
-rw-r--r-- | glfm_specification/example_snapshots/html.yml | 116 | ||||
-rw-r--r-- | glfm_specification/example_snapshots/markdown.yml | 64 | ||||
-rw-r--r-- | glfm_specification/example_snapshots/prosemirror_json.yml | 250 | ||||
-rw-r--r-- | glfm_specification/input/gitlab_flavored_markdown/glfm_example_metadata.yml | 12 | ||||
-rw-r--r-- | glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.yml | 16 | ||||
-rw-r--r-- | glfm_specification/input/gitlab_flavored_markdown/glfm_internal_extension_examples.md | 111 | ||||
-rw-r--r-- | glfm_specification/input/gitlab_flavored_markdown/glfm_official_specification_examples.md (renamed from glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt) | 114 | ||||
-rw-r--r-- | glfm_specification/output/spec.txt | 106 |
9 files changed, 402 insertions, 435 deletions
diff --git a/glfm_specification/example_snapshots/examples_index.yml b/glfm_specification/example_snapshots/examples_index.yml index fd3e350f58a..c0739912399 100644 --- a/glfm_specification/example_snapshots/examples_index.yml +++ b/glfm_specification/example_snapshots/examples_index.yml @@ -2012,75 +2012,75 @@ 06_15_00__inlines__textual_content__003: spec_txt_example_position: 673 source_specification: commonmark -07_01_00__gitlab_specific_markdown__footnotes__001: +07_01_00__gitlab_official_specification_markdown__footnotes__001: spec_txt_example_position: 674 source_specification: gitlab -07_02_00__gitlab_specific_markdown__task_list_items__001: +07_02_00__gitlab_official_specification_markdown__task_list_items__001: spec_txt_example_position: 675 source_specification: gitlab -07_02_00__gitlab_specific_markdown__task_list_items__002: +07_02_00__gitlab_official_specification_markdown__task_list_items__002: spec_txt_example_position: 676 source_specification: gitlab -07_02_00__gitlab_specific_markdown__task_list_items__003: +07_02_00__gitlab_official_specification_markdown__task_list_items__003: spec_txt_example_position: 677 source_specification: gitlab -07_02_00__gitlab_specific_markdown__task_list_items__004: +07_02_00__gitlab_official_specification_markdown__task_list_items__004: spec_txt_example_position: 678 source_specification: gitlab -07_03_00__gitlab_specific_markdown__front_matter__001: +07_03_00__gitlab_official_specification_markdown__front_matter__001: spec_txt_example_position: 679 source_specification: gitlab -07_03_00__gitlab_specific_markdown__front_matter__002: +07_03_00__gitlab_official_specification_markdown__front_matter__002: spec_txt_example_position: 680 source_specification: gitlab -07_03_00__gitlab_specific_markdown__front_matter__003: +07_03_00__gitlab_official_specification_markdown__front_matter__003: spec_txt_example_position: 681 source_specification: gitlab -07_03_00__gitlab_specific_markdown__front_matter__004: +07_03_00__gitlab_official_specification_markdown__front_matter__004: spec_txt_example_position: 682 source_specification: gitlab -07_03_00__gitlab_specific_markdown__front_matter__005: +07_03_00__gitlab_official_specification_markdown__front_matter__005: spec_txt_example_position: 683 source_specification: gitlab -07_04_00__gitlab_specific_markdown__audio__001: +07_04_00__gitlab_official_specification_markdown__table_of_contents__001: spec_txt_example_position: 684 source_specification: gitlab -07_04_00__gitlab_specific_markdown__audio__002: +07_04_00__gitlab_official_specification_markdown__table_of_contents__002: spec_txt_example_position: 685 source_specification: gitlab -07_05_00__gitlab_specific_markdown__video__001: +07_04_00__gitlab_official_specification_markdown__table_of_contents__003: spec_txt_example_position: 686 source_specification: gitlab -07_05_00__gitlab_specific_markdown__video__002: +07_04_00__gitlab_official_specification_markdown__table_of_contents__004: spec_txt_example_position: 687 source_specification: gitlab -07_06_00__gitlab_specific_markdown__table_of_contents__001: +08_01_00__gitlab_internal_extension_markdown__audio__001: spec_txt_example_position: 688 source_specification: gitlab -07_06_00__gitlab_specific_markdown__table_of_contents__002: +08_01_00__gitlab_internal_extension_markdown__audio__002: spec_txt_example_position: 689 source_specification: gitlab -07_06_00__gitlab_specific_markdown__table_of_contents__003: +08_02_00__gitlab_internal_extension_markdown__video__001: spec_txt_example_position: 690 source_specification: gitlab -07_06_00__gitlab_specific_markdown__table_of_contents__004: +08_02_00__gitlab_internal_extension_markdown__video__002: spec_txt_example_position: 691 source_specification: gitlab -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__001: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__001: spec_txt_example_position: 692 source_specification: gitlab -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__002: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__002: spec_txt_example_position: 693 source_specification: gitlab -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__003: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__003: spec_txt_example_position: 694 source_specification: gitlab -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__004: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__004: spec_txt_example_position: 695 source_specification: gitlab -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__005: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__005: spec_txt_example_position: 696 source_specification: gitlab -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__006: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__006: spec_txt_example_position: 697 source_specification: gitlab diff --git a/glfm_specification/example_snapshots/html.yml b/glfm_specification/example_snapshots/html.yml index e683c37a7ac..ef2ba39f925 100644 --- a/glfm_specification/example_snapshots/html.yml +++ b/glfm_specification/example_snapshots/html.yml @@ -7638,7 +7638,7 @@ <p data-sourcepos="1:1-1:19" dir="auto">Multiple spaces</p> wysiwyg: |- <p>Multiple spaces</p> -07_01_00__gitlab_specific_markdown__footnotes__001: +07_01_00__gitlab_official_specification_markdown__footnotes__001: canonical: | <p> footnote reference tag @@ -7671,7 +7671,7 @@ wysiwyg: |- <p>footnote reference tag <sup identifier="fortytwo">fortytwo</sup></p> <div node="footnoteDefinition(paragraph("footnote text"))" htmlattributes="[object Object]"><p>footnote text</p></div> -07_02_00__gitlab_specific_markdown__task_list_items__001: +07_02_00__gitlab_official_specification_markdown__task_list_items__001: canonical: | <ul> <li> @@ -7687,7 +7687,7 @@ </ul> wysiwyg: |- <ul start="1" parens="false" data-type="taskList"><li data-checked="false" data-type="taskItem"><label><input type="checkbox"><span></span></label><div><p>incomplete</p></div></li></ul> -07_02_00__gitlab_specific_markdown__task_list_items__002: +07_02_00__gitlab_official_specification_markdown__task_list_items__002: canonical: | <ul> <li> @@ -7703,7 +7703,7 @@ </ul> wysiwyg: |- <ul start="1" parens="false" data-type="taskList"><li data-checked="true" data-type="taskItem"><label><input type="checkbox" checked="checked"><span></span></label><div><p>completed</p></div></li></ul> -07_02_00__gitlab_specific_markdown__task_list_items__003: +07_02_00__gitlab_official_specification_markdown__task_list_items__003: canonical: | <ul> <li> @@ -7720,9 +7720,7 @@ <task-button></task-button><input type="checkbox" class="task-list-item-checkbox" data-inapplicable disabled> <s>inapplicable</s> </li> </ul> - wysiwyg: |- - <ul bullet="*"><li><p>[~] inapplicable</p></li></ul> -07_02_00__gitlab_specific_markdown__task_list_items__004: +07_02_00__gitlab_official_specification_markdown__task_list_items__004: canonical: | <ul> <li> @@ -7745,9 +7743,7 @@ <p data-sourcepos="3:3-3:20">text in loose list</p> </li> </ul> - wysiwyg: |- - Inapplicable task list items not yet implemented for WYSYWIG -07_03_00__gitlab_specific_markdown__front_matter__001: +07_03_00__gitlab_official_specification_markdown__front_matter__001: canonical: | <pre> <code> @@ -7761,7 +7757,7 @@ </div> wysiwyg: |- <pre language="yaml" class="content-editor-code-block undefined code highlight" isfrontmatter="true"><code>title: YAML front matter</code></pre> -07_03_00__gitlab_specific_markdown__front_matter__002: +07_03_00__gitlab_official_specification_markdown__front_matter__002: canonical: | <pre> <code> @@ -7775,7 +7771,7 @@ </div> wysiwyg: |- <pre language="toml" class="content-editor-code-block undefined code highlight" isfrontmatter="true"><code>title: TOML front matter</code></pre> -07_03_00__gitlab_specific_markdown__front_matter__003: +07_03_00__gitlab_official_specification_markdown__front_matter__003: canonical: | <pre> <code> @@ -7795,7 +7791,7 @@ <pre language="json" class="content-editor-code-block undefined code highlight" isfrontmatter="true"><code>{ "title": "JSON front matter" }</code></pre> -07_03_00__gitlab_specific_markdown__front_matter__004: +07_03_00__gitlab_official_specification_markdown__front_matter__004: canonical: | <p>text</p> <hr> @@ -7809,7 +7805,7 @@ <p>text</p> <hr> <h2>title: YAML front matter</h2> -07_03_00__gitlab_specific_markdown__front_matter__005: +07_03_00__gitlab_official_specification_markdown__front_matter__005: canonical: | <hr> <h2>title: YAML front matter</h2> @@ -7820,37 +7816,7 @@ wysiwyg: |- <hr> <h2>title: YAML front matter</h2> -07_04_00__gitlab_specific_markdown__audio__001: - canonical: | - <p><audio src="audio.oga" title="audio title"></audio></p> - static: |- - <p data-sourcepos="1:1-1:33" dir="auto"><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio title"></audio><a href="audio.oga" target="_blank" rel="noopener noreferrer" title="Download 'audio title'">audio title</a></span></p> - wysiwyg: |- - <p><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio"></audio><a href="audio.oga">audio</a></span></p> -07_04_00__gitlab_specific_markdown__audio__002: - canonical: | - <p><audio src="audio.oga" title="audio title"></audio></p> - static: |- - <p data-sourcepos="3:1-3:15" dir="auto"><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio title"></audio><a href="audio.oga" target="_blank" rel="noopener noreferrer" title="Download 'audio title'">audio title</a></span></p> - wysiwyg: |- - <pre>[audio]: audio.oga "audio title"</pre> - <p><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio"></audio><a href="audio.oga">audio</a></span></p> -07_05_00__gitlab_specific_markdown__video__001: - canonical: | - <p><video src="video.m4v" title="video title"></video></p> - static: |- - <p data-sourcepos="1:1-1:33" dir="auto"><span class="media-container video-container"><video src="video.m4v" controls="true" data-setup="{}" data-title="video title" width="400" preload="metadata"></video><a href="video.m4v" target="_blank" rel="noopener noreferrer" title="Download 'video title'">video title</a></span></p> - wysiwyg: |- - <p><span class="media-container video-container"><video src="video.m4v" controls="true" data-setup="{}" data-title="video"></video><a href="video.m4v">video</a></span></p> -07_05_00__gitlab_specific_markdown__video__002: - canonical: | - <p><video src="video.mov" title="video title"></video></p> - static: |- - <p data-sourcepos="3:1-3:15" dir="auto"><span class="media-container video-container"><video src="video.mov" controls="true" data-setup="{}" data-title="video title" width="400" preload="metadata"></video><a href="video.mov" target="_blank" rel="noopener noreferrer" title="Download 'video title'">video title</a></span></p> - wysiwyg: |- - <pre>[video]: video.mov "video title"</pre> - <p><span class="media-container video-container"><video src="video.mov" controls="true" data-setup="{}" data-title="video"></video><a href="video.mov">video</a></span></p> -07_06_00__gitlab_specific_markdown__table_of_contents__001: +07_04_00__gitlab_official_specification_markdown__table_of_contents__001: canonical: | <nav> <ul> @@ -7874,7 +7840,7 @@ <div class="table-of-contents gl-border-1 gl-border-solid gl-text-center gl-border-gray-100 gl-mb-5">Table of contents</div> <h1>Heading 1</h1> <h2>Heading 2</h2> -07_06_00__gitlab_specific_markdown__table_of_contents__002: +07_04_00__gitlab_official_specification_markdown__table_of_contents__002: canonical: | <nav> <ul> @@ -7898,7 +7864,7 @@ <div class="table-of-contents gl-border-1 gl-border-solid gl-text-center gl-border-gray-100 gl-mb-5">Table of contents</div> <h1>Heading 1</h1> <h2>Heading 2</h2> -07_06_00__gitlab_specific_markdown__table_of_contents__003: +07_04_00__gitlab_official_specification_markdown__table_of_contents__003: canonical: | <p>[[<em>TOC</em>]]text</p> <p>text[TOC]</p> @@ -7912,7 +7878,7 @@ text</p> <p>text [TOC]</p> -07_06_00__gitlab_specific_markdown__table_of_contents__004: +07_04_00__gitlab_official_specification_markdown__table_of_contents__004: canonical: | <nav> <ul> @@ -7927,45 +7893,63 @@ wysiwyg: |- <div class="table-of-contents gl-border-1 gl-border-solid gl-text-center gl-border-gray-100 gl-mb-5">Table of contents</div> <h1>Heading 1</h1> -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__001: +08_01_00__gitlab_internal_extension_markdown__audio__001: + canonical: | + <p><audio src="audio.oga" title="audio title"></audio></p> + static: |- + <p data-sourcepos="1:1-1:33" dir="auto"><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio title"></audio><a href="audio.oga" target="_blank" rel="noopener noreferrer" title="Download 'audio title'">audio title</a></span></p> + wysiwyg: |- + <p><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio"></audio><a href="audio.oga">audio</a></span></p> +08_01_00__gitlab_internal_extension_markdown__audio__002: + canonical: | + <p><audio src="audio.oga" title="audio title"></audio></p> + static: |- + <p data-sourcepos="3:1-3:15" dir="auto"><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio title"></audio><a href="audio.oga" target="_blank" rel="noopener noreferrer" title="Download 'audio title'">audio title</a></span></p> + wysiwyg: |- + <pre>[audio]: audio.oga "audio title"</pre> + <p><span class="media-container audio-container"><audio src="audio.oga" controls="true" data-setup="{}" data-title="audio"></audio><a href="audio.oga">audio</a></span></p> +08_02_00__gitlab_internal_extension_markdown__video__001: + canonical: | + <p><video src="video.m4v" title="video title"></video></p> + static: |- + <p data-sourcepos="1:1-1:33" dir="auto"><span class="media-container video-container"><video src="video.m4v" controls="true" data-setup="{}" data-title="video title" width="400" preload="metadata"></video><a href="video.m4v" target="_blank" rel="noopener noreferrer" title="Download 'video title'">video title</a></span></p> + wysiwyg: |- + <p><span class="media-container video-container"><video src="video.m4v" controls="true" data-setup="{}" data-title="video"></video><a href="video.m4v">video</a></span></p> +08_02_00__gitlab_internal_extension_markdown__video__002: + canonical: | + <p><video src="video.mov" title="video title"></video></p> + static: |- + <p data-sourcepos="3:1-3:15" dir="auto"><span class="media-container video-container"><video src="video.mov" controls="true" data-setup="{}" data-title="video title" width="400" preload="metadata"></video><a href="video.mov" target="_blank" rel="noopener noreferrer" title="Download 'video title'">video title</a></span></p> + wysiwyg: |- + <pre>[video]: video.mov "video title"</pre> + <p><span class="media-container video-container"><video src="video.mov" controls="true" data-setup="{}" data-title="video"></video><a href="video.mov">video</a></span></p> +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__001: canonical: | <p><a href="groups-test-file">groups-test-file</a></p> static: |- <p data-sourcepos="1:1-1:45" dir="auto"><a href="/groups/glfm_group/-/uploads/groups-test-file" data-canonical-src="/uploads/groups-test-file" data-link="true" class="gfm">groups-test-file</a></p> - wysiwyg: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__002: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__002: canonical: | <p><a href="projects-test-file">projects-test-file</a></p> static: |- <p data-sourcepos="1:1-1:40" dir="auto"><a href="/glfm_group/glfm_project/-/blob/master/projects-test-file">projects-test-file</a></p> - wysiwyg: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__003: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__003: canonical: | <p>This project snippet ID reference IS filtered: $88888</p> static: |- <p data-sourcepos="1:1-1:53" dir="auto">This project snippet ID reference IS filtered: <a href="/glfm_group/glfm_project/-/snippets/88888" data-reference-type="snippet" data-original="$88888" data-link="false" data-link-reference="false" data-project="77777" data-snippet="88888" data-container="body" data-placement="top" title="glfm_project_snippet" class="gfm gfm-snippet has-tooltip">$88888</a></p> - wysiwyg: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__004: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__004: canonical: | <p>This personal snippet ID reference is not filtered: $99999</p> static: |- <p data-sourcepos="1:1-1:58" dir="auto">This personal snippet ID reference is not filtered: $99999</p> - wysiwyg: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__005: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__005: canonical: | <p><a href="project-wikis-test-file">project-wikis-test-file</a></p> static: |- <p data-sourcepos="1:1-1:50" dir="auto"><a href="/glfm_group/glfm_project/-/wikis/project-wikis-test-file" data-canonical-src="project-wikis-test-file">project-wikis-test-file</a></p> - wysiwyg: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__006: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__006: canonical: | <p><a href="group-wikis-test-file">group-wikis-test-file</a></p> static: |- <p data-sourcepos="1:1-1:46" dir="auto"><a href="/groups/glfm_group/-/wikis/group-wikis-test-file" data-canonical-src="group-wikis-test-file">group-wikis-test-file</a></p> - wysiwyg: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 diff --git a/glfm_specification/example_snapshots/markdown.yml b/glfm_specification/example_snapshots/markdown.yml index 9af824e120f..867108a6cc5 100644 --- a/glfm_specification/example_snapshots/markdown.yml +++ b/glfm_specification/example_snapshots/markdown.yml @@ -2189,87 +2189,87 @@ Foo χρῆν 06_15_00__inlines__textual_content__003: | Multiple spaces -07_01_00__gitlab_specific_markdown__footnotes__001: | +07_01_00__gitlab_official_specification_markdown__footnotes__001: | footnote reference tag [^fortytwo] [^fortytwo]: footnote text -07_02_00__gitlab_specific_markdown__task_list_items__001: | +07_02_00__gitlab_official_specification_markdown__task_list_items__001: | - [ ] incomplete -07_02_00__gitlab_specific_markdown__task_list_items__002: | +07_02_00__gitlab_official_specification_markdown__task_list_items__002: | - [x] completed -07_02_00__gitlab_specific_markdown__task_list_items__003: | +07_02_00__gitlab_official_specification_markdown__task_list_items__003: | - [~] inapplicable -07_02_00__gitlab_specific_markdown__task_list_items__004: | +07_02_00__gitlab_official_specification_markdown__task_list_items__004: | - [~] inapplicable text in loose list -07_03_00__gitlab_specific_markdown__front_matter__001: | +07_03_00__gitlab_official_specification_markdown__front_matter__001: | --- title: YAML front matter --- -07_03_00__gitlab_specific_markdown__front_matter__002: | +07_03_00__gitlab_official_specification_markdown__front_matter__002: | +++ title: TOML front matter +++ -07_03_00__gitlab_specific_markdown__front_matter__003: | +07_03_00__gitlab_official_specification_markdown__front_matter__003: | ;;; { "title": "JSON front matter" } ;;; -07_03_00__gitlab_specific_markdown__front_matter__004: | +07_03_00__gitlab_official_specification_markdown__front_matter__004: | text --- title: YAML front matter --- -07_03_00__gitlab_specific_markdown__front_matter__005: |2 +07_03_00__gitlab_official_specification_markdown__front_matter__005: |2 --- title: YAML front matter --- -07_04_00__gitlab_specific_markdown__audio__001: | - ![audio](audio.oga "audio title") -07_04_00__gitlab_specific_markdown__audio__002: | - [audio]: audio.oga "audio title" - - ![audio][audio] -07_05_00__gitlab_specific_markdown__video__001: | - ![video](video.m4v "video title") -07_05_00__gitlab_specific_markdown__video__002: | - [video]: video.mov "video title" - - ![video][video] -07_06_00__gitlab_specific_markdown__table_of_contents__001: | +07_04_00__gitlab_official_specification_markdown__table_of_contents__001: | [TOC] # Heading 1 ## Heading 2 -07_06_00__gitlab_specific_markdown__table_of_contents__002: | +07_04_00__gitlab_official_specification_markdown__table_of_contents__002: | [[_TOC_]] # Heading 1 ## Heading 2 -07_06_00__gitlab_specific_markdown__table_of_contents__003: | +07_04_00__gitlab_official_specification_markdown__table_of_contents__003: | [[_TOC_]] text text [TOC] -07_06_00__gitlab_specific_markdown__table_of_contents__004: |2 +07_04_00__gitlab_official_specification_markdown__table_of_contents__004: |2 [[_TOC_]] # Heading 1 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__001: | +08_01_00__gitlab_internal_extension_markdown__audio__001: | + ![audio](audio.oga "audio title") +08_01_00__gitlab_internal_extension_markdown__audio__002: | + [audio]: audio.oga "audio title" + + ![audio][audio] +08_02_00__gitlab_internal_extension_markdown__video__001: | + ![video](video.m4v "video title") +08_02_00__gitlab_internal_extension_markdown__video__002: | + [video]: video.mov "video title" + + ![video][video] +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__001: | [groups-test-file](/uploads/groups-test-file) -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__002: | +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__002: | [projects-test-file](projects-test-file) -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__003: | +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__003: | This project snippet ID reference IS filtered: $88888 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__004: | +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__004: | This personal snippet ID reference is not filtered: $99999 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__005: | +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__005: | [project-wikis-test-file](project-wikis-test-file) -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__006: | +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__006: | [group-wikis-test-file](group-wikis-test-file) diff --git a/glfm_specification/example_snapshots/prosemirror_json.yml b/glfm_specification/example_snapshots/prosemirror_json.yml index 1051b5ccdd7..de54518a574 100644 --- a/glfm_specification/example_snapshots/prosemirror_json.yml +++ b/glfm_specification/example_snapshots/prosemirror_json.yml @@ -20561,7 +20561,7 @@ } ] } -07_01_00__gitlab_specific_markdown__footnotes__001: |- +07_01_00__gitlab_official_specification_markdown__footnotes__001: |- { "type": "doc", "content": [ @@ -20601,7 +20601,7 @@ } ] } -07_02_00__gitlab_specific_markdown__task_list_items__001: |- +07_02_00__gitlab_official_specification_markdown__task_list_items__001: |- { "type": "doc", "content": [ @@ -20634,7 +20634,7 @@ } ] } -07_02_00__gitlab_specific_markdown__task_list_items__002: |- +07_02_00__gitlab_official_specification_markdown__task_list_items__002: |- { "type": "doc", "content": [ @@ -20667,11 +20667,7 @@ } ] } -07_02_00__gitlab_specific_markdown__task_list_items__003: |- - Inapplicable task list items not yet implemented for WYSYWIG -07_02_00__gitlab_specific_markdown__task_list_items__004: |- - Inapplicable task list items not yet implemented for WYSYWIG -07_03_00__gitlab_specific_markdown__front_matter__001: |- +07_03_00__gitlab_official_specification_markdown__front_matter__001: |- { "type": "doc", "content": [ @@ -20691,7 +20687,7 @@ } ] } -07_03_00__gitlab_specific_markdown__front_matter__002: |- +07_03_00__gitlab_official_specification_markdown__front_matter__002: |- { "type": "doc", "content": [ @@ -20711,7 +20707,7 @@ } ] } -07_03_00__gitlab_specific_markdown__front_matter__003: |- +07_03_00__gitlab_official_specification_markdown__front_matter__003: |- { "type": "doc", "content": [ @@ -20731,7 +20727,7 @@ } ] } -07_03_00__gitlab_specific_markdown__front_matter__004: |- +07_03_00__gitlab_official_specification_markdown__front_matter__004: |- { "type": "doc", "content": [ @@ -20761,7 +20757,7 @@ } ] } -07_03_00__gitlab_specific_markdown__front_matter__005: |- +07_03_00__gitlab_official_specification_markdown__front_matter__005: |- { "type": "doc", "content": [ @@ -20782,61 +20778,73 @@ } ] } -07_04_00__gitlab_specific_markdown__audio__001: |- +07_04_00__gitlab_official_specification_markdown__table_of_contents__001: |- { "type": "doc", "content": [ { - "type": "paragraph", + "type": "tableOfContents" + }, + { + "type": "heading", + "attrs": { + "level": 1 + }, "content": [ { - "type": "audio", - "attrs": { - "uploading": false, - "src": "audio.oga", - "canonicalSrc": "audio.oga", - "alt": "audio" - } + "type": "text", + "text": "Heading 1" + } + ] + }, + { + "type": "heading", + "attrs": { + "level": 2 + }, + "content": [ + { + "type": "text", + "text": "Heading 2" } ] } ] } -07_04_00__gitlab_specific_markdown__audio__002: |- +07_04_00__gitlab_official_specification_markdown__table_of_contents__002: |- { "type": "doc", "content": [ { - "type": "referenceDefinition", + "type": "tableOfContents" + }, + { + "type": "heading", "attrs": { - "identifier": "audio", - "url": "audio.oga", - "title": "audio title" + "level": 1 }, "content": [ { "type": "text", - "text": "[audio]: audio.oga \"audio title\"" + "text": "Heading 1" } ] }, { - "type": "paragraph", + "type": "heading", + "attrs": { + "level": 2 + }, "content": [ { - "type": "audio", - "attrs": { - "uploading": false, - "src": "audio.oga", - "canonicalSrc": "audio", - "alt": "audio" - } + "type": "text", + "text": "Heading 2" } ] } ] } -07_05_00__gitlab_specific_markdown__video__001: |- +07_04_00__gitlab_official_specification_markdown__table_of_contents__003: |- { "type": "doc", "content": [ @@ -20844,33 +20852,21 @@ "type": "paragraph", "content": [ { - "type": "video", - "attrs": { - "uploading": false, - "src": "video.m4v", - "canonicalSrc": "video.m4v", - "alt": "video" - } - } - ] - } - ] - } -07_05_00__gitlab_specific_markdown__video__002: |- - { - "type": "doc", - "content": [ - { - "type": "referenceDefinition", - "attrs": { - "identifier": "video", - "url": "video.mov", - "title": "video title" - }, - "content": [ + "type": "text", + "text": "[[" + }, { "type": "text", - "text": "[video]: video.mov \"video title\"" + "marks": [ + { + "type": "italic" + } + ], + "text": "TOC" + }, + { + "type": "text", + "text": "]]\ntext" } ] }, @@ -20878,19 +20874,14 @@ "type": "paragraph", "content": [ { - "type": "video", - "attrs": { - "uploading": false, - "src": "video.mov", - "canonicalSrc": "video", - "alt": "video" - } + "type": "text", + "text": "text\n[TOC]" } ] } ] } -07_06_00__gitlab_specific_markdown__table_of_contents__001: |- +07_04_00__gitlab_official_specification_markdown__table_of_contents__004: |- { "type": "doc", "content": [ @@ -20908,55 +20899,64 @@ "text": "Heading 1" } ] - }, + } + ] + } +08_01_00__gitlab_internal_extension_markdown__audio__001: |- + { + "type": "doc", + "content": [ { - "type": "heading", - "attrs": { - "level": 2 - }, + "type": "paragraph", "content": [ { - "type": "text", - "text": "Heading 2" + "type": "audio", + "attrs": { + "uploading": false, + "src": "audio.oga", + "canonicalSrc": "audio.oga", + "alt": "audio" + } } ] } ] } -07_06_00__gitlab_specific_markdown__table_of_contents__002: |- +08_01_00__gitlab_internal_extension_markdown__audio__002: |- { "type": "doc", "content": [ { - "type": "tableOfContents" - }, - { - "type": "heading", + "type": "referenceDefinition", "attrs": { - "level": 1 + "identifier": "audio", + "url": "audio.oga", + "title": "audio title" }, "content": [ { "type": "text", - "text": "Heading 1" + "text": "[audio]: audio.oga \"audio title\"" } ] }, { - "type": "heading", - "attrs": { - "level": 2 - }, + "type": "paragraph", "content": [ { - "type": "text", - "text": "Heading 2" + "type": "audio", + "attrs": { + "uploading": false, + "src": "audio.oga", + "canonicalSrc": "audio", + "alt": "audio" + } } ] } ] } -07_06_00__gitlab_specific_markdown__table_of_contents__003: |- +08_02_00__gitlab_internal_extension_markdown__video__001: |- { "type": "doc", "content": [ @@ -20964,65 +20964,49 @@ "type": "paragraph", "content": [ { - "type": "text", - "text": "[[" - }, - { - "type": "text", - "marks": [ - { - "type": "italic" - } - ], - "text": "TOC" - }, - { - "type": "text", - "text": "]]\ntext" - } - ] - }, - { - "type": "paragraph", - "content": [ - { - "type": "text", - "text": "text\n[TOC]" + "type": "video", + "attrs": { + "uploading": false, + "src": "video.m4v", + "canonicalSrc": "video.m4v", + "alt": "video" + } } ] } ] } -07_06_00__gitlab_specific_markdown__table_of_contents__004: |- +08_02_00__gitlab_internal_extension_markdown__video__002: |- { "type": "doc", "content": [ { - "type": "tableOfContents" - }, - { - "type": "heading", + "type": "referenceDefinition", "attrs": { - "level": 1 + "identifier": "video", + "url": "video.mov", + "title": "video title" }, "content": [ { "type": "text", - "text": "Heading 1" + "text": "[video]: video.mov \"video title\"" + } + ] + }, + { + "type": "paragraph", + "content": [ + { + "type": "video", + "attrs": { + "uploading": false, + "src": "video.mov", + "canonicalSrc": "video", + "alt": "video" + } } ] } ] } -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__001: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__002: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__003: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__004: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__005: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__006: |- - Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 diff --git a/glfm_specification/input/gitlab_flavored_markdown/glfm_example_metadata.yml b/glfm_specification/input/gitlab_flavored_markdown/glfm_example_metadata.yml index 3c043f5fba1..7fc1f9d9be0 100644 --- a/glfm_specification/input/gitlab_flavored_markdown/glfm_example_metadata.yml +++ b/glfm_specification/input/gitlab_flavored_markdown/glfm_example_metadata.yml @@ -1,14 +1,14 @@ --- -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__001: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__001: api_request_override_path: /groups/glfm_group/preview_markdown -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__002: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__002: api_request_override_path: /glfm_group/glfm_project/preview_markdown -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__003: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__003: api_request_override_path: /glfm_group/glfm_project/preview_markdown -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__004: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__004: api_request_override_path: /-/snippets/preview_markdown -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__005: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__005: api_request_override_path: /glfm_group/glfm_project/-/wikis/new_page/preview_markdown -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__006: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__006: ee: true api_request_override_path: /groups/glfm_group/-/wikis/new_page/preview_markdown diff --git a/glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.yml b/glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.yml index a74c3492324..a0ce7f44a3c 100644 --- a/glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.yml +++ b/glfm_specification/input/gitlab_flavored_markdown/glfm_example_status.yml @@ -12,49 +12,49 @@ skip_running_snapshot_static_html_tests: false # NOT YET SUPPORTED skip_running_snapshot_wysiwyg_html_tests: false skip_running_snapshot_prosemirror_json_tests: false -07_02_00__gitlab_specific_markdown__task_list_items__003: +07_02_00__gitlab_official_specification_markdown__task_list_items__003: skip_update_example_snapshot_html_wysiwyg: Inapplicable task list items not yet implemented for WYSYWIG skip_update_example_snapshot_prosemirror_json: Inapplicable task list items not yet implemented for WYSYWIG skip_running_conformance_wysiwyg_tests: Inapplicable task list items not yet implemented for WYSYWIG skip_running_snapshot_wysiwyg_html_tests: Inapplicable task list items not yet implemented for WYSYWIG skip_running_snapshot_prosemirror_json_tests: Inapplicable task list items not yet implemented for WYSYWIG -07_02_00__gitlab_specific_markdown__task_list_items__004: +07_02_00__gitlab_official_specification_markdown__task_list_items__004: skip_update_example_snapshot_html_wysiwyg: Inapplicable task list items not yet implemented for WYSYWIG skip_update_example_snapshot_prosemirror_json: Inapplicable task list items not yet implemented for WYSYWIG skip_running_conformance_wysiwyg_tests: Inapplicable task list items not yet implemented for WYSYWIG skip_running_snapshot_wysiwyg_html_tests: Inapplicable task list items not yet implemented for WYSYWIG skip_running_snapshot_prosemirror_json_tests: Inapplicable task list items not yet implemented for WYSYWIG -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__001: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__001: skip_update_example_snapshot_html_wysiwyg: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_update_example_snapshot_prosemirror_json: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_conformance_wysiwyg_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_wysiwyg_html_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_prosemirror_json_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__002: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__002: skip_update_example_snapshot_html_wysiwyg: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_update_example_snapshot_prosemirror_json: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_conformance_wysiwyg_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_wysiwyg_html_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_prosemirror_json_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__003: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__003: skip_update_example_snapshot_html_wysiwyg: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_update_example_snapshot_prosemirror_json: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_conformance_wysiwyg_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_wysiwyg_html_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_prosemirror_json_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__004: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__004: skip_update_example_snapshot_html_wysiwyg: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_update_example_snapshot_prosemirror_json: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_conformance_wysiwyg_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_wysiwyg_html_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_prosemirror_json_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__005: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__005: skip_update_example_snapshot_html_wysiwyg: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_update_example_snapshot_prosemirror_json: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_conformance_wysiwyg_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_wysiwyg_html_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_snapshot_prosemirror_json_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 -08_01_00__examples_using_internal_extensions__markdown_preview_api_request_overrides__006: +08_03_00__gitlab_internal_extension_markdown__markdown_preview_api_request_overrides__006: skip_update_example_snapshot_html_wysiwyg: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_update_example_snapshot_prosemirror_json: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 skip_running_conformance_wysiwyg_tests: Not yet implemented. See https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92507#note_1068159236 diff --git a/glfm_specification/input/gitlab_flavored_markdown/glfm_internal_extension_examples.md b/glfm_specification/input/gitlab_flavored_markdown/glfm_internal_extension_examples.md new file mode 100644 index 00000000000..171a8e430d3 --- /dev/null +++ b/glfm_specification/input/gitlab_flavored_markdown/glfm_internal_extension_examples.md @@ -0,0 +1,111 @@ +# GitLab Internal Extension Markdown + +## Audio + +See +[audio](https://docs.gitlab.com/ee/user/markdown.html#audio) in the GitLab Flavored Markdown documentation. + +GLFM renders image elements as an audio player as long as the resource’s file extension is +one of the following supported audio extensions `.mp3`, `.oga`, `.ogg`, `.spx`, and `.wav`. +Audio ignore the alternative text part of an image declaration. + +```````````````````````````````` example gitlab +![audio](audio.oga "audio title") +. +<p><audio src="audio.oga" title="audio title"></audio></p> +```````````````````````````````` + +Reference definitions work audio as well: + +```````````````````````````````` example gitlab +[audio]: audio.oga "audio title" + +![audio][audio] +. +<p><audio src="audio.oga" title="audio title"></audio></p> +```````````````````````````````` + +## Video + +See +[videos](https://docs.gitlab.com/ee/user/markdown.html#videos) in the GitLab Flavored Markdown documentation. + +GLFM renders image elements as a video player as long as the resource’s file extension is +one of the following supported video extensions `.mp4`, `.m4v`, `.mov`, `.webm`, and `.ogv`. +Videos ignore the alternative text part of an image declaration. + + +```````````````````````````````` example gitlab +![video](video.m4v "video title") +. +<p><video src="video.m4v" title="video title"></video></p> +```````````````````````````````` + +Reference definitions work video as well: + +```````````````````````````````` example gitlab +[video]: video.mov "video title" + +![video][video] +. +<p><video src="video.mov" title="video title"></video></p> +```````````````````````````````` + +## Markdown Preview API Request Overrides + +This section contains examples of all controllers which use `PreviewMarkdown` module +and use different `markdown_context_params`. They exercise the various `preview_markdown` +endpoints via `glfm_example_metadata.yml`. + + +`preview_markdown` exercising `groups` API endpoint and `UploadLinkFilter`: + +```````````````````````````````` example gitlab +[groups-test-file](/uploads/groups-test-file) +. +<p><a href="groups-test-file">groups-test-file</a></p> +```````````````````````````````` + +`preview_markdown` exercising `projects` API endpoint and `RepositoryLinkFilter`: + +```````````````````````````````` example gitlab +[projects-test-file](projects-test-file) +. +<p><a href="projects-test-file">projects-test-file</a></p> +```````````````````````````````` + +`preview_markdown` exercising `projects` API endpoint and `SnippetReferenceFilter`: + +```````````````````````````````` example gitlab +This project snippet ID reference IS filtered: $88888 +. +<p>This project snippet ID reference IS filtered: $88888</p> +```````````````````````````````` + +`preview_markdown` exercising personal (non-project) `snippets` API endpoint. This is +only used by the comment field on personal snippets. It has no unique custom markdown +extension behavior, and specifically does not render snippet references via +`SnippetReferenceFilter`, even if the ID is valid. + +```````````````````````````````` example gitlab +This personal snippet ID reference is not filtered: $99999 +. +<p>This personal snippet ID reference is not filtered: $99999</p> +```````````````````````````````` + +`preview_markdown` exercising project `wikis` API endpoint and `WikiLinkFilter`: + +```````````````````````````````` example gitlab +[project-wikis-test-file](project-wikis-test-file) +. +<p><a href="project-wikis-test-file">project-wikis-test-file</a></p> +```````````````````````````````` + +`preview_markdown` exercising group `wikis` API endpoint and `WikiLinkFilter`. This example +also requires an EE license enabling the `group_wikis` feature: + +```````````````````````````````` example gitlab +[group-wikis-test-file](group-wikis-test-file) +. +<p><a href="group-wikis-test-file">group-wikis-test-file</a></p> +```````````````````````````````` diff --git a/glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt b/glfm_specification/input/gitlab_flavored_markdown/glfm_official_specification_examples.md index 10a46dcca6b..f2b62b1a4ac 100644 --- a/glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt +++ b/glfm_specification/input/gitlab_flavored_markdown/glfm_official_specification_examples.md @@ -1,4 +1,4 @@ -# GitLab-Specific Markdown +# GitLab Official Specification Markdown Currently, only some of the GitLab-specific markdown features are listed in this section. We will eventually add all @@ -200,57 +200,6 @@ title: YAML front matter <h2>title: YAML front matter</h2> ```````````````````````````````` -## Audio - -See -[audio](https://docs.gitlab.com/ee/user/markdown.html#audio) in the GitLab Flavored Markdown documentation. - -GLFM renders image elements as an audio player as long as the resource’s file extension is -one of the following supported audio extensions `.mp3`, `.oga`, `.ogg`, `.spx`, and `.wav`. -Audio ignore the alternative text part of an image declaration. - -```````````````````````````````` example gitlab -![audio](audio.oga "audio title") -. -<p><audio src="audio.oga" title="audio title"></audio></p> -```````````````````````````````` - -Reference definitions work audio as well: - -```````````````````````````````` example gitlab -[audio]: audio.oga "audio title" - -![audio][audio] -. -<p><audio src="audio.oga" title="audio title"></audio></p> -```````````````````````````````` - -## Video - -See -[videos](https://docs.gitlab.com/ee/user/markdown.html#videos) in the GitLab Flavored Markdown documentation. - -GLFM renders image elements as a video player as long as the resource’s file extension is -one of the following supported video extensions `.mp4`, `.m4v`, `.mov`, `.webm`, and `.ogv`. -Videos ignore the alternative text part of an image declaration. - - -```````````````````````````````` example gitlab -![video](video.m4v "video title") -. -<p><video src="video.m4v" title="video title"></video></p> -```````````````````````````````` - -Reference definitions work video as well: - -```````````````````````````````` example gitlab -[video]: video.mov "video title" - -![video][video] -. -<p><video src="video.mov" title="video title"></video></p> -```````````````````````````````` - ## Table of contents See @@ -326,64 +275,3 @@ A table of contents can be indented with up to three spaces. </nav> <h1>Heading 1</h1> ```````````````````````````````` - -# Examples Using Internal Extensions - -## Markdown Preview API Request Overrides - -This section contains examples of all controllers which use `PreviewMarkdown` module -and use different `markdown_context_params`. They exercise the various `preview_markdown` -endpoints via `glfm_example_metadata.yml`. - - -`preview_markdown` exercising `groups` API endpoint and `UploadLinkFilter`: - -```````````````````````````````` example gitlab -[groups-test-file](/uploads/groups-test-file) -. -<p><a href="groups-test-file">groups-test-file</a></p> -```````````````````````````````` - -`preview_markdown` exercising `projects` API endpoint and `RepositoryLinkFilter`: - -```````````````````````````````` example gitlab -[projects-test-file](projects-test-file) -. -<p><a href="projects-test-file">projects-test-file</a></p> -```````````````````````````````` - -`preview_markdown` exercising `projects` API endpoint and `SnippetReferenceFilter`: - -```````````````````````````````` example gitlab -This project snippet ID reference IS filtered: $88888 -. -<p>This project snippet ID reference IS filtered: $88888</p> -```````````````````````````````` - -`preview_markdown` exercising personal (non-project) `snippets` API endpoint. This is -only used by the comment field on personal snippets. It has no unique custom markdown -extension behavior, and specifically does not render snippet references via -`SnippetReferenceFilter`, even if the ID is valid. - -```````````````````````````````` example gitlab -This personal snippet ID reference is not filtered: $99999 -. -<p>This personal snippet ID reference is not filtered: $99999</p> -```````````````````````````````` - -`preview_markdown` exercising project `wikis` API endpoint and `WikiLinkFilter`: - -```````````````````````````````` example gitlab -[project-wikis-test-file](project-wikis-test-file) -. -<p><a href="project-wikis-test-file">project-wikis-test-file</a></p> -```````````````````````````````` - -`preview_markdown` exercising group `wikis` API endpoint and `WikiLinkFilter`. This example -also requires an EE license enabling the `group_wikis` feature: - -```````````````````````````````` example gitlab -[group-wikis-test-file](group-wikis-test-file) -. -<p><a href="group-wikis-test-file">group-wikis-test-file</a></p> -```````````````````````````````` diff --git a/glfm_specification/output/spec.txt b/glfm_specification/output/spec.txt index 9fa6c4c291e..a8565b15bc3 100644 --- a/glfm_specification/output/spec.txt +++ b/glfm_specification/output/spec.txt @@ -9600,7 +9600,7 @@ Multiple spaces ```````````````````````````````` -# GitLab-Specific Markdown +# GitLab Official Specification Markdown Currently, only some of the GitLab-specific markdown features are listed in this section. We will eventually add all @@ -9802,57 +9802,6 @@ title: YAML front matter <h2>title: YAML front matter</h2> ```````````````````````````````` -## Audio - -See -[audio](https://docs.gitlab.com/ee/user/markdown.html#audio) in the GitLab Flavored Markdown documentation. - -GLFM renders image elements as an audio player as long as the resource’s file extension is -one of the following supported audio extensions `.mp3`, `.oga`, `.ogg`, `.spx`, and `.wav`. -Audio ignore the alternative text part of an image declaration. - -```````````````````````````````` example gitlab -![audio](audio.oga "audio title") -. -<p><audio src="audio.oga" title="audio title"></audio></p> -```````````````````````````````` - -Reference definitions work audio as well: - -```````````````````````````````` example gitlab -[audio]: audio.oga "audio title" - -![audio][audio] -. -<p><audio src="audio.oga" title="audio title"></audio></p> -```````````````````````````````` - -## Video - -See -[videos](https://docs.gitlab.com/ee/user/markdown.html#videos) in the GitLab Flavored Markdown documentation. - -GLFM renders image elements as a video player as long as the resource’s file extension is -one of the following supported video extensions `.mp4`, `.m4v`, `.mov`, `.webm`, and `.ogv`. -Videos ignore the alternative text part of an image declaration. - - -```````````````````````````````` example gitlab -![video](video.m4v "video title") -. -<p><video src="video.m4v" title="video title"></video></p> -```````````````````````````````` - -Reference definitions work video as well: - -```````````````````````````````` example gitlab -[video]: video.mov "video title" - -![video][video] -. -<p><video src="video.mov" title="video title"></video></p> -```````````````````````````````` - ## Table of contents See @@ -9929,7 +9878,58 @@ A table of contents can be indented with up to three spaces. <h1>Heading 1</h1> ```````````````````````````````` -# Examples Using Internal Extensions +# GitLab Internal Extension Markdown + +## Audio + +See +[audio](https://docs.gitlab.com/ee/user/markdown.html#audio) in the GitLab Flavored Markdown documentation. + +GLFM renders image elements as an audio player as long as the resource’s file extension is +one of the following supported audio extensions `.mp3`, `.oga`, `.ogg`, `.spx`, and `.wav`. +Audio ignore the alternative text part of an image declaration. + +```````````````````````````````` example gitlab +![audio](audio.oga "audio title") +. +<p><audio src="audio.oga" title="audio title"></audio></p> +```````````````````````````````` + +Reference definitions work audio as well: + +```````````````````````````````` example gitlab +[audio]: audio.oga "audio title" + +![audio][audio] +. +<p><audio src="audio.oga" title="audio title"></audio></p> +```````````````````````````````` + +## Video + +See +[videos](https://docs.gitlab.com/ee/user/markdown.html#videos) in the GitLab Flavored Markdown documentation. + +GLFM renders image elements as a video player as long as the resource’s file extension is +one of the following supported video extensions `.mp4`, `.m4v`, `.mov`, `.webm`, and `.ogv`. +Videos ignore the alternative text part of an image declaration. + + +```````````````````````````````` example gitlab +![video](video.m4v "video title") +. +<p><video src="video.m4v" title="video title"></video></p> +```````````````````````````````` + +Reference definitions work video as well: + +```````````````````````````````` example gitlab +[video]: video.mov "video title" + +![video][video] +. +<p><video src="video.mov" title="video title"></video></p> +```````````````````````````````` ## Markdown Preview API Request Overrides |