diff options
Diffstat (limited to 'glfm_specification/input')
| -rw-r--r-- | glfm_specification/input/github_flavored_markdown/ghfm_spec_v_0.29.md (renamed from glfm_specification/input/github_flavored_markdown/ghfm_spec_v_0.29.txt) | 3 | ||||
| -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_normalizations.yml | 1 | ||||
| -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_intro.md (renamed from glfm_specification/input/gitlab_flavored_markdown/glfm_intro.txt) | 0 | ||||
| -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 |
7 files changed, 128 insertions, 129 deletions
diff --git a/glfm_specification/input/github_flavored_markdown/ghfm_spec_v_0.29.txt b/glfm_specification/input/github_flavored_markdown/ghfm_spec_v_0.29.md index 582131d700a..1702761563e 100644 --- a/glfm_specification/input/github_flavored_markdown/ghfm_spec_v_0.29.txt +++ b/glfm_specification/input/github_flavored_markdown/ghfm_spec_v_0.29.md @@ -2077,7 +2077,7 @@ followed by one of the strings (case-insensitive) `address`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `head`, `header`, `hr`, `html`, `iframe`, `legend`, `li`, `link`, `main`, `menu`, `menuitem`, `nav`, `noframes`, `ol`, `optgroup`, `option`, `p`, `param`, -`section`, `source`, `summary`, `table`, `tbody`, `td`, +`section`, `summary`, `table`, `tbody`, `td`, `tfoot`, `th`, `thead`, `title`, `tr`, `track`, `ul`, followed by [whitespace], the end of the line, the string `>`, or the string `/>`.\ @@ -10224,4 +10224,3 @@ closers: After we're done, we remove all delimiters above `stack_bottom` from the delimiter stack. - 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_normalizations.yml b/glfm_specification/input/gitlab_flavored_markdown/glfm_example_normalizations.yml index d576a8ddb51..06de4e687af 100644 --- a/glfm_specification/input/gitlab_flavored_markdown/glfm_example_normalizations.yml +++ b/glfm_specification/input/gitlab_flavored_markdown/glfm_example_normalizations.yml @@ -5,6 +5,7 @@ # - https://docs.gitlab.com/ee/development/gitlab_flavored_markdown/specification_guide/#glfm_example_normalizationsyml # # NOTE: All YAML anchors which are shared across one or more entries are defined in the `00_shared` section. +# They must all start with `00_` in order to be skipped during example name validation. 00_shared: 00_uri: &00_uri - regex: '(href|data-src)(=")(.*?)(test-file\.(png|zip)")' 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 + +. +<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 + +. +<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_intro.txt b/glfm_specification/input/gitlab_flavored_markdown/glfm_intro.md index b5351bf37de..b5351bf37de 100644 --- a/glfm_specification/input/gitlab_flavored_markdown/glfm_intro.txt +++ b/glfm_specification/input/gitlab_flavored_markdown/glfm_intro.md 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 - -. -<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 - -. -<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> -```````````````````````````````` |