diff options
Diffstat (limited to 'glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt')
| -rw-r--r-- | glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt | 389 |
1 files changed, 0 insertions, 389 deletions
diff --git a/glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt b/glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt deleted file mode 100644 index 10a46dcca6b..00000000000 --- a/glfm_specification/input/gitlab_flavored_markdown/glfm_canonical_examples.txt +++ /dev/null @@ -1,389 +0,0 @@ -# GitLab-Specific Markdown - -Currently, only some of the GitLab-specific markdown features are -listed in this section. We will eventually add all -GitLab-specific features currently listed as supported 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 -[Task lists](https://docs.gitlab.com/ee/user/markdown.html#task-lists) in the GitLab Flavored Markdown documentation. - -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. - -Some of the behavior of task list items is implemented as client-side JavaScript/CSS. - -The following are some basic examples; more examples may be added in the future. - -Incomplete task: - -```````````````````````````````` example gitlab -- [ ] incomplete -. -<ul> -<li> -<task-button/> -<input type="checkbox" disabled/> -incomplete -</li> -</ul> -```````````````````````````````` - -Completed task: - -```````````````````````````````` example gitlab -- [x] completed -. -<ul> -<li> -<task-button/> -<input type="checkbox" checked disabled/> -completed -</li> -</ul> -```````````````````````````````` - -Inapplicable task: - -```````````````````````````````` example gitlab -- [~] inapplicable -. -<ul> -<li> -<task-button/> -<input type="checkbox" data-inapplicable disabled> -<s> -inapplicable -</s> -</li> -</ul> -```````````````````````````````` - -Inapplicable task in a "loose" list. Note that the `<del>` tag is not applied to the -loose text; it has strikethrough applied with CSS. - -```````````````````````````````` example gitlab -- [~] inapplicable - - text in loose list -. -<ul> -<li> -<p> -<task-button/> -<input type="checkbox" data-inapplicable disabled> -<s> -inapplicable -</s> -</p> -<p> -text in loose list -</p> -</li> -</ul> -```````````````````````````````` - -## Front matter - -See -[Front matter](https://docs.gitlab.com/ee/user/markdown.html#front-matter) in the GitLab Flavored Markdown documentation. - -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. - -YAML front matter: - -```````````````````````````````` example gitlab ---- -title: YAML front matter ---- -. -<pre> -<code> -title: YAML front matter -</code> -</pre> -```````````````````````````````` - -TOML front matter: - -```````````````````````````````` example gitlab -+++ -title: TOML front matter -+++ -. -<pre> -<code> -title: TOML front matter -</code> -</pre> -```````````````````````````````` - -JSON front matter: - -```````````````````````````````` example gitlab -;;; -{ - "title": "JSON front matter" -} -;;; -. -<pre> -<code> -{ - "title": "JSON front matter" -} -</code> -</pre> -```````````````````````````````` - -Front matter blocks should be inserted at the top of the document: - -```````````````````````````````` example gitlab -text - ---- -title: YAML front matter ---- -. -<p>text</p> -<hr> -<h2>title: YAML front matter</h2> -```````````````````````````````` - -Front matter block delimiters shouldn’t be preceded by space characters: - -```````````````````````````````` example gitlab - --- -title: YAML front matter ---- -. -<hr> -<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 -[table of contents](https://docs.gitlab.com/ee/user/markdown.html#table-of-contents) -in the GitLab Flavored Markdown documentation. - -A table of contents is an unordered list that links to subheadings in the document. -Add either the `[[_TOC_]]` or `[TOC]` tag on its own line. - -```````````````````````````````` example gitlab -[TOC] - -# Heading 1 - -## Heading 2 -. -<nav> - <ul> - <li><a href="#heading-1">Heading 1</a></li> - <ul> - <li><a href="#heading-2">Heading 2</a></li> - </ul> - </ul> -</nav> -<h1>Heading 1</h1> -<h2>Heading 2</h2> -```````````````````````````````` - -```````````````````````````````` example gitlab -[[_TOC_]] - -# Heading 1 - -## Heading 2 -. -<nav> - <ul> - <li><a href="#heading-1">Heading 1</a></li> - <ul> - <li><a href="#heading-2">Heading 2</a></li> - </ul> - </ul> -</nav> -<h1>Heading 1</h1> -<h2>Heading 2</h2> -```````````````````````````````` - -A table of contents is a block element. It should preceded and followed by a blank -line. - -```````````````````````````````` example gitlab -[[_TOC_]] -text - -text -[TOC] -. -<p>[[<em>TOC</em>]]text</p> -<p>text[TOC]</p> -```````````````````````````````` - -A table of contents can be indented with up to three spaces. - -```````````````````````````````` example gitlab - [[_TOC_]] - -# Heading 1 -. -<nav> - <ul> - <li><a href="#heading-1">Heading 1</a></li> - </ul> -</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> -```````````````````````````````` |