diff options
Diffstat (limited to 'doc/development/gitlab_flavored_markdown')
-rw-r--r-- | doc/development/gitlab_flavored_markdown/specification_guide/index.md | 62 |
1 files changed, 32 insertions, 30 deletions
diff --git a/doc/development/gitlab_flavored_markdown/specification_guide/index.md b/doc/development/gitlab_flavored_markdown/specification_guide/index.md index 53ef468556a..0765f502b9b 100644 --- a/doc/development/gitlab_flavored_markdown/specification_guide/index.md +++ b/doc/development/gitlab_flavored_markdown/specification_guide/index.md @@ -206,6 +206,9 @@ of specification-driven testing referred to in this documentation and elsewhere. #### Markdown conformance testing +NOTE: +Markdown conformance testing for GLFM is not yet implemented. + _Markdown conformance testing_ refers to the standard testing method used by all CommonMark Markdown dialects to verify that a specific implementation conforms to the CommonMark Markdown specification. It is enforced by running the standard @@ -804,36 +807,35 @@ consists of the manually updated Markdown+HTML examples for the `glfm_specification/input/gitlab_flavored_markdown/glfm_official_specification_examples.md` sample entries: -NOTE: -All lines in this example are prefixed with a `|` character. This prefix helps avoid false -errors when this file is checked by `markdownlint`, and possible errors in other Markdown editors. -The actual file should not have these prefixed `|` characters. +<!-- markdownlint-disable MD048 --> -```plaintext -|# Section with GLFM official specification examples -| -|## Strong -| -|### Strong with two asterisks -| -|```````````````````````````````` example -|**bold** -|. -|<p><strong>bold</strong></p> -|```````````````````````````````` -| -|### Strong with HTML -| -|```````````````````````````````` example -|<strong> -|bold -|</strong> -|. -|<p><strong> -|bold -|</strong></p> -|```````````````````````````````` -``` +~~~plaintext +# Section with GLFM official specification examples + +## Strong + +### Strong with two asterisks + +```````````````````````````````` example +**bold** +. +<p><strong>bold</strong></p> +```````````````````````````````` + +### Strong with HTML + +```````````````````````````````` example +<strong> +bold +</strong> +. +<p><strong> +bold +</strong></p> +```````````````````````````````` +~~~ + +<!-- markdownlint-enable MD048 --> ##### `glfm_internal_extension_examples.md` @@ -1231,7 +1233,7 @@ This section describes how the scripts can be used to manage the GLFM specificat 1. Run [`update-specification.rb`](#update-specificationrb-script) to update the GLFM specification [output specification files](#output-specification-files). 1. Visually inspect and confirm any resulting changes to the [output specification files](#output-specification-files). -1. Run [`run-spec-tests.sh`](http://gdk.test:3005/ee/development/gitlab_flavored_markdown/specification_guide/index.html#run-spec-testssh-script) to run the conformance tests against the canonicalized GLFM specification. +1. Run [`run-spec-tests.sh`](#run-spec-testssh-script) to run the conformance tests against the canonicalized GLFM specification. 1. Commit any changes to the [output specification files](#output-specification-files). ### Update the example snapshots and run snapshot tests |