diff options
Diffstat (limited to 'glfm_specification/output_spec/spec.txt')
| -rw-r--r-- | glfm_specification/output_spec/spec.txt | 47 |
1 files changed, 12 insertions, 35 deletions
diff --git a/glfm_specification/output_spec/spec.txt b/glfm_specification/output_spec/spec.txt index 350acea770c..10484da5531 100644 --- a/glfm_specification/output_spec/spec.txt +++ b/glfm_specification/output_spec/spec.txt @@ -2,9 +2,18 @@ title: GitLab Flavored Markdown Official Specification version: alpha ... +--- +title: GitLab Flavored Markdown (GLFM) Spec +version: alpha +... + # Introduction -TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section. +GitLab Flavored Markdown (GLFM) extends the [CommonMark specification](https://spec.commonmark.org/current/) and is considered a strict superset of CommonMark. It also incorporates the extensions defined by the [GitHub Flavored Markdown specification](https://github.github.com/gfm/). + +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 [user-facing documentation for GitLab Flavored Markdown](https://docs.gitlab.com/ee/user/markdown.html). + +The CommonMark and GitHub specifications will not be duplicated here. 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 @@ -19,45 +28,13 @@ for a complete list of all examples, which are a superset of examples from: <!-- BEGIN TESTS --> # GitLab Official Specification Markdown -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 +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 [user-facing documentation for GitLab Flavored Markdown](https://docs.gitlab.com/ee/user/markdown.html). There is currently only this single top-level heading, but the examples may be split into multiple top-level headings in the future. -## Footnotes - -See -[the footnotes section of the user-facing documentation for GitLab Flavored Markdown](https://docs.gitlab.com/ee/user/markdown.html#footnotes). - -```````````````````````````````` example gitlab -footnote reference tag [^fortytwo] - -[^fortytwo]: footnote text -. -<p> -footnote reference tag -<sup> -<a href="#fn-fortytwo-42" id="fnref-fortytwo-42" data-footnote-ref> -1 -</a> -</sup> -</p> -<section data-footnotes> -<ol> -<li id="fn-fortytwo-42"> -<p> -footnote text -<a href="#fnref-fortytwo-42" data-footnote-backref> -</a> -</p> -</li> -</ol> -</section> -```````````````````````````````` - ## Task list items See |