TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section.
-Any sequence of [characters] is a valid CommonMark +
Any sequence of [characters] is a valid CommonMark document.
-A character is a Unicode code point. Although some +
A character is a Unicode code point. Although some code points (for example, combining accents) do not correspond to characters in an intuitive sense, all code points count as characters for purposes of this spec.
-This spec does not specify an encoding; it thinks of lines as composed +
This spec does not specify an encoding; it thinks of lines as composed of [characters] rather than bytes. A conforming parser may be limited to a certain encoding.
-A line is a sequence of zero or more [characters] +
A line is a sequence of zero or more [characters]
other than newline (U+000A) or carriage return (U+000D),
followed by a [line ending] or by the end of file.
A line ending is a newline (U+000A), a carriage return
+
A line ending is a newline (U+000A), a carriage return
(U+000D) not followed by a newline, or a carriage return and a
following newline.
A line containing no characters, or a line containing only spaces +
A line containing no characters, or a line containing only spaces
(U+0020) or tabs (U+0009), is called a blank line.
The following definitions of character classes will be used in this spec:
-A whitespace character is a space +
The following definitions of character classes will be used in this spec:
+A whitespace character is a space
(U+0020), tab (U+0009), newline (U+000A), line tabulation (U+000B),
form feed (U+000C), or carriage return (U+000D).
Whitespace is a sequence of one or more [whitespace +
Whitespace is a sequence of one or more [whitespace characters].
-A Unicode whitespace character is +
A Unicode whitespace character is
any code point in the Unicode Zs general category, or a tab (U+0009),
carriage return (U+000D), newline (U+000A), or form feed
(U+000C).
Unicode whitespace is a sequence of one +
Unicode whitespace is a sequence of one or more [Unicode whitespace characters].
-A space is U+0020.
A non-whitespace character is any character +
A space is U+0020.
A non-whitespace character is any character that is not a [whitespace character].
-An ASCII punctuation character +
An ASCII punctuation character
is !, ", #, $, %, &, ', (, ),
*, +, ,, -, ., / (U+0021–2F),
:, ;, <, =, >, ?, @ (U+003A–0040),
[, \, ], ^, _, ` (U+005B–0060),
{, |, }, or ~ (U+007B–007E).
A punctuation character is an [ASCII +
A punctuation character is an [ASCII
punctuation character] or anything in
the general Unicode categories Pc, Pd, Pe, Pf, Pi, Po, or Ps.
Tabs in lines are not expanded to [spaces]. However, +
Tabs in lines are not expanded to [spaces]. However, in contexts where whitespace helps to define block structure, tabs behave as if they were replaced by spaces with a tab stop of 4 characters.
-Thus, for example, a tab can be used instead of four spaces +
Thus, for example, a tab can be used instead of four spaces in an indented code block. (Note, however, that internal tabs are passed through as literal tabs, not expanded to spaces.)
→foo→baz→→bim
+→foo→baz→→bim
.
<pre><code>foo→baz→→bim
</code></pre>
→foo→baz→→bim
+ →foo→baz→→bim
.
<pre><code>foo→baz→→bim
</code></pre>
a→a
+ a→a
ὐ→a
.
<pre><code>a→a
@@ -84,11 +81,11 @@ spaces.)
</code></pre>
In the following example, a continuation paragraph of a list +
In the following example, a continuation paragraph of a list item is indented with a tab; this has exactly the same effect as indentation with four spaces would:
- foo
+ - foo
→bar
.
@@ -101,7 +98,7 @@ as indentation with four spaces would:
- foo
+- foo
→→bar
.
@@ -114,7 +111,7 @@ as indentation with four spaces would:
</ul>
Normally the > that begins a block quote may be followed
+
Normally the > that begins a block quote may be followed
optionally by a space, which is not considered part of the
content. In the following case > is followed by a tab,
which is treated as if it were expanded into three spaces.
@@ -123,7 +120,7 @@ delimiter, foo is considered to be indented six spaces
inside the block quote context, so we get an indented
code block starting with two spaces.
>→→foo
+>→→foo
.
<blockquote>
<pre><code> foo
@@ -132,7 +129,7 @@ code block starting with two spaces.
-→→foo
+-→→foo
.
<ul>
<li>
@@ -143,7 +140,7 @@ code block starting with two spaces.
foo
+ foo
→bar
.
<pre><code>foo
@@ -152,7 +149,7 @@ code block starting with two spaces.
- foo
+ - foo
- bar
→ - baz
.
@@ -170,36 +167,36 @@ code block starting with two spaces.
#→Foo
+#→Foo
.
<h1>Foo</h1>
*→*→*→
+*→*→*→
.
<hr />
For security reasons, the Unicode character U+0000 must be replaced
+
For security reasons, the Unicode character U+0000 must be replaced
with the REPLACEMENT CHARACTER (U+FFFD).
We can think of a document as a sequence of +
We can think of a document as a sequence of blocks---structural elements like paragraphs, block quotations, lists, headings, rules, and code blocks. Some blocks (like block quotes and list items) contain other blocks; others (like headings and paragraphs) contain inline content---text, links, emphasized text, images, code spans, and so on.
-Indicators of block structure always take precedence over indicators +
Indicators of block structure always take precedence over indicators of inline structure. So, for example, the following is a list with two items, not a list with one item containing a code span:
- `one
+- `one
- two`
.
<ul>
@@ -208,7 +205,7 @@ two items, not a list with one item containing a code span:
</ul>
This means that parsing can proceed in two steps: first, the block +
This means that parsing can proceed in two steps: first, the block structure of the document can be discerned; second, text lines inside paragraphs, headings, and other block constructs can be parsed for inline structure. The second step requires information about link reference @@ -216,24 +213,24 @@ definitions that will be available only at the end of the first step. Note that the first step requires processing lines in sequence, but the second can be parallelized, since the inline parsing of one block element does not affect the inline parsing of any other.
-We can divide blocks into two types: +
We can divide blocks into two types: container blocks, which can contain other blocks, and leaf blocks, which cannot.
-This section describes the different kinds of leaf block that make up a +
This section describes the different kinds of leaf block that make up a Markdown document.
-A line consisting of 0-3 spaces of indentation, followed by a sequence +
A line consisting of 0-3 spaces of indentation, followed by a sequence
of three or more matching -, _, or * characters, each followed
optionally by any number of spaces or tabs, forms a
thematic break.
***
+***
---
___
.
@@ -242,22 +239,22 @@ optionally by any number of spaces or tabs, forms a
<hr />
Wrong characters:
+Wrong characters:
+++
++++
.
<p>+++</p>
===
+===
.
<p>===</p>
Not enough characters:
+Not enough characters:
--
+--
**
__
.
@@ -266,9 +263,9 @@ optionally by any number of spaces or tabs, forms a
__</p>
One to three spaces indent are allowed:
+One to three spaces indent are allowed:
***
+ ***
***
***
.
@@ -277,58 +274,58 @@ optionally by any number of spaces or tabs, forms a
<hr />
Four spaces is too many:
+Four spaces is too many:
***
+ ***
.
<pre><code>***
</code></pre>
Foo
+Foo
***
.
<p>Foo
***</p>
More than three characters may be used:
+More than three characters may be used:
_____________________________________
+_____________________________________
.
<hr />
Spaces are allowed between the characters:
+Spaces are allowed between the characters:
- - -
+ - - -
.
<hr />
** * ** * ** * **
+ ** * ** * ** * **
.
<hr />
- - - -
+- - - -
.
<hr />
Spaces are allowed at the end:
+Spaces are allowed at the end:
- - - -
+- - - -
.
<hr />
However, no other characters may occur in the line:
+However, no other characters may occur in the line:
_ _ _ _ a
+_ _ _ _ a
a------
@@ -339,17 +336,17 @@ optionally by any number of spaces or tabs, forms a
<p>---a---</p>
It is required that all of the [non-whitespace characters] be the same. +
It is required that all of the [non-whitespace characters] be the same. So, this is not a thematic break:
*-*
+ *-*
.
<p><em>-</em></p>
Thematic breaks do not need blank lines before or after:
+Thematic breaks do not need blank lines before or after:
- foo
+- foo
***
- bar
.
@@ -362,9 +359,9 @@ So, this is not a thematic break:
</ul>
Thematic breaks can interrupt a paragraph:
+Thematic breaks can interrupt a paragraph:
Foo
+Foo
***
bar
.
@@ -373,13 +370,13 @@ So, this is not a thematic break:
<p>bar</p>
If a line of dashes that meets the above conditions for being a +
If a line of dashes that meets the above conditions for being a thematic break could also be interpreted as the underline of a [setext heading], the interpretation as a [setext heading] takes precedence. Thus, for example, this is a setext heading, not a paragraph followed by a thematic break:
Foo
+Foo
---
bar
.
@@ -387,10 +384,10 @@ this is a setext heading, not a paragraph followed by a thematic break:
<p>bar</p>
When both a thematic break and a list item are possible +
When both a thematic break and a list item are possible interpretations of a line, the thematic break takes precedence:
* Foo
+* Foo
* * *
* Bar
.
@@ -403,9 +400,9 @@ interpretations of a line, the thematic break takes precedence:
</ul>
If you want a thematic break in a list item, use a different bullet:
+If you want a thematic break in a list item, use a different bullet:
- Foo
+- Foo
- * * *
.
<ul>
@@ -416,9 +413,9 @@ interpretations of a line, the thematic break takes precedence:
</ul>
An ATX heading +
An ATX heading
consists of a string of characters, parsed as inline content, between an
opening sequence of 1--6 unescaped # characters and an optional
closing sequence of any number of unescaped # characters.
@@ -429,9 +426,9 @@ preceded by a [space] and may be followed by spaces only. The opening
heading are stripped of leading and trailing spaces before being parsed
as inline content. The heading level is equal to the number of #
characters in the opening sequence.
Simple headings:
+Simple headings:
# foo
+# foo
## foo
### foo
#### foo
@@ -446,14 +443,14 @@ characters in the opening sequence.
<h6>foo</h6>
More than six # characters is not a heading:
More than six # characters is not a heading:
####### foo
+####### foo
.
<p>####### foo</p>
At least one space is required between the # characters and the
+
At least one space is required between the # characters and the
heading's contents, unless the heading is empty. Note that many
implementations currently do not require the space. However, the
space was required by the
@@ -461,7 +458,7 @@ space was required by the
and it helps prevent things like the following from being parsed as
headings:
#5 bolt
+#5 bolt
#hashtag
.
@@ -469,30 +466,30 @@ headings:
<p>#hashtag</p>
This is not a heading, because the first # is escaped:
This is not a heading, because the first # is escaped:
\## foo
+\## foo
.
<p>## foo</p>
Contents are parsed as inlines:
+Contents are parsed as inlines:
# foo *bar* \*baz\*
+# foo *bar* \*baz\*
.
<h1>foo <em>bar</em> *baz*</h1>
Leading and trailing [whitespace] is ignored in parsing inline content:
+Leading and trailing [whitespace] is ignored in parsing inline content:
# foo
+# foo
.
<h1>foo</h1>
One to three spaces indentation are allowed:
+One to three spaces indentation are allowed:
### foo
+ ### foo
## foo
# foo
.
@@ -501,67 +498,67 @@ headings:
<h1>foo</h1>
Four spaces are too much:
+Four spaces are too much:
# foo
+ # foo
.
<pre><code># foo
</code></pre>
foo
+foo
# bar
.
<p>foo
# bar</p>
A closing sequence of # characters is optional:
A closing sequence of # characters is optional:
## foo ##
+## foo ##
### bar ###
.
<h2>foo</h2>
<h3>bar</h3>
It need not be the same length as the opening sequence:
+It need not be the same length as the opening sequence:
# foo ##################################
+# foo ##################################
##### foo ##
.
<h1>foo</h1>
<h5>foo</h5>
Spaces are allowed after the closing sequence:
+Spaces are allowed after the closing sequence:
### foo ###
+### foo ###
.
<h3>foo</h3>
A sequence of # characters with anything but [spaces] following it
+
A sequence of # characters with anything but [spaces] following it
is not a closing sequence, but counts as part of the contents of the
heading:
### foo ### b
+### foo ### b
.
<h3>foo ### b</h3>
The closing sequence must be preceded by a space:
+The closing sequence must be preceded by a space:
# foo#
+# foo#
.
<h1>foo#</h1>
Backslash-escaped # characters do not count as part
+
Backslash-escaped # characters do not count as part
of the closing sequence:
### foo \###
+### foo \###
## foo #\##
# foo \#
.
@@ -570,10 +567,10 @@ of the closing sequence:
<h1>foo #</h1>
ATX headings need not be separated from surrounding content by blank +
ATX headings need not be separated from surrounding content by blank lines, and they can interrupt paragraphs:
****
+****
## foo
****
.
@@ -583,7 +580,7 @@ lines, and they can interrupt paragraphs:
Foo bar
+Foo bar
# baz
Bar foo
.
@@ -592,9 +589,9 @@ lines, and they can interrupt paragraphs:
<p>Bar foo</p>
ATX headings can be empty:
+ATX headings can be empty:
##
+##
#
### ###
.
@@ -603,9 +600,9 @@ lines, and they can interrupt paragraphs:
<h3></h3>
A setext heading consists of one or more +
A setext heading consists of one or more lines of text, each containing at least one [non-whitespace character], with no more than 3 spaces indentation, followed by a [setext heading underline]. The lines of text must be such @@ -614,24 +611,24 @@ they would be interpreted as a paragraph: they cannot be interpretable as a [code fence], [ATX heading][ATX headings], [block quote][block quotes], [thematic break][thematic breaks], [list item][list items], or [HTML block][HTML blocks].
-A setext heading underline is a sequence of +
A setext heading underline is a sequence of
= characters or a sequence of - characters, with no more than 3
spaces indentation and any number of trailing spaces. If a line
containing a single - can be interpreted as an
empty [list items], it should be interpreted this way
and not as a [setext heading underline].
The heading is a level 1 heading if = characters are used in
+
The heading is a level 1 heading if = characters are used in
the [setext heading underline], and a level 2 heading if -
characters are used. The contents of the heading are the result
of parsing the preceding lines of text as CommonMark inline
content.
In general, a setext heading need not be preceded or followed by a +
In general, a setext heading need not be preceded or followed by a blank line. However, it cannot interrupt a paragraph, so when a setext heading comes after a paragraph, a blank line is needed between them.
-Simple examples:
+Simple examples:
Foo *bar*
+Foo *bar*
=========
Foo *bar*
@@ -641,9 +638,9 @@ them.
<h2>Foo <em>bar</em></h2>
The content of the header may span more than one line:
+The content of the header may span more than one line:
Foo *bar
+Foo *bar
baz*
====
.
@@ -651,12 +648,12 @@ them.
baz</em></h1>
The contents are the result of parsing the headings's raw +
The contents are the result of parsing the headings's raw content as inlines. The heading's raw content is formed by concatenating the lines and removing initial and final [whitespace].
Foo *bar
+ Foo *bar
baz*→
====
.
@@ -664,9 +661,9 @@ concatenating the lines and removing initial and final
baz</em></h1>
The underlining can be any length:
+The underlining can be any length:
Foo
+Foo
-------------------------
Foo
@@ -676,10 +673,10 @@ concatenating the lines and removing initial and final
<h1>Foo</h1>
The heading content can be indented up to three spaces, and need +
The heading content can be indented up to three spaces, and need not line up with the underlining:
Foo
+ Foo
---
Foo
@@ -693,9 +690,9 @@ not line up with the underlining:
<h1>Foo</h1>
Four spaces indent is too much:
+Four spaces indent is too much:
Foo
+ Foo
---
Foo
@@ -709,27 +706,27 @@ not line up with the underlining:
<hr />
The setext heading underline can be indented up to three spaces, and +
The setext heading underline can be indented up to three spaces, and may have trailing spaces:
Foo
+Foo
----
.
<h2>Foo</h2>
Four spaces is too much:
+Four spaces is too much:
Foo
+Foo
---
.
<p>Foo
---</p>
The setext heading underline cannot contain internal spaces:
+The setext heading underline cannot contain internal spaces:
Foo
+Foo
= =
Foo
@@ -741,26 +738,26 @@ may have trailing spaces:
<hr />
Trailing spaces in the content line do not cause a line break:
+Trailing spaces in the content line do not cause a line break:
Foo
+Foo
-----
.
<h2>Foo</h2>
Nor does a backslash at the end:
+Nor does a backslash at the end:
Foo\
+Foo\
----
.
<h2>Foo\</h2>
Since indicators of block structure take precedence over +
Since indicators of block structure take precedence over indicators of inline structure, the following are setext headings:
`Foo
+`Foo
----
`
@@ -774,10 +771,10 @@ indicators of inline structure, the following are setext headings:
<p>of dashes"/></p>
The setext heading underline cannot be a [lazy continuation +
The setext heading underline cannot be a [lazy continuation line] in a list item or block quote:
> Foo
+> Foo
---
.
<blockquote>
@@ -787,7 +784,7 @@ line] in a list item or block quote:
> foo
+> foo
bar
===
.
@@ -799,7 +796,7 @@ line] in a list item or block quote:
- Foo
+- Foo
---
.
<ul>
@@ -808,11 +805,11 @@ line] in a list item or block quote:
<hr />
A blank line is needed between a paragraph and a following +
A blank line is needed between a paragraph and a following setext heading, since otherwise the paragraph becomes part of the heading's content:
Foo
+Foo
Bar
---
.
@@ -820,10 +817,10 @@ of the heading's content:
Bar</h2>
But in general a blank line is not required before or after +
But in general a blank line is not required before or after setext headings:
---
+---
Foo
---
Bar
@@ -836,19 +833,19 @@ setext headings:
<p>Baz</p>
Setext headings cannot be empty:
+Setext headings cannot be empty:
+
====
.
<p>====</p>
Setext heading text lines must not be interpretable as block +
Setext heading text lines must not be interpretable as block constructs other than paragraphs. So, the line of dashes in these examples gets interpreted as a thematic break:
---
+---
---
.
<hr />
@@ -856,7 +853,7 @@ in these examples gets interpreted as a thematic break:
- foo
+- foo
-----
.
<ul>
@@ -866,7 +863,7 @@ in these examples gets interpreted as a thematic break:
foo
+ foo
---
.
<pre><code>foo
@@ -875,7 +872,7 @@ in these examples gets interpreted as a thematic break:
> foo
+> foo
-----
.
<blockquote>
@@ -884,38 +881,38 @@ in these examples gets interpreted as a thematic break:
<hr />
If you want a heading with > foo as its literal text, you can
+
If you want a heading with > foo as its literal text, you can
use backslash escapes:
\> foo
+\> foo
------
.
<h2>> foo</h2>
Compatibility note: Most existing Markdown implementations +
Compatibility note: Most existing Markdown implementations do not allow the text of setext headings to span multiple lines. But there is no consensus about how to interpret
Foo
+Foo
bar
---
baz
One can find four different interpretations:
-One can find four different interpretations:
+We find interpretation 4 most natural, and interpretation 4 +
We find interpretation 4 most natural, and interpretation 4 increases the expressive power of CommonMark, by allowing multiline headings. Authors who want interpretation 1 can put a blank line after the first paragraph:
Foo
+Foo
bar
---
@@ -926,10 +923,10 @@ put a blank line after the first paragraph:
<p>baz</p>
Authors who want interpretation 2 can put blank lines around +
Authors who want interpretation 2 can put blank lines around the thematic break,
Foo
+Foo
bar
---
@@ -942,10 +939,10 @@ the thematic break,
<p>baz</p>
or use a thematic break that cannot count as a [setext heading +
or use a thematic break that cannot count as a [setext heading underline], such as
Foo
+Foo
bar
* * *
baz
@@ -956,9 +953,9 @@ underline], such as
<p>baz</p>
Authors who want interpretation 3 can use backslash escapes:
+Authors who want interpretation 3 can use backslash escapes:
Foo
+Foo
bar
\---
baz
@@ -969,21 +966,21 @@ underline], such as
baz</p>
An indented code block is composed of one or more +
An indented code block is composed of one or more [indented chunks] separated by blank lines. An indented chunk is a sequence of non-blank lines, each indented four or more spaces. The contents of the code block are the literal contents of the lines, including trailing [line endings], minus four spaces of indentation. An indented code block has no [info string].
-An indented code block cannot interrupt a paragraph, so there must be +
An indented code block cannot interrupt a paragraph, so there must be a blank line between a paragraph and a following indented code block. (A blank line is not needed, however, between a code block and a following paragraph.)
a simple
+ a simple
indented code block
.
<pre><code>a simple
@@ -991,11 +988,11 @@ paragraph.)
</code></pre>
If there is any ambiguity between an interpretation of indentation +
If there is any ambiguity between an interpretation of indentation as a code block and as indicating that material belongs to a [list item][list items], the list item interpretation takes precedence:
- foo
+ - foo
bar
.
@@ -1008,7 +1005,7 @@ item][list items], the list item interpretation takes precedence:
1. foo
+1. foo
- bar
.
@@ -1022,10 +1019,10 @@ item][list items], the list item interpretation takes precedence:
</ol>
The contents of a code block are literal text, and do not get parsed +
The contents of a code block are literal text, and do not get parsed as Markdown:
<a/>
+ <a/>
*hi*
- one
@@ -1037,9 +1034,9 @@ as Markdown:
</code></pre>
Here we have three chunks separated by blank lines:
+Here we have three chunks separated by blank lines:
chunk1
+ chunk1
chunk2
@@ -1057,10 +1054,10 @@ as Markdown:
</code></pre>
Any initial spaces beyond four will be included in the content, even +
Any initial spaces beyond four will be included in the content, even in interior blank lines:
chunk1
+ chunk1
chunk2
.
@@ -1070,10 +1067,10 @@ in interior blank lines:
</code></pre>
An indented code block cannot interrupt a paragraph. (This +
An indented code block cannot interrupt a paragraph. (This allows hanging indents and the like.)
Foo
+Foo
bar
.
@@ -1081,11 +1078,11 @@ allows hanging indents and the like.)
bar</p>
However, any non-blank line with fewer than four leading spaces ends +
However, any non-blank line with fewer than four leading spaces ends the code block immediately. So a paragraph may occur immediately after indented code:
foo
+ foo
bar
.
<pre><code>foo
@@ -1093,10 +1090,10 @@ after indented code:
<p>bar</p>
And indented code can occur immediately before and after other kinds of +
And indented code can occur immediately before and after other kinds of blocks:
# Heading
+# Heading
foo
Heading
------
@@ -1112,9 +1109,9 @@ blocks:
<hr />
The first line can be indented more than four spaces:
+The first line can be indented more than four spaces:
foo
+ foo
bar
.
<pre><code> foo
@@ -1122,10 +1119,10 @@ blocks:
</code></pre>
Blank lines preceding or following an indented code block +
Blank lines preceding or following an indented code block are not included in it:
+
foo
@@ -1135,29 +1132,29 @@ are not included in it:
</code></pre>
Trailing spaces are included in the code block's content:
+Trailing spaces are included in the code block's content:
foo
+ foo
.
<pre><code>foo
</code></pre>
A code fence is a sequence +
A code fence is a sequence
of at least three consecutive backtick characters (`) or
tildes (~). (Tildes and backticks cannot be mixed.)
A fenced code block
begins with a code fence, indented no more than three spaces.
The line with the opening code fence may optionally contain some text +
The line with the opening code fence may optionally contain some text following the code fence; this is trimmed of leading and trailing whitespace and called the info string. If the [info string] comes after a backtick fence, it may not contain any backtick characters. (The reason for this restriction is that otherwise some inline code would be incorrectly interpreted as the beginning of a fenced code block.)
-The content of the code block consists of all subsequent lines, until +
The content of the code block consists of all subsequent lines, until a closing [code fence] of the same type as the code block began with (backticks or tildes), and with at least as many backticks or tildes as the opening code fence. If the leading code fence is @@ -1165,7 +1162,7 @@ indented N spaces, then up to N spaces of indentation are removed from each line of the content (if present). (If a content line is not indented, it is preserved unchanged. If it is indented less than N spaces, all of the indentation is removed.)
-The closing code fence may be indented up to three spaces, and may be +
The closing code fence may be indented up to three spaces, and may be followed only by spaces, which are ignored. If the end of the containing block (or document) is reached and no closing code fence has been found, the code block contains all of the lines after the @@ -1174,16 +1171,16 @@ document). (An alternative spec would require backtracking in the event that a closing code fence is not found. But this makes parsing much less efficient, and there seems to be no real down side to the behavior described here.)
-A fenced code block may interrupt a paragraph, and does not require +
A fenced code block may interrupt a paragraph, and does not require a blank line either before or after.
-The content of a code fence is treated as literal text, not parsed +
The content of a code fence is treated as literal text, not parsed
as inlines. The first word of the [info string] is typically used to
specify the language of the code sample, and rendered in the class
attribute of the code tag. However, this spec does not mandate any
particular treatment of the [info string].
Here is a simple example with backticks:
+Here is a simple example with backticks:
```
+```
<
>
```
@@ -1193,9 +1190,9 @@ particular treatment of the [info string].
</code></pre>
With tildes:
+With tildes:
~~~
+~~~
<
>
~~~
@@ -1205,19 +1202,19 @@ particular treatment of the [info string].
</code></pre>
Fewer than three backticks is not enough:
+Fewer than three backticks is not enough:
``
+``
foo
``
.
<p><code>foo</code></p>
The closing code fence must use the same character as the opening +
The closing code fence must use the same character as the opening fence:
```
+```
aaa
~~~
```
@@ -1228,7 +1225,7 @@ fence:
~~~
+~~~
aaa
```
~~~
@@ -1238,9 +1235,9 @@ fence:
</code></pre>
The closing code fence must be at least as long as the opening fence:
+The closing code fence must be at least as long as the opening fence:
````
+````
aaa
```
``````
@@ -1251,7 +1248,7 @@ fence:
~~~~
+~~~~
aaa
~~~
~~~~
@@ -1261,16 +1258,16 @@ fence:
</code></pre>
Unclosed code blocks are closed by the end of the document +
Unclosed code blocks are closed by the end of the document (or the enclosing [block quote][block quotes] or [list item][list items]):
```
+```
.
<pre><code></code></pre>
`````
+`````
```
aaa
@@ -1282,7 +1279,7 @@ fence:
> ```
+> ```
> aaa
bbb
@@ -1294,9 +1291,9 @@ fence:
<p>bbb</p>
A code block can have all empty lines as its content:
+A code block can have all empty lines as its content:
```
+```
```
@@ -1306,19 +1303,19 @@ fence:
</code></pre>
A code block can be empty:
+A code block can be empty:
```
+```
```
.
<pre><code></code></pre>
Fences can be indented. If the opening fence is indented, +
Fences can be indented. If the opening fence is indented, content lines will have equivalent opening indentation removed, if present:
```
+ ```
aaa
aaa
```
@@ -1329,7 +1326,7 @@ if present:
```
+ ```
aaa
aaa
aaa
@@ -1342,7 +1339,7 @@ if present:
```
+ ```
aaa
aaa
aaa
@@ -1354,9 +1351,9 @@ if present:
</code></pre>
Four spaces indentation produces an indented code block:
+Four spaces indentation produces an indented code block:
```
+ ```
aaa
```
.
@@ -1366,10 +1363,10 @@ if present:
</code></pre>
Closing fences may be indented by 0-3 spaces, and their indentation +
Closing fences may be indented by 0-3 spaces, and their indentation need not match that of the opening fence:
```
+```
aaa
```
.
@@ -1378,7 +1375,7 @@ need not match that of the opening fence:
```
+ ```
aaa
```
.
@@ -1386,9 +1383,9 @@ need not match that of the opening fence:
</code></pre>
This is not a closing fence, because it is indented 4 spaces:
+This is not a closing fence, because it is indented 4 spaces:
```
+```
aaa
```
.
@@ -1397,9 +1394,9 @@ need not match that of the opening fence:
</code></pre>
Code fences (opening and closing) cannot contain internal spaces:
+Code fences (opening and closing) cannot contain internal spaces:
``` ```
+``` ```
aaa
.
<p><code> </code>
@@ -1407,7 +1404,7 @@ need not match that of the opening fence:
~~~~~~
+~~~~~~
aaa
~~~ ~~
.
@@ -1416,10 +1413,10 @@ need not match that of the opening fence:
</code></pre>
Fenced code blocks can interrupt paragraphs, and can be followed +
Fenced code blocks can interrupt paragraphs, and can be followed directly by paragraphs, without a blank line between:
foo
+foo
```
bar
```
@@ -1431,10 +1428,10 @@ directly by paragraphs, without a blank line between:
<p>baz</p>
Other blocks can also occur before and after fenced code blocks +
Other blocks can also occur before and after fenced code blocks without an intervening blank line:
foo
+foo
---
~~~
bar
@@ -1447,14 +1444,14 @@ without an intervening blank line:
<h1>baz</h1>
An [info string] can be provided after the opening code fence. +
An [info string] can be provided after the opening code fence.
Although this spec doesn't mandate any particular treatment of
the info string, the first word is typically used to specify
the language of the code block. In HTML output, the language is
normally indicated by adding a class to the code element consisting
of language- followed by the language name.
```ruby
+```ruby
def foo(x)
return 3
end
@@ -1467,7 +1464,7 @@ of language- followed by the language name.
~~~~ ruby startline=3 $%@#$
+~~~~ ruby startline=3 $%@#$
def foo(x)
return 3
end
@@ -1480,24 +1477,24 @@ of language- followed by the language name.
````;
+````;
````
.
<pre><code class="language-;"></code></pre>
[Info strings] for backtick code blocks cannot contain backticks:
+[Info strings] for backtick code blocks cannot contain backticks:
``` aa ```
+``` aa ```
foo
.
<p><code>aa</code>
foo</p>
[Info strings] for tilde code blocks can contain backticks and tildes:
+[Info strings] for tilde code blocks can contain backticks and tildes:
~~~ aa ``` ~~~
+~~~ aa ``` ~~~
foo
~~~
.
@@ -1505,9 +1502,9 @@ of language- followed by the language name.
</code></pre>
Closing code fences cannot have [info strings]:
+Closing code fences cannot have [info strings]:
```
+```
``` aaa
```
.
@@ -1515,11 +1512,11 @@ of language- followed by the language name.
</code></pre>
An HTML block is a group of lines that is treated +
An HTML block is a group of lines that is treated as raw HTML (and will not be escaped in HTML output).
-There are seven kinds of [HTML block], which can be defined by their +
There are seven kinds of [HTML block], which can be defined by their start and end conditions. The block begins with a line that meets a start condition (after up to three spaces optional indentation). It ends with the first subsequent line that meets a matching end @@ -1528,35 +1525,35 @@ the container block containing the current HTML block, if no line is encountered that meets the [end condition]. If the first line meets both the [start condition] and the [end condition], the block will contain just that line.
-Start condition: line begins with the string <script,
+
Start condition: line begins with the string <script,
<pre, or <style (case-insensitive), followed by whitespace,
the string >, or the end of the line.
End condition: line contains an end tag
</script>, </pre>, or </style> (case-insensitive; it
need not match the start tag).
Start condition: line begins with the string <!--.
+
Start condition: line begins with the string <!--.
End condition: line contains the string -->.
Start condition: line begins with the string <?.
+
Start condition: line begins with the string <?.
End condition: line contains the string ?>.
Start condition: line begins with the string <!
+
Start condition: line begins with the string <!
followed by an uppercase ASCII letter.
End condition: line contains the character >.
Start condition: line begins with the string +
Start condition: line begins with the string
<![CDATA[.
End condition: line contains the string ]]>.
Start condition: line begins the string < or </
+
Start condition: line begins the string < or </
followed by one of the strings (case-insensitive) address,
article, aside, base, basefont, blockquote, body,
caption, center, col, colgroup, dd, details, dialog,
@@ -1571,25 +1568,25 @@ by [whitespace], the end of the line, the string >, or
the string />.
End condition: line is followed by a [blank line].
Start condition: line begins with a complete [open tag] +
Start condition: line begins with a complete [open tag]
(with any [tag name] other than script,
style, or pre) or a complete [closing tag],
followed only by [whitespace] or the end of the line.
End condition: line is followed by a [blank line].
HTML blocks continue until they are closed by their appropriate +
HTML blocks continue until they are closed by their appropriate [end condition], or the last line of the document or other container block. This means any HTML within an HTML block that might otherwise be recognised as a start condition will be ignored by the parser and passed through as-is, without changing the parser's state.
-For instance, <pre> within a HTML block started by <table> will not affect
+
For instance, <pre> within a HTML block started by <table> will not affect
the parser state; as the HTML block was started in by start condition 6, it
will end at any blank line. This can be surprising:
<table><tr><td>
+<table><tr><td>
<pre>
**Hello**,
@@ -1605,17 +1602,17 @@ will end at any blank line. This can be surprising:
</td></tr></table>
In this case, the HTML block is terminated by the newline — the **Hello**
+
In this case, the HTML block is terminated by the newline — the **Hello**
text remains verbatim — and regular parsing resumes, with a paragraph,
emphasised world and inline and block HTML following.
All types of [HTML blocks] except type 7 may interrupt +
All types of [HTML blocks] except type 7 may interrupt a paragraph. Blocks of type 7 may not interrupt a paragraph. (This restriction is intended to prevent unwanted interpretation of long tags inside a wrapped paragraph as starting HTML blocks.)
-Some simple examples follow. Here are some basic HTML blocks +
Some simple examples follow. Here are some basic HTML blocks of type 6:
<table>
+<table>
<tr>
<td>
hi
@@ -1636,7 +1633,7 @@ of type 6:
<div>
+ <div>
*hello*
<foo><a>
.
@@ -1645,18 +1642,18 @@ of type 6:
<foo><a>
A block can also start with a closing tag:
+A block can also start with a closing tag:
</div>
+</div>
*foo*
.
</div>
*foo*
Here we have two HTML blocks with a Markdown paragraph between them:
+Here we have two HTML blocks with a Markdown paragraph between them:
<DIV CLASS="foo">
+<DIV CLASS="foo">
*Markdown*
@@ -1667,10 +1664,10 @@ of type 6:
</DIV>
The tag on the first line can be partial, as long +
The tag on the first line can be partial, as long as it is split where there would be whitespace:
<div id="foo"
+<div id="foo"
class="bar">
</div>
.
@@ -1680,7 +1677,7 @@ as it is split where there would be whitespace:
<div id="foo" class="bar
+<div id="foo" class="bar
baz">
</div>
.
@@ -1689,9 +1686,9 @@ as it is split where there would be whitespace:
</div>
An open tag need not be closed:
+An open tag need not be closed:
<div>
+<div>
*foo*
*bar*
@@ -1701,10 +1698,10 @@ as it is split where there would be whitespace:
<p><em>bar</em></p>
A partial tag need not even be completed (garbage +
A partial tag need not even be completed (garbage in, garbage out):
<div id="foo"
+<div id="foo"
*hi*
.
<div id="foo"
@@ -1712,33 +1709,33 @@ in, garbage out):
<div class
+<div class
foo
.
<div class
foo
The initial tag doesn't even need to be a valid +
The initial tag doesn't even need to be a valid tag, as long as it starts like one:
<div *???-&&&-<---
+<div *???-&&&-<---
*foo*
.
<div *???-&&&-<---
*foo*
In type 6 blocks, the initial tag need not be on a line by +
In type 6 blocks, the initial tag need not be on a line by itself:
<div><a href="bar">*foo*</a></div>
+<div><a href="bar">*foo*</a></div>
.
<div><a href="bar">*foo*</a></div>
<table><tr><td>
+<table><tr><td>
foo
</td></tr></table>
.
@@ -1747,13 +1744,13 @@ itself:
</td></tr></table>
Everything until the next blank line or end of document +
Everything until the next blank line or end of document gets included in the HTML block. So, in the following example, what looks like a Markdown code block is actually part of the HTML block, which continues until a blank line or the end of the document is reached:
<div></div>
+<div></div>
``` c
int x = 33;
```
@@ -1764,11 +1761,11 @@ line or the end of the document is reached:
```
To start an [HTML block] with a tag that is not in the +
To start an [HTML block] with a tag that is not in the list of block-level tags in (6), you must put the tag by itself on the first line (and it must be complete):
<a href="foo">
+<a href="foo">
*bar*
</a>
.
@@ -1777,9 +1774,9 @@ itself on the first line (and it must be complete):
</a>
In type 7 blocks, the [tag name] can be anything:
+In type 7 blocks, the [tag name] can be anything:
<Warning>
+<Warning>
*bar*
</Warning>
.
@@ -1789,7 +1786,7 @@ itself on the first line (and it must be complete):
<i class="foo">
+<i class="foo">
*bar*
</i>
.
@@ -1799,20 +1796,20 @@ itself on the first line (and it must be complete):
</ins>
+</ins>
*bar*
.
</ins>
*bar*
These rules are designed to allow us to work with tags that +
These rules are designed to allow us to work with tags that
can function as either block-level or inline-level tags.
The <del> tag is a nice example. We can surround content with
<del> tags in three different ways. In this case, we get a raw
HTML block, because the <del> tag is on a line by itself:
<del>
+<del>
*foo*
</del>
.
@@ -1821,11 +1818,11 @@ HTML block, because the <del> tag is on a line by itself:
</del>
In this case, we get a raw HTML block that just includes +
In this case, we get a raw HTML block that just includes
the <del> tag (because it ends with the following blank
line). So the contents get interpreted as CommonMark:
<del>
+<del>
*foo*
@@ -1836,25 +1833,25 @@ line). So the contents get interpreted as CommonMark:
</del>
Finally, in this case, the <del> tags are interpreted
+
Finally, in this case, the <del> tags are interpreted
as [raw HTML] inside the CommonMark paragraph. (Because
the tag is not on a line by itself, we get inline HTML
rather than an [HTML block].)
<del>*foo*</del>
+<del>*foo*</del>
.
<p><del><em>foo</em></del></p>
HTML tags designed to contain literal content +
HTML tags designed to contain literal content
(script, style, pre), comments, processing instructions,
and declarations are treated somewhat differently.
Instead of ending at the first blank line, these blocks
end at the first line containing a corresponding end tag.
As a result, these blocks can contain blank lines:
A pre tag (type 1):
+A pre tag (type 1):
<pre language="haskell"><code>
+<pre language="haskell"><code>
import Text.HTML.TagSoup
main :: IO ()
@@ -1871,9 +1868,9 @@ As a result, these blocks can contain blank lines:
<p>okay</p>
A script tag (type 1):
+A script tag (type 1):
<script type="text/javascript">
+<script type="text/javascript">
// JavaScript example
document.getElementById("demo").innerHTML = "Hello JavaScript!";
@@ -1888,9 +1885,9 @@ As a result, these blocks can contain blank lines:
<p>okay</p>
A style tag (type 1):
+A style tag (type 1):
<style
+<style
type="text/css">
h1 {color:red;}
@@ -1907,11 +1904,11 @@ As a result, these blocks can contain blank lines:
<p>okay</p>
If there is no matching end tag, the block will end at the +
If there is no matching end tag, the block will end at the end of the document (or the enclosing [block quote][block quotes] or [list item][list items]):
<style
+<style
type="text/css">
foo
@@ -1923,7 +1920,7 @@ or [list item][list items]):
> <div>
+> <div>
> foo
bar
@@ -1936,7 +1933,7 @@ or [list item][list items]):
- <div>
+- <div>
- foo
.
<ul>
@@ -1947,9 +1944,9 @@ or [list item][list items]):
</ul>
The end tag can occur on the same line as the start tag:
+The end tag can occur on the same line as the start tag:
<style>p{color:red;}</style>
+<style>p{color:red;}</style>
*foo*
.
<style>p{color:red;}</style>
@@ -1957,17 +1954,17 @@ or [list item][list items]):
<!-- foo -->*bar*
+<!-- foo -->*bar*
*baz*
.
<!-- foo -->*bar*
<p><em>baz</em></p>
Note that anything on the last line after the +
Note that anything on the last line after the end tag will be included in the [HTML block]:
<script>
+<script>
foo
</script>1. *bar*
.
@@ -1976,9 +1973,9 @@ end tag will be included in the [HTML block]:
</script>1. *bar*
A comment (type 2):
+A comment (type 2):
<!-- Foo
+<!-- Foo
bar
baz -->
@@ -1991,9 +1988,9 @@ end tag will be included in the [HTML block]:
<p>okay</p>
A processing instruction (type 3):
+A processing instruction (type 3):
<?php
+<?php
echo '>';
@@ -2008,16 +2005,16 @@ end tag will be included in the [HTML block]:
<p>okay</p>
A declaration (type 4):
+A declaration (type 4):
<!DOCTYPE html>
+<!DOCTYPE html>
.
<!DOCTYPE html>
CDATA (type 5):
+CDATA (type 5):
<![CDATA[
+<![CDATA[
function matchwo(a,b)
{
if (a < b && a < 0) then {
@@ -2046,9 +2043,9 @@ end tag will be included in the [HTML block]:
<p>okay</p>
The opening tag can be indented 1-3 spaces, but not 4:
+The opening tag can be indented 1-3 spaces, but not 4:
<!-- foo -->
+ <!-- foo -->
<!-- foo -->
.
@@ -2058,7 +2055,7 @@ end tag will be included in the [HTML block]:
<div>
+ <div>
<div>
.
@@ -2067,10 +2064,10 @@ end tag will be included in the [HTML block]:
</code></pre>
An HTML block of types 1--6 can interrupt a paragraph, and need not be +
An HTML block of types 1--6 can interrupt a paragraph, and need not be preceded by a blank line.
Foo
+Foo
<div>
bar
</div>
@@ -2081,11 +2078,11 @@ preceded by a blank line.
</div>
However, a following blank line is needed, except at the end of +
However, a following blank line is needed, except at the end of a document, and except for blocks of types 1--5, [above][HTML block]:
<div>
+<div>
bar
</div>
*foo*
@@ -2096,9 +2093,9 @@ block]:
*foo*
HTML blocks of type 7 cannot interrupt a paragraph:
+HTML blocks of type 7 cannot interrupt a paragraph:
Foo
+Foo
<a href="bar">
baz
.
@@ -2107,25 +2104,25 @@ block]:
baz</p>
This rule differs from John Gruber's original Markdown syntax +
This rule differs from John Gruber's original Markdown syntax specification, which says:
--The only restrictions are that block-level HTML elements — +
+-The only restrictions are that block-level HTML elements — e.g.
<div>,<table>,<pre>,<p>, etc. — must be separated from surrounding content by blank lines, and the start and end tags of the block should not be indented with tabs or spaces.In some ways Gruber's rule is more restrictive than the one given +
In some ways Gruber's rule is more restrictive than the one given here:
--
- It requires that an HTML block be preceded by a blank line.
-- It does not allow the start tag to be indented.
-- It requires a matching end tag, which it also does not allow to +
+
-- It requires that an HTML block be preceded by a blank line.
+- It does not allow the start tag to be indented.
+- It requires a matching end tag, which it also does not allow to be indented.
Most Markdown implementations (including some of Gruber's own) do not +
Most Markdown implementations (including some of Gruber's own) do not respect all of these restrictions.
-There is one respect, however, in which Gruber's rule is more liberal +
There is one respect, however, in which Gruber's rule is more liberal than the one given here, since it allows blank lines to occur inside an HTML block. There are two reasons for disallowing them here. First, it removes the need to parse balanced tags, which is @@ -2133,9 +2130,9 @@ expensive and can require backtracking from the end of the document if no matching end tag is found. Second, it provides a very simple and flexible way of including Markdown content inside HTML tags: simply separate the Markdown from the HTML using blank lines:
-Compare:
+Compare:
-<div> +<div> *Emphasized* text. @@ -2147,7 +2144,7 @@ simply separate the Markdown from the HTML using blank lines:<div> +<div> *Emphasized* text. </div> . @@ -2156,17 +2153,17 @@ simply separate the Markdown from the HTML using blank lines: </div>Some Markdown implementations have adopted a convention of +
Some Markdown implementations have adopted a convention of interpreting content inside tags as text if the open tag has the attribute
-markdown=1. The rule given above seems a simpler and more elegant way of achieving the same expressive power, which is also much simpler to parse.The main potential drawback is that one can no longer paste HTML +
The main potential drawback is that one can no longer paste HTML blocks into Markdown documents with 100% reliability. However, in most cases this will work fine, because the blank lines in HTML are usually followed by HTML block tags. For example:
--<table> +<table> <tr> @@ -2187,11 +2184,11 @@ HTML are usually followed by HTML block tags. For example: </table>There are problems, however, if the inner tags are indented +
There are problems, however, if the inner tags are indented and separated by spaces, as then they will be interpreted as an indented code block:
--<table> +<table> <tr> @@ -2213,13 +2210,13 @@ an indented code block: </table>Fortunately, blank lines are usually not necessary and can be +
Fortunately, blank lines are usually not necessary and can be deleted. The exception is inside
-<pre>tags, but as described [above][HTML blocks], raw HTML blocks starting with<pre>can contain blank lines.+
Link reference definitions
-A link reference definition consists of a [link label], indented up to three spaces, followed by a colon (
-:), optional [whitespace] (including up to one [line ending]), a [link destination], @@ -2228,14 +2225,14 @@ optional [whitespace] (including up to one title], which if it is present must be separated from the [link destination] by [whitespace]. No further [non-whitespace characters] may occur on the line.A [link reference definition] +
A [link reference definition] does not correspond to a structural element of a document. Instead, it defines a label which can be used in [reference links] and reference-style [images] elsewhere in the document. [Link reference definitions] can come either before or after the links that use them.
-[foo]: /url "title" +[foo]: /url "title" [foo] . @@ -2243,7 +2240,7 @@ them.[foo]: +[foo]: /url 'the title' @@ -2253,7 +2250,7 @@ them.[Foo*bar\]]:my_(url) 'title (with parens)' +[Foo*bar\]]:my_(url) 'title (with parens)' [Foo*bar\]] . @@ -2261,7 +2258,7 @@ them.[Foo bar]: +[Foo bar]: <my url> 'title' @@ -2270,9 +2267,9 @@ them. <p><a href="my%20url" title="title">Foo bar</a></p>The title may extend over multiple lines:
+The title may extend over multiple lines:
--[foo]: /url ' +[foo]: /url ' title line1 line2 @@ -2287,9 +2284,9 @@ them. ">foo</a></p>However, it may not contain a [blank line]:
+However, it may not contain a [blank line]:
--[foo]: /url 'title +[foo]: /url 'title with blank line' @@ -2300,9 +2297,9 @@ them. <p>[foo]</p>The title may be omitted:
+The title may be omitted:
--[foo]: +[foo]: /url [foo] @@ -2310,9 +2307,9 @@ them. <p><a href="/url">foo</a></p>The link destination may not be omitted:
+The link destination may not be omitted:
--[foo]: +[foo]: [foo] . @@ -2320,20 +2317,20 @@ them. <p>[foo]</p>However, an empty link destination may be specified using +
However, an empty link destination may be specified using angle brackets:
--[foo]: <> +[foo]: <> [foo] . <p><a href="">foo</a></p>The title must be separated from the link destination by +
The title must be separated from the link destination by whitespace:
--[foo]: <bar>(baz) +[foo]: <bar>(baz) [foo] . @@ -2341,29 +2338,29 @@ whitespace: <p>[foo]</p>Both title and destination can contain backslash escapes +
Both title and destination can contain backslash escapes and literal backslashes:
--[foo]: /url\bar\*baz "foo\"bar\baz" +[foo]: /url\bar\*baz "foo\"bar\baz" [foo] . <p><a href="/url%5Cbar*baz" title="foo"bar\baz">foo</a></p>A link can come before its corresponding definition:
+A link can come before its corresponding definition:
--[foo] +[foo] [foo]: url . <p><a href="url">foo</a></p>If there are several matching definitions, the first one takes +
If there are several matching definitions, the first one takes precedence:
--[foo] +[foo] [foo]: first [foo]: second @@ -2371,10 +2368,10 @@ precedence: <p><a href="first">foo</a></p>As noted in the section on [Links], matching of labels is +
As noted in the section on [Links], matching of labels is case-insensitive (see [matches]).
-[FOO]: /url +[FOO]: /url [Foo] . @@ -2382,23 +2379,23 @@ case-insensitive (see [matches]).[ΑΓΩ]: /φου +[ΑΓΩ]: /φου [αγω] . <p><a href="/%CF%86%CE%BF%CF%85">αγω</a></p>Here is a link reference definition with no corresponding link. +
Here is a link reference definition with no corresponding link. It contributes nothing to the document.
--[foo]: /url +[foo]: /url .Here is another one:
+Here is another one:
--[ +[ foo ]: /url bar @@ -2406,26 +2403,26 @@ It contributes nothing to the document. <p>bar</p>This is not a link reference definition, because there are +
This is not a link reference definition, because there are [non-whitespace characters] after the title:
--[foo]: /url "title" ok +[foo]: /url "title" ok . <p>[foo]: /url "title" ok</p>This is a link reference definition, but it has no title:
+This is a link reference definition, but it has no title:
--[foo]: /url +[foo]: /url "title" ok . <p>"title" ok</p>This is not a link reference definition, because it is indented +
This is not a link reference definition, because it is indented four spaces:
--[foo]: /url "title" +[foo]: /url "title" [foo] . @@ -2434,10 +2431,10 @@ four spaces: <p>[foo]</p>This is not a link reference definition, because it occurs inside +
This is not a link reference definition, because it occurs inside a code block:
--``` +``` [foo]: /url ``` @@ -2448,9 +2445,9 @@ a code block: <p>[foo]</p>A [link reference definition] cannot interrupt a paragraph.
+A [link reference definition] cannot interrupt a paragraph.
--Foo +Foo [bar]: /baz [bar] @@ -2460,10 +2457,10 @@ a code block: <p>[bar]</p>However, it can directly follow other block elements, such as headings +
However, it can directly follow other block elements, such as headings and thematic breaks, and it need not be followed by a blank line.
-# [Foo] +# [Foo] [foo]: /url > bar . @@ -2474,7 +2471,7 @@ and thematic breaks, and it need not be followed by a blank line.[foo]: /url +[foo]: /url bar === [foo] @@ -2484,7 +2481,7 @@ and thematic breaks, and it need not be followed by a blank line.[foo]: /url +[foo]: /url === [foo] . @@ -2492,10 +2489,10 @@ and thematic breaks, and it need not be followed by a blank line. <a href="/url">foo</a></p>Several [link reference definitions] +
Several [link reference definitions] can occur one after another, without intervening blank lines.
--[foo]: /foo-url "foo" +[foo]: /foo-url "foo" [bar]: /bar-url "bar" [baz]: /baz-url @@ -2509,12 +2506,12 @@ can occur one after another, without intervening blank lines. <a href="/baz-url">baz</a></p>[Link reference definitions] can occur +
[Link reference definitions] can occur inside block containers, like lists and block quotations. They affect the entire document, not just the container in which they are defined:
--[foo] +[foo] > [foo]: /url . @@ -2523,27 +2520,27 @@ are defined: </blockquote>Whether something is a [link reference definition] is +
Whether something is a [link reference definition] is independent of whether the link reference it defines is used in the document. Thus, for example, the following document contains just a link reference definition, and no visible content:
--[foo]: /url +[foo]: /url .+
Paragraphs
-A sequence of non-blank lines that cannot be interpreted as other +
A sequence of non-blank lines that cannot be interpreted as other kinds of blocks forms a paragraph. The contents of the paragraph are the result of parsing the paragraph's raw content as inlines. The paragraph's raw content is formed by concatenating the lines and removing initial and final [whitespace].
-A simple example with two paragraphs:
+A simple example with two paragraphs:
--aaa +aaa bbb . @@ -2551,9 +2548,9 @@ is formed by concatenating the lines and removing initial and final <p>bbb</p>Paragraphs can contain multiple lines, but no blank lines:
+Paragraphs can contain multiple lines, but no blank lines:
--aaa +aaa bbb ccc @@ -2565,9 +2562,9 @@ is formed by concatenating the lines and removing initial and final ddd</p>Multiple blank lines between paragraph have no effect:
+Multiple blank lines between paragraph have no effect:
--aaa +aaa bbb @@ -2576,19 +2573,19 @@ is formed by concatenating the lines and removing initial and final <p>bbb</p>Leading spaces are skipped:
+Leading spaces are skipped:
--aaa +aaa bbb . <p>aaa bbb</p>Lines after the first may be indented any amount, since indented +
Lines after the first may be indented any amount, since indented code blocks cannot interrupt paragraphs.
--aaa +aaa bbb ccc . @@ -2597,10 +2594,10 @@ code blocks cannot interrupt paragraphs. ccc</p>However, the first line may be indented at most three spaces, +
However, the first line may be indented at most three spaces, or an indented code block will be triggered:
-aaa +aaa bbb . <p>aaa @@ -2608,7 +2605,7 @@ or an indented code block will be triggered:aaa +aaa bbb . <pre><code>aaa @@ -2616,25 +2613,25 @@ or an indented code block will be triggered: <p>bbb</p>Final spaces are stripped before inline parsing, so a paragraph +
Final spaces are stripped before inline parsing, so a paragraph that ends with two or more spaces will not end with a [hard line break]:
--aaa +aaa bbb . <p>aaa<br /> bbb</p>+
Blank lines
-[Blank lines] between block-level elements are ignored, +
[Blank lines] between block-level elements are ignored, except for the role they play in determining whether a [list] is [tight] or [loose].
-Blank lines at the beginning and end of the document are also ignored.
+Blank lines at the beginning and end of the document are also ignored.
-+aaa @@ -2648,23 +2645,23 @@ is [tight] or [loose].+
Tables (extension)
-GFM enables the
tableextension, where an additional leaf block type is +GFM enables the
-tableextension, where an additional leaf block type is available.A table is an arrangement of data with rows and columns, consisting of a +
A table is an arrangement of data with rows and columns, consisting of a single header row, a [delimiter row] separating the header from the data, and zero or more data rows.
-Each row consists of cells containing arbitrary text, in which [inlines] are +
Each row consists of cells containing arbitrary text, in which [inlines] are parsed, separated by pipes (
-|). A leading and trailing pipe is also recommended for clarity of reading, and if there's otherwise parsing ambiguity. Spaces between pipes and cell content are trimmed. Block-level elements cannot be inserted in a table.The delimiter row consists of cells whose only content are hyphens (
-), +The delimiter row consists of cells whose only content are hyphens (
-), and optionally, a leading or trailing colon (:), or both, to indicate left, right, or center alignment respectively.--| foo | bar | +| foo | bar | | --- | --- | | baz | bim | . @@ -2684,10 +2681,10 @@ right, or center alignment respectively. </table>Cells in one column don't need to match length, though it's easier to read if +
Cells in one column don't need to match length, though it's easier to read if they are. Likewise, use of leading and trailing pipes may be inconsistent:
--| abc | defghi | +| abc | defghi | :-: | -----------: bar | baz . @@ -2707,10 +2704,10 @@ they are. Likewise, use of leading and trailing pipes may be inconsistent: </table>Include a pipe in a cell's content by escaping it, including inside other +
Include a pipe in a cell's content by escaping it, including inside other inline spans:
--| f\|oo | +| f\|oo | | ------ | | b `\|` az | | b **\|** im | @@ -2732,10 +2729,10 @@ inline spans: </table>The table is broken at the first empty line, or beginning of another +
The table is broken at the first empty line, or beginning of another block-level structure:
-| abc | def | +| abc | def | | --- | --- | | bar | baz | > bar @@ -2760,7 +2757,7 @@ block-level structure:| abc | def | +| abc | def | | --- | --- | | bar | baz | bar @@ -2788,10 +2785,10 @@ block-level structure: <p>bar</p>The header row must match the [delimiter row] in the number of cells. If not, +
The header row must match the [delimiter row] in the number of cells. If not, a table will not be recognized:
--| abc | def | +| abc | def | | --- | | bar | . @@ -2800,11 +2797,11 @@ a table will not be recognized: | bar |</p>The remainder of the table's rows may vary in the number of cells. If there +
The remainder of the table's rows may vary in the number of cells. If there are a number of cells fewer than the number of cells in the header row, empty cells are inserted. If there are greater, the excess is ignored:
--| abc | def | +| abc | def | | --- | --- | | bar | | bar | baz | boo | @@ -2829,9 +2826,9 @@ cells are inserted. If there are greater, the excess is ignored: </table>If there are no rows in the body, no
+<tbody>is generated in HTML output:If there are no rows in the body, no
<tbody>is generated in HTML output:-| abc | def | +| abc | def | | --- | --- | . <table> @@ -2845,39 +2842,39 @@ cells are inserted. If there are greater, the excess is ignored:+
Container blocks
-A container block is a block that has other +
A container block is a block that has other blocks as its contents. There are two basic kinds of container blocks: [block quotes] and [list items]. [Lists] are meta-containers for [list items].
-We define the syntax for container blocks recursively. The general +
We define the syntax for container blocks recursively. The general form of the definition is:
--If X is a sequence of blocks, then the result of +
+-If X is a sequence of blocks, then the result of transforming X in such-and-such a way is a container of type Y with these blocks as its content.
So, we explain what counts as a block quote or list item by explaining +
So, we explain what counts as a block quote or list item by explaining how these can be generated from their contents. This should suffice to define the syntax, although it does not give a recipe for parsing these constructions. (A recipe is provided below in the section entitled A parsing strategy.)
-+
Block quotes
-A block quote marker consists of 0-3 spaces of initial indent, plus (a) the character
->together with a following space, or (b) a single character>not followed by a space.The following rules define [block quotes]:
--
- -
Basic case. If a string of lines Ls constitute a sequence +
The following rules define [block quotes]:
++
-- +
-Basic case. If a string of lines Ls constitute a sequence of blocks Bs, then the result of prepending a [block quote marker] to the beginning of each line in Ls is a block quote containing Bs.
- -
Laziness. If a string of lines Ls constitute a block +
- +
-Laziness. If a string of lines Ls constitute a block quote with contents Bs, then the result of deleting the initial [block quote marker] from one or more lines in which the next [non-whitespace character] after the [block @@ -2887,15 +2884,15 @@ text] is a block quote with Bs as its content. that will be parsed as part of the content of a paragraph, but does not occur at the beginning of the paragraph.
- -
Consecutiveness. A document cannot contain two [block +
- +
Consecutiveness. A document cannot contain two [block quotes] in a row unless there is a [blank line] between them.
Nothing else counts as a block quote.
-Here is a simple example:
+Nothing else counts as a block quote.
+Here is a simple example:
--> # Foo +> # Foo > bar > baz . @@ -2906,9 +2903,9 @@ quotes] in a row unless there is a [blank line] between them. </blockquote>The spaces after the
+>characters can be omitted:The spaces after the
>characters can be omitted:--># Foo +># Foo >bar > baz . @@ -2919,9 +2916,9 @@ quotes] in a row unless there is a [blank line] between them. </blockquote>The
+>characters can be indented 1-3 spaces:The
>characters can be indented 1-3 spaces:--> # Foo +> # Foo > bar > baz . @@ -2932,9 +2929,9 @@ quotes] in a row unless there is a [blank line] between them. </blockquote>Four spaces gives us a code block:
+Four spaces gives us a code block:
--> # Foo +> # Foo > bar > baz . @@ -2944,10 +2941,10 @@ quotes] in a row unless there is a [blank line] between them. </code></pre>The Laziness clause allows us to omit the
>before +The Laziness clause allows us to omit the
>before [paragraph continuation text]:--> # Foo +> # Foo > bar baz . @@ -2958,10 +2955,10 @@ quotes] in a row unless there is a [blank line] between them. </blockquote>A block quote can contain some lazy and some non-lazy +
A block quote can contain some lazy and some non-lazy continuation lines:
--> bar +> bar baz > foo . @@ -2972,17 +2969,17 @@ continuation lines: </blockquote>Laziness only applies to lines that would have been continuations of +
Laziness only applies to lines that would have been continuations of paragraphs had they been prepended with [block quote markers]. For example, the
>cannot be omitted in the second line of--> foo +> foo > ---without changing the meaning:
+without changing the meaning:
--> foo +> foo --- . <blockquote> @@ -2991,15 +2988,15 @@ For example, the>cannot be omitted in the second line of <hr />Similarly, if we omit the
+>in the second line ofSimilarly, if we omit the
>in the second line of--> - foo +> - foo > - barthen the block quote ends after the first line:
+then the block quote ends after the first line:
--> - foo +> - foo - bar . <blockquote> @@ -3012,10 +3009,10 @@ For example, the>cannot be omitted in the second line of </ul>For the same reason, we can't omit the
>in front of +For the same reason, we can't omit the
>in front of subsequent lines of an indented or fenced code block:-> foo +> foo bar . <blockquote> @@ -3027,7 +3024,7 @@ subsequent lines of an indented or fenced code block:> ``` +> ``` foo ``` . @@ -3038,10 +3035,10 @@ subsequent lines of an indented or fenced code block: <pre><code></code></pre>Note that in the following case, we have a [lazy +
Note that in the following case, we have a [lazy continuation line]:
--> foo +> foo - bar . <blockquote> @@ -3050,25 +3047,25 @@ continuation line]: </blockquote>To see why, note that in
+To see why, note that in
--> foo +> foo > - barthe
- baris indented too far to start a list, and can't +the
-- baris indented too far to start a list, and can't be an indented code block because indented code blocks cannot interrupt paragraphs, so it is [paragraph continuation text].A block quote can be empty:
+A block quote can be empty:
-> +> . <blockquote> </blockquote>> +> > > . @@ -3076,9 +3073,9 @@ interrupt paragraphs, so it is [paragraph continuation text]. </blockquote>A block quote can have initial or final blank lines:
+A block quote can have initial or final blank lines:
--> +> > foo > . @@ -3087,9 +3084,9 @@ interrupt paragraphs, so it is [paragraph continuation text]. </blockquote>A blank line always separates block quotes:
+A blank line always separates block quotes:
--> foo +> foo > bar . @@ -3101,14 +3098,14 @@ interrupt paragraphs, so it is [paragraph continuation text]. </blockquote>(Most current Markdown implementations, including John Gruber's +
(Most current Markdown implementations, including John Gruber's original
-Markdown.pl, will parse this example as a single block quote with two paragraphs. But it seems better to allow the author to decide whether two block quotes or one are wanted.)Consecutiveness means that if we put these block quotes together, +
Consecutiveness means that if we put these block quotes together, we get a single block quote:
--> foo +> foo > bar . <blockquote> @@ -3117,9 +3114,9 @@ we get a single block quote: </blockquote>To get a block quote with two paragraphs, use:
+To get a block quote with two paragraphs, use:
--> foo +> foo > > bar . @@ -3129,9 +3126,9 @@ we get a single block quote: </blockquote>Block quotes can interrupt paragraphs:
+Block quotes can interrupt paragraphs:
--foo +foo > bar . <p>foo</p> @@ -3140,10 +3137,10 @@ we get a single block quote: </blockquote>In general, blank lines are not needed before or after block +
In general, blank lines are not needed before or after block quotes:
--> aaa +> aaa *** > bbb . @@ -3156,10 +3153,10 @@ quotes: </blockquote>However, because of laziness, a blank line is needed between +
However, because of laziness, a blank line is needed between a block quote and a following paragraph:
-> bar +> bar baz . <blockquote> @@ -3169,7 +3166,7 @@ a block quote and a following paragraph:> bar +> bar baz . @@ -3180,7 +3177,7 @@ a block quote and a following paragraph:> bar +> bar > baz . @@ -3190,11 +3187,11 @@ a block quote and a following paragraph: <p>baz</p>It is a consequence of the Laziness rule that any number +
It is a consequence of the Laziness rule that any number of initial
>s may be omitted on a continuation line of a nested block quote:-> > > foo +> > > foo bar . <blockquote> @@ -3208,7 +3205,7 @@ nested block quote:>>> foo +>>> foo > bar >>baz . @@ -3223,12 +3220,12 @@ nested block quote: </blockquote>When including an indented code block in a block quote, +
When including an indented code block in a block quote, remember that the [block quote marker] includes both the
>and a following space. So five spaces are needed after the>:--> code +> code > not code . @@ -3241,21 +3238,21 @@ the>: </blockquote>+
List items
-A list marker is a +
A list marker is a [bullet list marker] or an [ordered list marker].
-A bullet list marker is a
--,+, or*character.An ordered list marker +
An ordered list marker is a sequence of 1--9 arabic digits (
-0-9), followed by either a.character or a)character. (The reason for the length limit is that with 10 digits we start seeing integer overflows in some browsers.)The following rules define [list items]:
--
- -
Basic case. If a sequence of lines Ls constitute a sequence of +
The following rules define [list items]:
++
- +
Basic case. If a sequence of lines Ls constitute a sequence of blocks Bs starting with a [non-whitespace character], and M is a list marker of width W followed by 1 ≤ N ≤ 4 spaces, then the result of prepending M and the following spaces to the first line of @@ -3264,21 +3261,21 @@ list item with Bs as its contents. The type of the list item (bullet or ordered) is determined by the type of its list marker. If the list item is ordered, then it is also assigned a start number, based on the ordered list marker.
-Exceptions:
--
-- When the first list item in a [list] interrupts +
Exceptions:
++
- When the first list item in a [list] interrupts a paragraph---that is, when it starts on a line that would otherwise count as [paragraph continuation text]---then (a) the lines Ls must not begin with a blank line, and (b) if the list item is ordered, the start number must be 1.
-- If any line is a [thematic break][thematic breaks] then +
- If any line is a [thematic break][thematic breaks] then that line is not a list item.
For example, let Ls be the lines
+For example, let Ls be the lines
--A paragraph +A paragraph with two lines. indented code @@ -3294,11 +3291,11 @@ that line is not a list item. </blockquote>And let M be the marker
1., and N = 2. Then rule #1 says +And let M be the marker
1., and N = 2. Then rule #1 says that the following is an ordered list item with start number 1, and the same contents as Ls:--1. A paragraph +1. A paragraph with two lines. indented code @@ -3318,17 +3315,17 @@ and the same contents as Ls: </ol>The most important thing to notice is that the position of +
The most important thing to notice is that the position of the text after the list marker determines how much indentation is needed in subsequent blocks in the list item. If the list marker takes up two spaces, and there are three spaces between the list marker and the next [non-whitespace character], then blocks must be indented five spaces in order to fall under the list item.
-Here are some examples showing how far content must be indented to be +
Here are some examples showing how far content must be indented to be put under the list item:
-- one +- one two . @@ -3339,7 +3336,7 @@ put under the list item:- one +- one two . @@ -3352,7 +3349,7 @@ put under the list item:- one +- one two . @@ -3364,7 +3361,7 @@ put under the list item:- one +- one two . @@ -3376,7 +3373,7 @@ put under the list item: </ul>It is tempting to think of this in terms of columns: the continuation +
It is tempting to think of this in terms of columns: the continuation blocks must be indented at least to the column of the first [non-whitespace character] after the list marker. However, that is not quite right. The spaces after the list marker determine how much relative indentation @@ -3384,7 +3381,7 @@ is needed. Which column this indentation reaches will depend on how the list item is embedded in other constructions, as shown by this example:
--> > 1. one +> > 1. one >> >> two . @@ -3400,15 +3397,15 @@ this example: </blockquote>Here
twooccurs in the same column as the list marker1., +Here
-twooccurs in the same column as the list marker1., but is actually contained in the list item, because there is sufficient indentation after the last containing blockquote marker.The converse is also possible. In the following example, the word
two+The converse is also possible. In the following example, the word
twooccurs far to the right of the initial text of the list item,one, but it is not considered part of the list item, because it is not indented far enough past the blockquote marker:-->>- one +>>- one >> > > two . @@ -3422,10 +3419,10 @@ far enough past the blockquote marker: </blockquote>Note that at least one space is needed between the list marker and +
Note that at least one space is needed between the list marker and any following content, so these are not list items:
---one +-one 2.two . @@ -3433,10 +3430,10 @@ any following content, so these are not list items: <p>2.two</p>A list item may contain blocks that are separated by more than +
A list item may contain blocks that are separated by more than one blank line.
--- foo +- foo bar @@ -3449,9 +3446,9 @@ one blank line. </ul>A list item may contain any kind of block:
+A list item may contain any kind of block:
--1. foo +1. foo ``` bar @@ -3474,10 +3471,10 @@ one blank line. </ol>A list item that contains an indented code block will preserve +
A list item that contains an indented code block will preserve empty lines within the code block verbatim.
--- Foo +- Foo bar @@ -3496,9 +3493,9 @@ empty lines within the code block verbatim. </ul>Note that ordered list start numbers must be nine digits or less:
+Note that ordered list start numbers must be nine digits or less:
-123456789. ok +123456789. ok . <ol start="123456789"> <li>ok</li> @@ -3506,14 +3503,14 @@ empty lines within the code block verbatim.1234567890. not ok +1234567890. not ok . <p>1234567890. not ok</p>A start number may begin with 0s:
+A start number may begin with 0s:
-0. ok +0. ok . <ol start="0"> <li>ok</li> @@ -3521,22 +3518,22 @@ empty lines within the code block verbatim.003. ok +003. ok . <ol start="3"> <li>ok</li> </ol>A start number may not be negative:
+A start number may not be negative:
---1. not ok +-1. not ok . <p>-1. not ok</p>-
- +
+
-- Item starting with indented code. If a sequence of lines Ls constitute a sequence of blocks Bs starting with an indented code block, and M is a list marker of width W followed by @@ -3548,11 +3545,11 @@ list item (bullet or ordered) is determined by the type of its list marker. If the list item is ordered, then it is also assigned a start number, based on the ordered list marker.
An indented code block will have to be indented four spaces beyond +
An indented code block will have to be indented four spaces beyond the edge of the region where text will be included in the list item. In the following case that is 6 spaces:
--- foo +- foo bar . @@ -3565,9 +3562,9 @@ In the following case that is 6 spaces: </ul>And in this case it is 11 spaces:
+And in this case it is 11 spaces:
--10. foo +10. foo bar . @@ -3580,11 +3577,11 @@ In the following case that is 6 spaces: </ol>If the first block in the list item is an indented code block, +
If the first block in the list item is an indented code block, then by rule #2, the contents must be indented one space after the list marker:
-indented code +indented code paragraph @@ -3598,7 +3595,7 @@ list marker:1. indented code +1. indented code paragraph @@ -3615,10 +3612,10 @@ list marker: </ol>Note that an additional space indent is interpreted as space +
Note that an additional space indent is interpreted as space inside the code block:
--1. indented code +1. indented code paragraph @@ -3635,7 +3632,7 @@ inside the code block: </ol>Note that rules #1 and #2 only apply to two cases: (a) cases +
Note that rules #1 and #2 only apply to two cases: (a) cases in which the lines to be included in a list item begin with a [non-whitespace character], and (b) cases in which they begin with an indented code @@ -3643,7 +3640,7 @@ block. In a case like the following, where the first block begins with a three-space indent, the rules do not allow us to form a list item by indenting the whole thing and prepending a list marker:
-foo +foo bar . @@ -3652,7 +3649,7 @@ indenting the whole thing and prepending a list marker:- foo +- foo bar . @@ -3662,12 +3659,12 @@ indenting the whole thing and prepending a list marker: <p>bar</p>This is not a significant restriction, because when a block begins +
This is not a significant restriction, because when a block begins with 1-3 spaces indent, the indentation can always be removed without a change in interpretation, allowing rule #1 to be applied. So, in the above case:
--- foo +- foo bar . @@ -3679,8 +3676,8 @@ the above case: </ul>-
- +
+
-- Item starting with a blank line. If a sequence of lines Ls starting with a single [blank line] constitute a (possibly empty) sequence of blocks Bs, not separated from each other by more than @@ -3693,9 +3690,9 @@ list item (bullet or ordered) is determined by the type of its list marker. If the list item is ordered, then it is also assigned a start number, based on the ordered list marker.
Here are some list items that start with a blank line but are not empty:
+Here are some list items that start with a blank line but are not empty:
--- +- foo - ``` @@ -3717,10 +3714,10 @@ start number, based on the ordered list marker. </ul>When the list item starts with a blank line, the number of spaces +
When the list item starts with a blank line, the number of spaces following the list marker doesn't change the required indentation:
--- +- foo . <ul> @@ -3728,11 +3725,11 @@ following the list marker doesn't change the required indentation: </ul>A list item can begin with at most one blank line. +
A list item can begin with at most one blank line. In the following example,
foois not part of the list item:--- +- foo . @@ -3742,9 +3739,9 @@ item: <p>foo</p>Here is an empty bullet list item:
+Here is an empty bullet list item:
--- foo +- foo - - bar . @@ -3755,9 +3752,9 @@ item: </ul>It does not matter whether there are spaces following the [list marker]:
+It does not matter whether there are spaces following the [list marker]:
--- foo +- foo - - bar . @@ -3768,9 +3765,9 @@ item: </ul>Here is an empty ordered list item:
+Here is an empty ordered list item:
--1. foo +1. foo 2. 3. bar . @@ -3781,18 +3778,18 @@ item: </ol>A list may start or end with an empty list item:
+A list may start or end with an empty list item:
--* +* . <ul> <li></li> </ul>However, an empty list item cannot interrupt a paragraph:
+However, an empty list item cannot interrupt a paragraph:
--foo +foo * foo @@ -3804,17 +3801,17 @@ item: 1.</p>-
- +
+
-- Indentation. If a sequence of lines Ls constitutes a list item according to rule #1, #2, or #3, then the result of indenting each line of Ls by 1-3 spaces (the same for each line) also constitutes a list item with the same contents and attributes. If a line is empty, then it need not be indented.
Indented one space:
+Indented one space:
--1. A paragraph +1. A paragraph with two lines. indented code @@ -3834,9 +3831,9 @@ empty, then it need not be indented. </ol>Indented two spaces:
+Indented two spaces:
--1. A paragraph +1. A paragraph with two lines. indented code @@ -3856,9 +3853,9 @@ empty, then it need not be indented. </ol>Indented three spaces:
+Indented three spaces:
--1. A paragraph +1. A paragraph with two lines. indented code @@ -3878,9 +3875,9 @@ empty, then it need not be indented. </ol>Four spaces indent gives a code block:
+Four spaces indent gives a code block:
--1. A paragraph +1. A paragraph with two lines. indented code @@ -3896,8 +3893,8 @@ empty, then it need not be indented. </code></pre>-
- +
+
-- Laziness. If a string of lines Ls constitute a list item with contents Bs, then the result of deleting some or all of the indentation from one or more lines in which the @@ -3907,9 +3904,9 @@ list item with the same contents and attributes. The unindented lines are called lazy continuation lines.
Here is an example with [lazy continuation lines]:
+Here is an example with [lazy continuation lines]:
--1. A paragraph +1. A paragraph with two lines. indented code @@ -3929,9 +3926,9 @@ lines are called </ol>Indentation can be partially deleted:
+Indentation can be partially deleted:
--1. A paragraph +1. A paragraph with two lines. . <ol> @@ -3940,9 +3937,9 @@ lines are called </ol>These examples show how laziness can work in nested structures:
+These examples show how laziness can work in nested structures:
-> 1. > Blockquote +> 1. > Blockquote continued here. . <blockquote> @@ -3958,7 +3955,7 @@ lines are called> 1. > Blockquote +> 1. > Blockquote > continued here. . <blockquote> @@ -3973,18 +3970,18 @@ lines are called </blockquote>-
- +
+
-- That's all. Nothing that is not counted as a list item by rules #1--5 counts as a list item.
The rules for sublists follow from the general rules +
The rules for sublists follow from the general rules [above][List items]. A sublist must be indented the same number of spaces a paragraph would need to be in order to be included in the list item.
-So, in this case we need two spaces indent:
+So, in this case we need two spaces indent:
--- foo +- foo - bar - baz - boo @@ -4006,9 +4003,9 @@ in the list item. </ul>One is not enough:
+One is not enough:
--- foo +- foo - bar - baz - boo @@ -4021,9 +4018,9 @@ in the list item. </ul>Here we need four, because the list marker is wider:
+Here we need four, because the list marker is wider:
--10) foo +10) foo - bar . <ol start="10"> @@ -4035,9 +4032,9 @@ in the list item. </ol>Three is not enough:
+Three is not enough:
--10) foo +10) foo - bar . <ol start="10"> @@ -4048,9 +4045,9 @@ in the list item. </ul>A list may be the first block in a list item:
+A list may be the first block in a list item:
-- - foo +- - foo . <ul> <li> @@ -4062,7 +4059,7 @@ in the list item.1. - 2. foo +1. - 2. foo . <ol> <li> @@ -4077,9 +4074,9 @@ in the list item. </ol>A list item can contain a heading:
+A list item can contain a heading:
--- # Foo +- # Foo - Bar --- baz @@ -4094,38 +4091,38 @@ in the list item. </ul>+
Motivation
-John Gruber's Markdown spec says the following about list items:
--
- -
"List markers typically start at the left margin, but may be indented +
John Gruber's Markdown spec says the following about list items:
++
-- +
-"List markers typically start at the left margin, but may be indented by up to three spaces. List markers must be followed by one or more spaces or a tab."
- -
"To make lists look nice, you can wrap items with hanging indents.... +
- +
-"To make lists look nice, you can wrap items with hanging indents.... But if you don't want to, you don't have to."
- -
"List items may consist of multiple paragraphs. Each subsequent +
- +
-"List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be indented by either 4 spaces or one tab."
- -
"It looks nice if you indent every line of the subsequent paragraphs, +
- +
-"It looks nice if you indent every line of the subsequent paragraphs, but here again, Markdown will allow you to be lazy."
- -
"To put a blockquote within a list item, the blockquote's
>+- +
-"To put a blockquote within a list item, the blockquote's
>delimiters need to be indented."- -
"To put a code block within a list item, the code block needs to be +
- +
"To put a code block within a list item, the code block needs to be indented twice — 8 spaces or two tabs."
These rules specify that a paragraph under a list item must be indented +
These rules specify that a paragraph under a list item must be indented four spaces (presumably, from the left margin, rather than the start of the list marker, but this is not said), and that code under a list item must be indented eight spaces instead of the usual four. They also say @@ -4135,7 +4132,7 @@ about other kinds of block-level content, it is certainly reasonable to infer that all block elements under a list item, including other lists, must be indented four spaces. This principle has been called the four-space rule.
-The four-space rule is clear and principled, and if the reference +
The four-space rule is clear and principled, and if the reference implementation
-Markdown.plhad followed it, it probably would have become the standard. However,Markdown.plallowed paragraphs and sublists to start with only two spaces indentation, at least on the @@ -4147,33 +4144,33 @@ determining what comes under a list item. (Pandoc and python-Markdown, for example, stuck with Gruber's syntax description and the four-space rule, while discount, redcarpet, marked, PHP Markdown, and others followedMarkdown.pl's behavior more closely.)Unfortunately, given the divergences between implementations, there +
Unfortunately, given the divergences between implementations, there is no way to give a spec for list items that will be guaranteed not to break any existing documents. However, the spec given here should correctly handle lists formatted with either the four-space rule or the more forgiving
-Markdown.plbehavior, provided they are laid out in a way that is natural for a human to read.The strategy here is to let the width and indentation of the list marker +
The strategy here is to let the width and indentation of the list marker determine the indentation necessary for blocks to fall under the list item, rather than having a fixed and arbitrary number. The writer can think of the body of the list item as a unit which gets indented to the right enough to fit the list marker (and any indentation on the list marker). (The laziness rule, #5, then allows continuation lines to be unindented if needed.)
-This rule is superior, we claim, to any rule requiring a fixed level of +
This rule is superior, we claim, to any rule requiring a fixed level of indentation from the margin. The four-space rule is clear but unnatural. It is quite unintuitive that
--- foo +- foo bar - bazshould be parsed as two lists with an intervening paragraph,
+should be parsed as two lists with an intervening paragraph,
--<ul> +<ul> <li>foo</li> </ul> <p>bar</p> @@ -4182,9 +4179,9 @@ unnatural. It is quite unintuitive that </ul>as the four-space rule demands, rather than a single list,
+as the four-space rule demands, rather than a single list,
--<ul> +<ul> <li> <p>foo</p> <p>bar</p> @@ -4195,22 +4192,22 @@ unnatural. It is quite unintuitive that </ul>The choice of four spaces is arbitrary. It can be learned, but it is +
The choice of four spaces is arbitrary. It can be learned, but it is not likely to be guessed, and it trips up beginners regularly.
-Would it help to adopt a two-space rule? The problem is that such +
Would it help to adopt a two-space rule? The problem is that such a rule, together with the rule allowing 1--3 spaces indentation of the initial list marker, allows text that is indented less than the original list marker to be included in the list item. For example,
Markdown.plparses--- one +- one twoas a single list item, with
+twoa continuation paragraph:as a single list item, with
twoa continuation paragraph:--<ul> +<ul> <li> <p>one</p> <p>two</p> @@ -4218,16 +4215,16 @@ original list marker to be included in the list item. For example, </ul>and similarly
+and similarly
--> - one +> - one > > twoas
+as
--<blockquote> +<blockquote> <ul> <li> <p>one</p> @@ -4237,33 +4234,33 @@ original list marker to be included in the list item. For example, </blockquote>This is extremely unintuitive.
-Rather than requiring a fixed indent from the margin, we could require +
This is extremely unintuitive.
+Rather than requiring a fixed indent from the margin, we could require a fixed indent (say, two spaces, or even one space) from the list marker (which may itself be indented). This proposal would remove the last anomaly discussed. Unlike the spec presented above, it would count the following as a list item with a subparagraph, even though the paragraph
baris not indented as far as the first paragraphfoo:--10. foo +10. foo barArguably this text does read like a list item with
baras a subparagraph, +Arguably this text does read like a list item with
baras a subparagraph, which may count in favor of the proposal. However, on this proposal indented code would have to be indented six spaces after the list marker. And this would break a lot of existing Markdown, which has the pattern:--1. foo +1. foo indented codewhere the code is indented eight spaces. The spec above, by contrast, will +
where the code is indented eight spaces. The spec above, by contrast, will parse this text as expected, since the code block's indentation is measured from the beginning of
-foo.The one case that needs special treatment is a list item that starts +
The one case that needs special treatment is a list item that starts with indented code. How much indentation is required in that case, since we don't have a "first paragraph" to measure from? Rule #2 simply stipulates that in such cases, we require one space indentation from the list marker @@ -4271,26 +4268,26 @@ that in such cases, we require one space indentation from the list marker four-space rule in cases where the list marker plus its initial indentation takes four spaces (a common case), but diverge in other cases.
--+
Task list items (extension)
-GFM enables the
tasklistextension, where an additional processing step is +GFM enables the
-tasklistextension, where an additional processing step is performed on [list items].A task list item is a [list item][list items] where the first block in it +
A task list item is a [list item][list items] where the first block in it is a paragraph which begins with a [task list item marker] and at least one whitespace character before any other content.
-A task list item marker consists of an optional number of spaces, a left +
A task list item marker consists of an optional number of spaces, a left bracket (
-[), either a whitespace character or the letterxin either lowercase or uppercase, and then a right bracket (]).When rendered, the [task list item marker] is replaced with a semantic checkbox element; +
When rendered, the [task list item marker] is replaced with a semantic checkbox element; in an HTML output, this would be an
-<input type="checkbox">element.If the character between the brackets is a whitespace character, the checkbox +
If the character between the brackets is a whitespace character, the checkbox is unchecked. Otherwise, the checkbox is checked.
-This spec does not define how the checkbox elements are interacted with: in practice, +
This spec does not define how the checkbox elements are interacted with: in practice, implementors are free to render the checkboxes as disabled or inmutable elements, or they may dynamically handle dynamic interactions (i.e. checking, unchecking) in the final rendered document.
--- [ ] foo +- [ ] foo - [x] bar . <ul> @@ -4299,9 +4296,9 @@ the final rendered document. </ul>Task lists can be arbitrarily nested:
+Task lists can be arbitrarily nested:
-- [x] foo +- [x] foo - [ ] bar - [x] baz - [ ] bim @@ -4318,35 +4315,35 @@ the final rendered document.+
Lists
-A list is a sequence of one or more +
A list is a sequence of one or more list items [of the same type]. The list items may be separated by any number of blank lines.
-Two list items are of the same type +
Two list items are of the same type if they begin with a [list marker] of the same type. Two list markers are of the same type if (a) they are bullet list markers using the same character (
--,+, or*) or (b) they are ordered list numbers with the same delimiter (either.or)).A list is an ordered list +
A list is an ordered list if its constituent list items begin with [ordered list markers], and a bullet list if its constituent list items begin with [bullet list markers].
-The start number +
The start number of an [ordered list] is determined by the list number of its initial list item. The numbers of subsequent list items are disregarded.
-A list is loose if any of its constituent +
A list is loose if any of its constituent list items are separated by blank lines, or if any of its constituent list items directly contain two block-level elements with a blank line between them. Otherwise a list is tight. (The difference in HTML output is that paragraphs in a loose list are wrapped in
-<p>tags, while paragraphs in a tight list are not.)Changing the bullet or ordered list delimiter starts a new list:
+Changing the bullet or ordered list delimiter starts a new list:
-- foo +- foo - bar + baz . @@ -4360,7 +4357,7 @@ wrapped in<p>tags, while paragraphs in a tight list are not1. foo +1. foo 2. bar 3) baz . @@ -4373,11 +4370,11 @@ wrapped in<p>tags, while paragraphs in a tight list are not </ol>In CommonMark, a list can interrupt a paragraph. That is, +
In CommonMark, a list can interrupt a paragraph. That is, no blank line is needed to separate a paragraph from a following list:
--Foo +Foo - bar - baz . @@ -4388,74 +4385,74 @@ list: </ul>
Markdown.pldoes not allow this, through fear of triggering a list +
Markdown.pldoes not allow this, through fear of triggering a list via a numeral in a hard-wrapped line:--The number of windows in my house is +The number of windows in my house is 14. The number of doors is 6.Oddly, though,
Markdown.pldoes allow a blockquote to +Oddly, though,
-Markdown.pldoes allow a blockquote to interrupt a paragraph, even though the same considerations might apply.In CommonMark, we do allow lists to interrupt paragraphs, for +
In CommonMark, we do allow lists to interrupt paragraphs, for two reasons. First, it is natural and not uncommon for people to start lists without blank lines:
--I need to buy +I need to buy - new shoes - a coat - a plane ticketSecond, we are attracted to a
--Second, we are attracted to a
++-principle of uniformity: if a chunk of text has a certain meaning, it will continue to have the same meaning when put into a container block (such as a list item or blockquote).
(Indeed, the spec for [list items] and [block quotes] presupposes +
(Indeed, the spec for [list items] and [block quotes] presupposes this principle.) This principle implies that if
--* I need to buy +* I need to buy - new shoes - a coat - a plane ticketis a list item containing a paragraph followed by a nested sublist, +
is a list item containing a paragraph followed by a nested sublist, as all Markdown implementations agree it is (though the paragraph may be rendered without
<p>tags, since the list is "tight"), then--I need to buy +I need to buy - new shoes - a coat - a plane ticketby itself should be a paragraph followed by a nested sublist.
-Since it is well established Markdown practice to allow lists to +
by itself should be a paragraph followed by a nested sublist.
+Since it is well established Markdown practice to allow lists to interrupt paragraphs inside list items, the [principle of uniformity] requires us to allow this outside list items as well. (reStructuredText takes a different approach, requiring blank lines before lists even inside other list items.)
-In order to solve of unwanted lists in paragraphs with +
In order to solve of unwanted lists in paragraphs with hard-wrapped numerals, we allow only lists starting with
1to interrupt paragraphs. Thus,--The number of windows in my house is +The number of windows in my house is 14. The number of doors is 6. . <p>The number of windows in my house is 14. The number of doors is 6.</p>We may still get an unintended result in cases like
+We may still get an unintended result in cases like
--The number of windows in my house is +The number of windows in my house is 1. The number of doors is 6. . <p>The number of windows in my house is</p> @@ -4464,10 +4461,10 @@ interrupt paragraphs. Thus, </ol>but this rule should prevent most spurious list captures.
-There can be any number of blank lines between items:
+but this rule should prevent most spurious list captures.
+There can be any number of blank lines between items:
-- foo +- foo - bar @@ -4488,7 +4485,7 @@ interrupt paragraphs. Thus,- foo +- foo - bar - baz @@ -4511,12 +4508,12 @@ interrupt paragraphs. Thus, </ul>To separate consecutive lists of the same type, or to separate a +
To separate consecutive lists of the same type, or to separate a list from an indented code block that would otherwise be parsed as a subparagraph of the final list item, you can insert a blank HTML comment:
-- foo +- foo - bar <!-- --> @@ -4536,7 +4533,7 @@ comment:- foo +- foo notcode @@ -4560,12 +4557,12 @@ comment: </code></pre>List items need not be indented to the same level. The following +
List items need not be indented to the same level. The following list items will be treated as items at the same list level, since none is indented enough to belong to the previous list item:
-- a +- a - b - c - d @@ -4585,7 +4582,7 @@ item:1. a +1. a 2. b @@ -4604,11 +4601,11 @@ item: </ol>Note, however, that list items may not be indented more than +
Note, however, that list items may not be indented more than three spaces. Here
- eis treated as a paragraph continuation line, because it is indented more than three spaces:--- a +- a - b - c - d @@ -4623,11 +4620,11 @@ line, because it is indented more than three spaces: </ul>And here,
3. cis treated as in indented code block, +And here,
3. cis treated as in indented code block, because it is indented four spaces and preceded by a blank line.--1. a +1. a 2. b @@ -4645,10 +4642,10 @@ blank line. </code></pre>This is a loose list, because there is a blank line between +
This is a loose list, because there is a blank line between two of the list items:
--- a +- a - b - c @@ -4666,9 +4663,9 @@ two of the list items: </ul>So is this, with a empty second item:
+So is this, with a empty second item:
--* a +* a * * c @@ -4684,11 +4681,11 @@ two of the list items: </ul>These are loose lists, even though there is no space between the items, +
These are loose lists, even though there is no space between the items, because one of the items directly contains two block-level elements with a blank line between them:
-- a +- a - b c @@ -4709,7 +4706,7 @@ with a blank line between them:- a +- a - b [ref]: /url @@ -4728,9 +4725,9 @@ with a blank line between them: </ul>This is a tight list, because the blank lines are in a code block:
+This is a tight list, because the blank lines are in a code block:
--- a +- a - ``` b @@ -4750,11 +4747,11 @@ with a blank line between them: </ul>This is a tight list, because the blank line is between two +
This is a tight list, because the blank line is between two paragraphs of a sublist. So the sublist is loose while the outer list is tight:
--- a +- a - b c @@ -4773,10 +4770,10 @@ the outer list is tight: </ul>This is a tight list, because the blank line is inside the +
This is a tight list, because the blank line is inside the block quote:
--* a +* a > b > * c @@ -4791,10 +4788,10 @@ block quote: </ul>This list is tight, because the consecutive block elements +
This list is tight, because the consecutive block elements are not separated by blank lines:
--- a +- a > b ``` c @@ -4813,9 +4810,9 @@ are not separated by blank lines: </ul>A single-paragraph list is tight:
+A single-paragraph list is tight:
-- a +- a . <ul> <li>a</li> @@ -4823,7 +4820,7 @@ are not separated by blank lines:- a +- a - b . <ul> @@ -4835,10 +4832,10 @@ are not separated by blank lines: </ul>This list is loose, because of the blank line between the +
This list is loose, because of the blank line between the two block elements in the list item:
--1. ``` +1. ``` foo ``` @@ -4853,9 +4850,9 @@ two block elements in the list item: </ol>Here the outer list is loose, the inner list tight:
+Here the outer list is loose, the inner list tight:
-* foo +* foo * bar baz @@ -4872,7 +4869,7 @@ two block elements in the list item:- a +- a - b - c @@ -4898,40 +4895,40 @@ two block elements in the list item: </ul>+
Inlines
-Inlines are parsed sequentially from the beginning of the character +
Inlines are parsed sequentially from the beginning of the character stream to the end (left to right, in left-to-right languages). Thus, for example, in
--`hi`lo` +`hi`lo` . <p><code>hi</code>lo`</p>
hiis parsed as code, leaving the backtick at the end as a literal +-
hiis parsed as code, leaving the backtick at the end as a literal backtick.+
Backslash escapes
-Any ASCII punctuation character may be backslash-escaped:
+Any ASCII punctuation character may be backslash-escaped:
--\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~ +\!\"\#\$\%\&\'\(\)\*\+\,\-\.\/\:\;\<\=\>\?\@\[\\\]\^\_\`\{\|\}\~ . <p>!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~</p>Backslashes before other characters are treated as literal +
Backslashes before other characters are treated as literal backslashes:
--\→\A\a\ \3\φ\« +\→\A\a\ \3\φ\« . <p>\→\A\a\ \3\φ\«</p>Escaped characters are treated as regular characters and do +
Escaped characters are treated as regular characters and do not have their usual Markdown meanings:
--\*not emphasized* +\*not emphasized* \<br/> not a tag \[not a link](/foo) \`not code` @@ -4952,39 +4949,39 @@ not have their usual Markdown meanings: &ouml; not a character entity</p>If a backslash is itself escaped, the following character is not:
+If a backslash is itself escaped, the following character is not:
--\\*emphasis* +\\*emphasis* . <p>\<em>emphasis</em></p>A backslash at the end of the line is a [hard line break]:
+A backslash at the end of the line is a [hard line break]:
--foo\ +foo\ bar . <p>foo<br /> bar</p>Backslash escapes do not work in code blocks, code spans, autolinks, or +
Backslash escapes do not work in code blocks, code spans, autolinks, or raw HTML:
-`` \[\` `` +`` \[\` `` . <p><code>\[\`</code></p>\[\] +\[\] . <pre><code>\[\] </code></pre>~~~ +~~~ \[\] ~~~ . @@ -4993,27 +4990,27 @@ raw HTML:<http://example.com?find=\*> +<http://example.com?find=\*> . <p><a href="http://example.com?find=%5C*">http://example.com?find=\*</a></p><a href="/bar\/)"> +<a href="/bar\/)"> . <a href="/bar\/)">But they work in all other contexts, including URLs and link titles, +
But they work in all other contexts, including URLs and link titles, link references, and [info strings] in [fenced code blocks]:
-[foo](/bar\* "ti\*tle") +[foo](/bar\* "ti\*tle") . <p><a href="/bar*" title="ti*tle">foo</a></p>[foo] +[foo] [foo]: /bar\* "ti\*tle" . @@ -5021,7 +5018,7 @@ link references, and [info strings] in [fenced code blocks]:``` foo\+bar +``` foo\+bar foo ``` . @@ -5029,18 +5026,18 @@ link references, and [info strings] in [fenced code blocks]: </code></pre>+
Entity and numeric character references
-Valid HTML entity references and numeric character references +
Valid HTML entity references and numeric character references can be used in place of the corresponding Unicode character, with the following exceptions:
--
- -
Entity and character references are not recognized in code +
+
-- +
-Entity and character references are not recognized in code blocks and code spans.
- -
Entity and character references cannot stand in place of +
- +
Entity and character references cannot stand in place of special characters that define structural elements in CommonMark. For example, although
*can be used in place of a literal*character,*cannot replace @@ -5048,16 +5045,16 @@ in place of a literal*character,*cannot re breaks.Conforming CommonMark parsers need not store information about +
Conforming CommonMark parsers need not store information about whether a particular character was represented in the source using a Unicode character or an entity reference.
-Entity references consist of
&+ any of the valid +Entity references consist of
&+ any of the valid HTML5 entity names +;. The document https://html.spec.whatwg.org/multipage/entities.json is used as an authoritative source for the valid entity references and their corresponding code points.-- & © Æ Ď + & © Æ Ď ¾ ℋ ⅆ ∲ ≧̸ . @@ -5066,7 +5063,7 @@ references and their corresponding code points. ∲ ≧̸</p>Decimal numeric character +
Decimal numeric character references consist of
&#+ a string of 1--7 arabic digits +;. A numeric character reference is parsed as the corresponding @@ -5074,25 +5071,25 @@ Unicode character. Invalid Unicode code points will be replaced by the REPLACEMENT CHARACTER (U+FFFD). For security reasons, the code pointU+0000will also be replaced byU+FFFD.--# Ӓ Ϡ � +# Ӓ Ϡ � . <p># Ӓ Ϡ �</p>Hexadecimal numeric character +
Hexadecimal numeric character references consist of
&#+ eitherXorx+ a string of 1-6 hexadecimal digits +;. They too are parsed as the corresponding Unicode character (this time specified with a hexadecimal numeral instead of decimal).--" ആ ಫ +" ആ ಫ . <p>" ആ ಫ</p>Here are some nonentities:
+Here are some nonentities:
--  &x; &#; &#x; +  &x; &#; &#x; � &#abcdef0; &ThisIsNotDefined; &hi?; @@ -5103,40 +5100,40 @@ time specified with a hexadecimal numeral instead of decimal). &ThisIsNotDefined; &hi?;</p>Although HTML5 does accept some entity references +
Although HTML5 does accept some entity references without a trailing semicolon (such as
©), these are not recognized here, because it makes the grammar too ambiguous:--© +© . <p>&copy</p>Strings that are not on the list of HTML5 named entities are not +
Strings that are not on the list of HTML5 named entities are not recognized as entity references either:
--&MadeUpEntity; +&MadeUpEntity; . <p>&MadeUpEntity;</p>Entity and numeric character references are recognized in any +
Entity and numeric character references are recognized in any context besides code spans or code blocks, including URLs, [link titles], and [fenced code block][] [info strings]:
-<a href="öö.html"> +<a href="öö.html"> . <a href="öö.html">[foo](/föö "föö") +[foo](/föö "föö") . <p><a href="/f%C3%B6%C3%B6" title="föö">foo</a></p>[foo] +[foo] [foo]: /föö "föö" . @@ -5144,7 +5141,7 @@ URLs, [link titles], and [fenced code block][] [info strings]:``` föö +``` föö foo ``` . @@ -5152,26 +5149,26 @@ URLs, [link titles], and [fenced code block][] [info strings]: </code></pre>Entity and numeric character references are treated as literal +
Entity and numeric character references are treated as literal text in code spans and code blocks:
-`föö` +`föö` . <p><code>f&ouml;&ouml;</code></p>föfö +föfö . <pre><code>f&ouml;f&ouml; </code></pre>Entity and numeric character references cannot be used +
Entity and numeric character references cannot be used in place of symbols indicating structure in CommonMark documents.
-*foo* +*foo* *foo* . <p>*foo* @@ -5179,7 +5176,7 @@ documents.* foo +* foo * foo . @@ -5190,7 +5187,7 @@ documents.foo bar +foo bar . <p>foo @@ -5198,94 +5195,94 @@ documents.	foo +	foo . <p>→foo</p>[a](url "tit") +[a](url "tit") . <p>[a](url "tit")</p>+
Code spans
-A backtick string +
A backtick string is a string of one or more backtick characters (
-`) that is neither preceded nor followed by a backtick.A code span begins with a backtick string and ends with +
A code span begins with a backtick string and ends with a backtick string of equal length. The contents of the code span are the characters between the two backtick strings, normalized in the following ways:
--
tag on its own line.- First, [line endings] are converted to [spaces].
-- If the resulting string both begins and ends with a [space] +
-+
-- First, [line endings] are converted to [spaces].
+- If the resulting string both begins and ends with a [space] character, but does not consist entirely of [space] characters, a single [space] character is removed from the front and back. This allows you to include code that begins or ends with backtick characters, which must be separated by whitespace from the opening or closing backtick strings.
This is a simple code span:
+This is a simple code span:
--`foo` +`foo` . <p><code>foo</code></p>Here two backticks are used, because the code contains a backtick. +
Here two backticks are used, because the code contains a backtick. This example also illustrates stripping of a single leading and trailing space:
--`` foo ` bar `` +`` foo ` bar `` . <p><code>foo ` bar</code></p>This example shows the motivation for stripping leading and trailing +
This example shows the motivation for stripping leading and trailing spaces:
--` `` ` +` `` ` . <p><code>``</code></p>Note that only one space is stripped:
+Note that only one space is stripped:
--` `` ` +` `` ` . <p><code> `` </code></p>The stripping only happens if the space is on both +
The stripping only happens if the space is on both sides of the string:
--` a` +` a` . <p><code> a</code></p>Only [spaces], and not [unicode whitespace] in general, are +
Only [spaces], and not [unicode whitespace] in general, are stripped in this way:
--` b ` +` b ` . <p><code> b </code></p>No stripping occurs if the code span contains only spaces:
+No stripping occurs if the code span contains only spaces:
--` ` +` ` ` ` . <p><code> </code> <code> </code></p>[Line endings] are treated like spaces:
+[Line endings] are treated like spaces:
-`` +`` foo bar baz @@ -5295,274 +5292,274 @@ stripped in this way:`` +`` foo `` . <p><code>foo </code></p>Interior spaces are not collapsed:
+Interior spaces are not collapsed:
--`foo bar +`foo bar baz` . <p><code>foo bar baz</code></p>Note that browsers will typically collapse consecutive spaces +
Note that browsers will typically collapse consecutive spaces when rendering
<code>elements, so it is recommended that the following CSS be used:--+code{white-space: pre-wrap;}code{white-space: pre-wrap;}Note that backslash escapes do not work in code spans. All backslashes +
Note that backslash escapes do not work in code spans. All backslashes are treated literally:
--`foo\`bar` +`foo\`bar` . <p><code>foo\</code>bar`</p>Backslash escapes are never needed, because one can always choose a +
Backslash escapes are never needed, because one can always choose a string of n backtick characters as delimiters, where the code does not contain any strings of exactly n backtick characters.
-``foo`bar`` +``foo`bar`` . <p><code>foo`bar</code></p>` foo `` bar ` +` foo `` bar ` . <p><code>foo `` bar</code></p>Code span backticks have higher precedence than any other inline +
Code span backticks have higher precedence than any other inline constructs except HTML tags and autolinks. Thus, for example, this is not parsed as emphasized text, since the second
*is part of a code span:--*foo`*` +*foo`*` . <p>*foo<code>*</code></p>And this is not parsed as a link:
+And this is not parsed as a link:
--[not a `link](/foo`) +[not a `link](/foo`) . <p>[not a <code>link](/foo</code>)</p>Code spans, HTML tags, and autolinks have the same precedence. +
Code spans, HTML tags, and autolinks have the same precedence. Thus, this is code:
--`<a href="`">` +`<a href="`">` . <p><code><a href="</code>">`</p>But this is an HTML tag:
+But this is an HTML tag:
--<a href="`">` +<a href="`">` . <p><a href="`">`</p>And this is code:
+And this is code:
--`<http://foo.bar.`baz>` +`<http://foo.bar.`baz>` . <p><code><http://foo.bar.</code>baz>`</p>But this is an autolink:
+But this is an autolink:
--<http://foo.bar.`baz>` +<http://foo.bar.`baz>` . <p><a href="http://foo.bar.%60baz">http://foo.bar.`baz</a>`</p>When a backtick string is not closed by a matching backtick string, +
When a backtick string is not closed by a matching backtick string, we just have literal backticks:
-```foo`` +```foo`` . <p>```foo``</p>`foo +`foo . <p>`foo</p>The following case also illustrates the need for opening and +
The following case also illustrates the need for opening and closing backtick strings to be equal in length:
--`foo``bar`` +`foo``bar`` . <p>`foo<code>bar</code></p>+
Emphasis and strong emphasis
-John Gruber's original Markdown syntax +
John Gruber's original Markdown syntax description says:
--Markdown treats asterisks (
*) and underscores (_) as indicators of ++-Markdown treats asterisks (
*) and underscores (_) as indicators of emphasis. Text wrapped with one*or_will be wrapped with an HTML<em>tag; double*'s or_'s will be wrapped with an HTML<strong>tag.This is enough for most users, but these rules leave much undecided, +
This is enough for most users, but these rules leave much undecided, especially when it comes to nested emphasis. The original
Markdown.pltest suite makes it clear that triple***and___delimiters can be used for strong emphasis, and most implementations have also allowed the following patterns:--***strong emph*** +***strong emph*** ***strong** in emph* ***emph* in strong** **in strong *emph*** *in emph **strong***The following patterns are less widely supported, but the intent +
The following patterns are less widely supported, but the intent is clear and they are useful (especially in contexts like bibliography entries):
--*emph *with emph* in it* +*emph *with emph* in it* **strong **with strong** in it**Many implementations have also restricted intraword emphasis to +
Many implementations have also restricted intraword emphasis to the
*forms, to avoid unwanted emphasis in words containing internal underscores. (It is best practice to put these in code spans, but users often do not.)--internal emphasis: foo*bar*baz +internal emphasis: foo*bar*baz no emphasis: foo_bar_bazThe rules given below capture all of these patterns, while allowing +
The rules given below capture all of these patterns, while allowing for efficient parsing strategies that do not backtrack.
-First, some definitions. A delimiter run is either +
First, some definitions. A delimiter run is either a sequence of one or more
-*characters that is not preceded or followed by a non-backslash-escaped*character, or a sequence of one or more_characters that is not preceded or followed by a non-backslash-escaped_character.A left-flanking delimiter run is +
A left-flanking delimiter run is a [delimiter run] that is (1) not followed by [Unicode whitespace], and either (2a) not followed by a [punctuation character], or (2b) followed by a [punctuation character] and preceded by [Unicode whitespace] or a [punctuation character]. For purposes of this definition, the beginning and the end of the line count as Unicode whitespace.
-A right-flanking delimiter run is +
A right-flanking delimiter run is a [delimiter run] that is (1) not preceded by [Unicode whitespace], and either (2a) not preceded by a [punctuation character], or (2b) preceded by a [punctuation character] and followed by [Unicode whitespace] or a [punctuation character]. For purposes of this definition, the beginning and the end of the line count as Unicode whitespace.
-Here are some examples of delimiter runs.
--
- -
left-flanking but not right-flanking:
+Here are some examples of delimiter runs.
++
-- +
-left-flanking but not right-flanking:
-***abc +***abc _abc **"abc" _"abc"- -
right-flanking but not left-flanking:
+- +
-right-flanking but not left-flanking:
-abc*** +abc*** abc_ "abc"** "abc"_- -
Both left and right-flanking:
+- +
-Both left and right-flanking:
-abc***def +abc***def "abc"_"def"- -
Neither left nor right-flanking:
+- +
Neither left nor right-flanking:
-abc *** def +abc *** def a _ b(The idea of distinguishing left-flanking and right-flanking +
(The idea of distinguishing left-flanking and right-flanking delimiter runs based on the character before and the character after comes from Roopesh Chander's vfmd. vfmd uses the terminology "emphasis indicator string" instead of "delimiter run," and its rules for distinguishing left- and right-flanking runs are a bit more complex than the ones given here.)
-The following rules define emphasis and strong emphasis:
--
- -
A single
*character can open emphasis +The following rules define emphasis and strong emphasis:
++
-- +
-A single
*character can open emphasis iff (if and only if) it is part of a [left-flanking delimiter run].- -
A single
_character [can open emphasis] iff +- +
-A single
_character [can open emphasis] iff it is part of a [left-flanking delimiter run] and either (a) not part of a [right-flanking delimiter run] or (b) part of a [right-flanking delimiter run] preceded by punctuation.- -
A single
*character can close emphasis +- +
-A single
*character can close emphasis iff it is part of a [right-flanking delimiter run].- -
A single
_character [can close emphasis] iff +- +
-A single
_character [can close emphasis] iff it is part of a [right-flanking delimiter run] and either (a) not part of a [left-flanking delimiter run] or (b) part of a [left-flanking delimiter run] followed by punctuation.- -
A double
**can open strong emphasis +- +
-A double
**can open strong emphasis iff it is part of a [left-flanking delimiter run].- -
A double
__[can open strong emphasis] iff +- +
-A double
__[can open strong emphasis] iff it is part of a [left-flanking delimiter run] and either (a) not part of a [right-flanking delimiter run] or (b) part of a [right-flanking delimiter run] preceded by punctuation.- -
A double
**can close strong emphasis +- +
-A double
**can close strong emphasis iff it is part of a [right-flanking delimiter run].- -
A double
__[can close strong emphasis] iff +- +
-A double
__[can close strong emphasis] iff it is part of a [right-flanking delimiter run] and either (a) not part of a [left-flanking delimiter run] or (b) part of a [left-flanking delimiter run] followed by punctuation.- -
Emphasis begins with a delimiter that [can open emphasis] and ends +
- +
-Emphasis begins with a delimiter that [can open emphasis] and ends with a delimiter that [can close emphasis], and that uses the same character (
_or*) as the opening delimiter. The opening and closing delimiters must belong to separate @@ -5572,8 +5569,8 @@ delimiter runs containing the opening and closing delimiters must not be a multiple of 3 unless both lengths are multiples of 3.- -
Strong emphasis begins with a delimiter that +
- +
-Strong emphasis begins with a delimiter that [can open strong emphasis] and ends with a delimiter that [can close strong emphasis], and that uses the same character (
_or*) as the opening delimiter. The @@ -5584,45 +5581,45 @@ the delimiter runs containing the opening and closing delimiters must not be a multiple of 3 unless both lengths are multiples of 3.- -
A literal
*character cannot occur at the beginning or end of +- +
-A literal
*character cannot occur at the beginning or end of*-delimited emphasis or**-delimited strong emphasis, unless it is backslash-escaped.- -
A literal
_character cannot occur at the beginning or end of +- +
A literal
_character cannot occur at the beginning or end of_-delimited emphasis or__-delimited strong emphasis, unless it is backslash-escaped.Where rules 1--12 above are compatible with multiple parsings, +
Where rules 1--12 above are compatible with multiple parsings, the following principles resolve ambiguity:
--
- -
The number of nestings should be minimized. Thus, for example, +
+
-- +
-The number of nestings should be minimized. Thus, for example, an interpretation
<strong>...</strong>is always preferred to<em><em>...</em></em>.- -
An interpretation
<em><strong>...</strong></em>is always +- +
-An interpretation
<em><strong>...</strong></em>is always preferred to<strong><em>...</em></strong>.- -
When two potential emphasis or strong emphasis spans overlap, +
- +
-When two potential emphasis or strong emphasis spans overlap, so that the second begins before the first ends and ends after the first ends, the first takes precedence. Thus, for example,
*foo _bar* baz_is parsed as<em>foo _bar</em> baz_rather than*foo <em>bar* baz</em>.- -
When there are two potential emphasis or strong emphasis spans +
- +
-When there are two potential emphasis or strong emphasis spans with the same closing delimiter, the shorter one (the one that opens later) takes precedence. Thus, for example,
**foo **bar baz**is parsed as**foo <strong>bar baz</strong>rather than<strong>foo **bar baz</strong>.- -
Inline code spans, links, images, and HTML tags group more tightly +
- +
Inline code spans, links, images, and HTML tags group more tightly than emphasis. So, when there is a choice between an interpretation that contains one of these elements and one that does not, the former always wins. Thus, for example,
*[foo*](bar)is @@ -5630,338 +5627,338 @@ parsed as*<a href="bar">foo*</a>rather than as<em>[foo</em>](bar).These rules can be illustrated through a series of examples.
-Rule 1:
+These rules can be illustrated through a series of examples.
+Rule 1:
--*foo bar* +*foo bar* . <p><em>foo bar</em></p>This is not emphasis, because the opening
*is followed by +This is not emphasis, because the opening
*is followed by whitespace, and hence not part of a [left-flanking delimiter run]:--a * foo bar* +a * foo bar* . <p>a * foo bar*</p>This is not emphasis, because the opening
*is preceded +This is not emphasis, because the opening
*is preceded by an alphanumeric and followed by punctuation, and hence not part of a [left-flanking delimiter run]:--a*"foo"* +a*"foo"* . <p>a*"foo"*</p>Unicode nonbreaking spaces count as whitespace, too:
+Unicode nonbreaking spaces count as whitespace, too:
--* a * +* a * . <p>* a *</p>Intraword emphasis with
+*is permitted:Intraword emphasis with
*is permitted:-foo*bar* +foo*bar* . <p>foo<em>bar</em></p>5*6*78 +5*6*78 . <p>5<em>6</em>78</p>Rule 2:
+Rule 2:
--_foo bar_ +_foo bar_ . <p><em>foo bar</em></p>This is not emphasis, because the opening
_is followed by +This is not emphasis, because the opening
_is followed by whitespace:--_ foo bar_ +_ foo bar_ . <p>_ foo bar_</p>This is not emphasis, because the opening
_is preceded +This is not emphasis, because the opening
_is preceded by an alphanumeric and followed by punctuation:--a_"foo"_ +a_"foo"_ . <p>a_"foo"_</p>Emphasis with
+_is not allowed inside words:Emphasis with
_is not allowed inside words:-foo_bar_ +foo_bar_ . <p>foo_bar_</p>5_6_78 +5_6_78 . <p>5_6_78</p>пристаням_стремятся_ +пристаням_стремятся_ . <p>пристаням_стремятся_</p>Here
_does not generate emphasis, because the first delimiter run +Here
_does not generate emphasis, because the first delimiter run is right-flanking and the second left-flanking:--aa_"bb"_cc +aa_"bb"_cc . <p>aa_"bb"_cc</p>This is emphasis, even though the opening delimiter is +
This is emphasis, even though the opening delimiter is both left- and right-flanking, because it is preceded by punctuation:
--foo-_(bar)_ +foo-_(bar)_ . <p>foo-<em>(bar)</em></p>Rule 3:
-This is not emphasis, because the closing delimiter does +
Rule 3:
+This is not emphasis, because the closing delimiter does not match the opening delimiter:
--_foo* +_foo* . <p>_foo*</p>This is not emphasis, because the closing
*is preceded by +This is not emphasis, because the closing
*is preceded by whitespace:--*foo bar * +*foo bar * . <p>*foo bar *</p>A newline also counts as whitespace:
+A newline also counts as whitespace:
--*foo bar +*foo bar * . <p>*foo bar *</p>This is not emphasis, because the second
*is +This is not emphasis, because the second
*is preceded by punctuation and followed by an alphanumeric (hence it is not part of a [right-flanking delimiter run]:--*(*foo) +*(*foo) . <p>*(*foo)</p>The point of this restriction is more easily appreciated +
The point of this restriction is more easily appreciated with this example:
--*(*foo*)* +*(*foo*)* . <p><em>(<em>foo</em>)</em></p>Intraword emphasis with
+*is allowed:Intraword emphasis with
*is allowed:--*foo*bar +*foo*bar . <p><em>foo</em>bar</p>Rule 4:
-This is not emphasis, because the closing
_is preceded by +Rule 4:
+This is not emphasis, because the closing
_is preceded by whitespace:--_foo bar _ +_foo bar _ . <p>_foo bar _</p>This is not emphasis, because the second
_is +This is not emphasis, because the second
_is preceded by punctuation and followed by an alphanumeric:--_(_foo) +_(_foo) . <p>_(_foo)</p>This is emphasis within emphasis:
+This is emphasis within emphasis:
--_(_foo_)_ +_(_foo_)_ . <p><em>(<em>foo</em>)</em></p>Intraword emphasis is disallowed for
+_:Intraword emphasis is disallowed for
_:-_foo_bar +_foo_bar . <p>_foo_bar</p>_пристаням_стремятся +_пристаням_стремятся . <p>_пристаням_стремятся</p>_foo_bar_baz_ +_foo_bar_baz_ . <p><em>foo_bar_baz</em></p>This is emphasis, even though the closing delimiter is +
This is emphasis, even though the closing delimiter is both left- and right-flanking, because it is followed by punctuation:
--_(bar)_. +_(bar)_. . <p><em>(bar)</em>.</p>Rule 5:
+Rule 5:
--**foo bar** +**foo bar** . <p><strong>foo bar</strong></p>This is not strong emphasis, because the opening delimiter is +
This is not strong emphasis, because the opening delimiter is followed by whitespace:
--** foo bar** +** foo bar** . <p>** foo bar**</p>This is not strong emphasis, because the opening
**is preceded +This is not strong emphasis, because the opening
**is preceded by an alphanumeric and followed by punctuation, and hence not part of a [left-flanking delimiter run]:--a**"foo"** +a**"foo"** . <p>a**"foo"**</p>Intraword strong emphasis with
+**is permitted:Intraword strong emphasis with
**is permitted:--foo**bar** +foo**bar** . <p>foo<strong>bar</strong></p>Rule 6:
+Rule 6:
--__foo bar__ +__foo bar__ . <p><strong>foo bar</strong></p>This is not strong emphasis, because the opening delimiter is +
This is not strong emphasis, because the opening delimiter is followed by whitespace:
--__ foo bar__ +__ foo bar__ . <p>__ foo bar__</p>A newline counts as whitespace:
+A newline counts as whitespace:
--__ +__ foo bar__ . <p>__ foo bar__</p>This is not strong emphasis, because the opening
__is preceded +This is not strong emphasis, because the opening
__is preceded by an alphanumeric and followed by punctuation:--a__"foo"__ +a__"foo"__ . <p>a__"foo"__</p>Intraword strong emphasis is forbidden with
+__:Intraword strong emphasis is forbidden with
__:-foo__bar__ +foo__bar__ . <p>foo__bar__</p>5__6__78 +5__6__78 . <p>5__6__78</p>пристаням__стремятся__ +пристаням__стремятся__ . <p>пристаням__стремятся__</p>__foo, __bar__, baz__ +__foo, __bar__, baz__ . <p><strong>foo, <strong>bar</strong>, baz</strong></p>This is strong emphasis, even though the opening delimiter is +
This is strong emphasis, even though the opening delimiter is both left- and right-flanking, because it is preceded by punctuation:
--foo-__(bar)__ +foo-__(bar)__ . <p>foo-<strong>(bar)</strong></p>Rule 7:
-This is not strong emphasis, because the closing delimiter is preceded +
Rule 7:
+This is not strong emphasis, because the closing delimiter is preceded by whitespace:
--**foo bar ** +**foo bar ** . <p>**foo bar **</p>(Nor can it be interpreted as an emphasized
*foo bar *, because of +(Nor can it be interpreted as an emphasized
-*foo bar *, because of Rule 11.)This is not strong emphasis, because the second
**is +This is not strong emphasis, because the second
**is preceded by punctuation and followed by an alphanumeric:--**(**foo) +**(**foo) . <p>**(**foo)</p>The point of this restriction is more easily appreciated +
The point of this restriction is more easily appreciated with these examples:
-*(**foo**)* +*(**foo**)* . <p><em>(<strong>foo</strong>)</em></p>**Gomphocarpus (*Gomphocarpus physocarpus*, syn. +**Gomphocarpus (*Gomphocarpus physocarpus*, syn. *Asclepias physocarpa*)** . <p><strong>Gomphocarpus (<em>Gomphocarpus physocarpus</em>, syn. @@ -5969,278 +5966,278 @@ with these examples:**foo "*bar*" foo** +**foo "*bar*" foo** . <p><strong>foo "<em>bar</em>" foo</strong></p>Intraword emphasis:
+Intraword emphasis:
--**foo**bar +**foo**bar . <p><strong>foo</strong>bar</p>Rule 8:
-This is not strong emphasis, because the closing delimiter is +
Rule 8:
+This is not strong emphasis, because the closing delimiter is preceded by whitespace:
--__foo bar __ +__foo bar __ . <p>__foo bar __</p>This is not strong emphasis, because the second
__is +This is not strong emphasis, because the second
__is preceded by punctuation and followed by an alphanumeric:--__(__foo) +__(__foo) . <p>__(__foo)</p>The point of this restriction is more easily appreciated +
The point of this restriction is more easily appreciated with this example:
--_(__foo__)_ +_(__foo__)_ . <p><em>(<strong>foo</strong>)</em></p>Intraword strong emphasis is forbidden with
+__:Intraword strong emphasis is forbidden with
__:-__foo__bar +__foo__bar . <p>__foo__bar</p>__пристаням__стремятся +__пристаням__стремятся . <p>__пристаням__стремятся</p>__foo__bar__baz__ +__foo__bar__baz__ . <p><strong>foo__bar__baz</strong></p>This is strong emphasis, even though the closing delimiter is +
This is strong emphasis, even though the closing delimiter is both left- and right-flanking, because it is followed by punctuation:
--__(bar)__. +__(bar)__. . <p><strong>(bar)</strong>.</p>Rule 9:
-Any nonempty sequence of inline elements can be the contents of an +
Rule 9:
+Any nonempty sequence of inline elements can be the contents of an emphasized span.
-*foo [bar](/url)* +*foo [bar](/url)* . <p><em>foo <a href="/url">bar</a></em></p>*foo +*foo bar* . <p><em>foo bar</em></p>In particular, emphasis and strong emphasis can be nested +
In particular, emphasis and strong emphasis can be nested inside emphasis:
-_foo __bar__ baz_ +_foo __bar__ baz_ . <p><em>foo <strong>bar</strong> baz</em></p>_foo _bar_ baz_ +_foo _bar_ baz_ . <p><em>foo <em>bar</em> baz</em></p>__foo_ bar_ +__foo_ bar_ . <p><em><em>foo</em> bar</em></p>*foo *bar** +*foo *bar** . <p><em>foo <em>bar</em></em></p>*foo **bar** baz* +*foo **bar** baz* . <p><em>foo <strong>bar</strong> baz</em></p>*foo**bar**baz* +*foo**bar**baz* . <p><em>foo<strong>bar</strong>baz</em></p>Note that in the preceding case, the interpretation
+Note that in the preceding case, the interpretation
--+<p><em>foo</em><em>bar<em></em>baz</em></p><p><em>foo</em><em>bar<em></em>baz</em></p>is precluded by the condition that a delimiter that +
is precluded by the condition that a delimiter that can both open and close (like the
-*afterfoo) cannot form emphasis if the sum of the lengths of the delimiter runs containing the opening and closing delimiters is a multiple of 3 unless both lengths are multiples of 3.For the same reason, we don't get two consecutive +
For the same reason, we don't get two consecutive emphasis sections in this example:
--*foo**bar* +*foo**bar* . <p><em>foo**bar</em></p>The same condition ensures that the following +
The same condition ensures that the following cases are all strong emphasis nested inside emphasis, even when the interior spaces are omitted:
-***foo** bar* +***foo** bar* . <p><em><strong>foo</strong> bar</em></p>*foo **bar*** +*foo **bar*** . <p><em>foo <strong>bar</strong></em></p>*foo**bar*** +*foo**bar*** . <p><em>foo<strong>bar</strong></em></p>When the lengths of the interior closing and opening +
When the lengths of the interior closing and opening delimiter runs are both multiples of 3, though, they can match to create emphasis:
-foo***bar***baz +foo***bar***baz . <p>foo<em><strong>bar</strong></em>baz</p>foo******bar*********baz +foo******bar*********baz . <p>foo<strong><strong><strong>bar</strong></strong></strong>***baz</p>Indefinite levels of nesting are possible:
+Indefinite levels of nesting are possible:
-*foo **bar *baz* bim** bop* +*foo **bar *baz* bim** bop* . <p><em>foo <strong>bar <em>baz</em> bim</strong> bop</em></p>*foo [*bar*](/url)* +*foo [*bar*](/url)* . <p><em>foo <a href="/url"><em>bar</em></a></em></p>There can be no empty emphasis or strong emphasis:
+There can be no empty emphasis or strong emphasis:
-** is not an empty emphasis +** is not an empty emphasis . <p>** is not an empty emphasis</p>**** is not an empty strong emphasis +**** is not an empty strong emphasis . <p>**** is not an empty strong emphasis</p>Rule 10:
-Any nonempty sequence of inline elements can be the contents of an +
Rule 10:
+Any nonempty sequence of inline elements can be the contents of an strongly emphasized span.
-**foo [bar](/url)** +**foo [bar](/url)** . <p><strong>foo <a href="/url">bar</a></strong></p>**foo +**foo bar** . <p><strong>foo bar</strong></p>In particular, emphasis and strong emphasis can be nested +
In particular, emphasis and strong emphasis can be nested inside strong emphasis:
-__foo _bar_ baz__ +__foo _bar_ baz__ . <p><strong>foo <em>bar</em> baz</strong></p>__foo __bar__ baz__ +__foo __bar__ baz__ . <p><strong>foo <strong>bar</strong> baz</strong></p>____foo__ bar__ +____foo__ bar__ . <p><strong><strong>foo</strong> bar</strong></p>**foo **bar**** +**foo **bar**** . <p><strong>foo <strong>bar</strong></strong></p>**foo *bar* baz** +**foo *bar* baz** . <p><strong>foo <em>bar</em> baz</strong></p>**foo*bar*baz** +**foo*bar*baz** . <p><strong>foo<em>bar</em>baz</strong></p>***foo* bar** +***foo* bar** . <p><strong><em>foo</em> bar</strong></p>**foo *bar*** +**foo *bar*** . <p><strong>foo <em>bar</em></strong></p>Indefinite levels of nesting are possible:
+Indefinite levels of nesting are possible:
-**foo *bar **baz** +**foo *bar **baz** bim* bop** . <p><strong>foo <em>bar <strong>baz</strong> @@ -6248,334 +6245,334 @@ inside strong emphasis:**foo [*bar*](/url)** +**foo [*bar*](/url)** . <p><strong>foo <a href="/url"><em>bar</em></a></strong></p>There can be no empty emphasis or strong emphasis:
+There can be no empty emphasis or strong emphasis:
-__ is not an empty emphasis +__ is not an empty emphasis . <p>__ is not an empty emphasis</p>____ is not an empty strong emphasis +____ is not an empty strong emphasis . <p>____ is not an empty strong emphasis</p>Rule 11:
+Rule 11:
-foo *** +foo *** . <p>foo ***</p>foo *\** +foo *\** . <p>foo <em>*</em></p>foo *_* +foo *_* . <p>foo <em>_</em></p>foo ***** +foo ***** . <p>foo *****</p>foo **\*** +foo **\*** . <p>foo <strong>*</strong></p>foo **_** +foo **_** . <p>foo <strong>_</strong></p>Note that when delimiters do not match evenly, Rule 11 determines +
Note that when delimiters do not match evenly, Rule 11 determines that the excess literal
*characters will appear outside of the emphasis, rather than inside it:-**foo* +**foo* . <p>*<em>foo</em></p>*foo** +*foo** . <p><em>foo</em>*</p>***foo** +***foo** . <p>*<strong>foo</strong></p>****foo* +****foo* . <p>***<em>foo</em></p>**foo*** +**foo*** . <p><strong>foo</strong>*</p>*foo**** +*foo**** . <p><em>foo</em>***</p>Rule 12:
+Rule 12:
-foo ___ +foo ___ . <p>foo ___</p>foo _\__ +foo _\__ . <p>foo <em>_</em></p>foo _*_ +foo _*_ . <p>foo <em>*</em></p>foo _____ +foo _____ . <p>foo _____</p>foo __\___ +foo __\___ . <p>foo <strong>_</strong></p>foo __*__ +foo __*__ . <p>foo <strong>*</strong></p>__foo_ +__foo_ . <p>_<em>foo</em></p>Note that when delimiters do not match evenly, Rule 12 determines +
Note that when delimiters do not match evenly, Rule 12 determines that the excess literal
_characters will appear outside of the emphasis, rather than inside it:-_foo__ +_foo__ . <p><em>foo</em>_</p>___foo__ +___foo__ . <p>_<strong>foo</strong></p>____foo_ +____foo_ . <p>___<em>foo</em></p>__foo___ +__foo___ . <p><strong>foo</strong>_</p>_foo____ +_foo____ . <p><em>foo</em>___</p>Rule 13 implies that if you want emphasis nested directly inside +
Rule 13 implies that if you want emphasis nested directly inside emphasis, you must use different delimiters:
-**foo** +**foo** . <p><strong>foo</strong></p>*_foo_* +*_foo_* . <p><em><em>foo</em></em></p>__foo__ +__foo__ . <p><strong>foo</strong></p>_*foo*_ +_*foo*_ . <p><em><em>foo</em></em></p>However, strong emphasis within strong emphasis is possible without +
However, strong emphasis within strong emphasis is possible without switching delimiters:
-****foo**** +****foo**** . <p><strong><strong>foo</strong></strong></p>____foo____ +____foo____ . <p><strong><strong>foo</strong></strong></p>Rule 13 can be applied to arbitrarily long sequences of +
Rule 13 can be applied to arbitrarily long sequences of delimiters:
--******foo****** +******foo****** . <p><strong><strong><strong>foo</strong></strong></strong></p>Rule 14:
+Rule 14:
-***foo*** +***foo*** . <p><em><strong>foo</strong></em></p>_____foo_____ +_____foo_____ . <p><em><strong><strong>foo</strong></strong></em></p>Rule 15:
+Rule 15:
-*foo _bar* baz_ +*foo _bar* baz_ . <p><em>foo _bar</em> baz_</p>*foo __bar *baz bim__ bam* +*foo __bar *baz bim__ bam* . <p><em>foo <strong>bar *baz bim</strong> bam</em></p>Rule 16:
+Rule 16:
-**foo **bar baz** +**foo **bar baz** . <p>**foo <strong>bar baz</strong></p>*foo *bar baz* +*foo *bar baz* . <p>*foo <em>bar baz</em></p>Rule 17:
+Rule 17:
-*[bar*](/url) +*[bar*](/url) . <p>*<a href="/url">bar*</a></p>_foo [bar_](/url) +_foo [bar_](/url) . <p>_foo <a href="/url">bar_</a></p>*<img src="foo" title="*"/> +*<img src="foo" title="*"/> . <p>*<img src="foo" title="*"/></p>**<a href="**"> +**<a href="**"> . <p>**<a href="**"></p>__<a href="__"> +__<a href="__"> . <p>__<a href="__"></p>*a `*`* +*a `*`* . <p><em>a <code>*</code></em></p>_a `_`_ +_a `_`_ . <p><em>a <code>_</code></em></p>**a<http://foo.bar/?q=**> +**a<http://foo.bar/?q=**> . <p>**a<a href="http://foo.bar/?q=**">http://foo.bar/?q=**</a></p>__a<http://foo.bar/?q=__> +__a<http://foo.bar/?q=__> . <p>__a<a href="http://foo.bar/?q=__">http://foo.bar/?q=__</a></p>+
Strikethrough (extension)
-GFM enables the
strikethroughextension, where an additional emphasis type is +GFM enables the
-strikethroughextension, where an additional emphasis type is available.Strikethrough text is any text wrapped in two tildes (
+~).Strikethrough text is any text wrapped in two tildes (
~).--~~Hi~~ Hello, world! +~~Hi~~ Hello, world! . <p><del>Hi</del> Hello, world!</p>As with regular emphasis delimiters, a new paragraph will cause strikethrough +
As with regular emphasis delimiters, a new paragraph will cause strikethrough parsing to cease:
-This ~~has a +This ~~has a new paragraph~~. . @@ -6584,49 +6581,49 @@ parsing to cease:+
Links
-A link contains [link text] (the visible text), a [link destination] +
A link contains [link text] (the visible text), a [link destination] (the URI that is the link destination), and optionally a [link title]. There are two basic kinds of links in Markdown. In [inline links] the destination and title are given immediately after the link text. In [reference links] the destination and title are defined elsewhere in the document.
-A link text consists of a sequence of zero or more +
A link text consists of a sequence of zero or more inline elements enclosed by square brackets (
-[and]). The following rules apply:-
- -
Links may not contain other links, at any level of nesting. If +
+
-- +
-Links may not contain other links, at any level of nesting. If multiple otherwise valid link definitions appear nested inside each other, the inner-most definition is used.
- -
Brackets are allowed in the [link text] only if (a) they +
- +
-Brackets are allowed in the [link text] only if (a) they are backslash-escaped or (b) they appear as a matched pair of brackets, with an open bracket
[, a sequence of zero or more inlines, and a close bracket].- -
Backtick [code spans], [autolinks], and raw [HTML tags] bind more tightly +
- +
-Backtick [code spans], [autolinks], and raw [HTML tags] bind more tightly than the brackets in link text. Thus, for example,
[foo`]`could not be a link text, since the second]is part of a code span.- -
The brackets in link text bind more tightly than markers for +
- +
The brackets in link text bind more tightly than markers for [emphasis and strong emphasis]. Thus, for example,
*[foo*](url)is a link.A link destination consists of either
--
- -
a sequence of zero or more characters between an opening
<and a +A link destination consists of either
++
-- +
-a sequence of zero or more characters between an opening
<and a closing>that contains no line breaks or unescaped<or>characters, or- -
a nonempty sequence of characters that does not start with +
- +
a nonempty sequence of characters that does not start with
<, does not include ASCII space or control characters, and includes parentheses only if (a) they are backslash-escaped or (b) they are part of a balanced pair of unescaped parentheses. @@ -6635,27 +6632,27 @@ avoid performance issues, but at least three levels of nesting should be supported.)A link title consists of either
--
- -
a sequence of zero or more characters between straight double-quote +
A link title consists of either
++
-- +
-a sequence of zero or more characters between straight double-quote characters (
"), including a"character only if it is backslash-escaped, or- -
a sequence of zero or more characters between straight single-quote +
- +
-a sequence of zero or more characters between straight single-quote characters (
'), including a'character only if it is backslash-escaped, or- -
a sequence of zero or more characters between matching parentheses +
- +
a sequence of zero or more characters between matching parentheses (
(...)), including a(or)character only if it is backslash-escaped.Although [link titles] may span multiple lines, they may not contain +
Although [link titles] may span multiple lines, they may not contain a [blank line].
-An inline link consists of a [link text] followed immediately +
An inline link consists of a [link text] followed immediately by a left parenthesis
-(, optional [whitespace], an optional [link destination], an optional [link title] separated from the link destination by [whitespace], optional [whitespace], and a right @@ -6666,51 +6663,51 @@ The link's URI consists of the link destination, excluding enclosing above. The link's title consists of the link title, excluding its enclosing delimiters, with backslash-escapes in effect as described above.Here is a simple inline link:
+Here is a simple inline link:
--[link](/uri "title") +[link](/uri "title") . <p><a href="/uri" title="title">link</a></p>The title may be omitted:
+The title may be omitted:
--[link](/uri) +[link](/uri) . <p><a href="/uri">link</a></p>Both the title and the destination may be omitted:
+Both the title and the destination may be omitted:
-[link]() +[link]() . <p><a href="">link</a></p>[link](<>) +[link](<>) . <p><a href="">link</a></p>The destination can only contain spaces if it is +
The destination can only contain spaces if it is enclosed in pointy brackets:
-[link](/my uri) +[link](/my uri) . <p>[link](/my uri)</p>[link](</my uri>) +[link](</my uri>) . <p><a href="/my%20uri">link</a></p>The destination cannot contain line breaks, +
The destination cannot contain line breaks, even if enclosed in pointy brackets:
-[link](foo +[link](foo bar) . <p>[link](foo @@ -6718,32 +6715,32 @@ even if enclosed in pointy brackets:[link](<foo +[link](<foo bar>) . <p>[link](<foo bar>)</p>The destination can contain
)if it is enclosed +The destination can contain
)if it is enclosed in pointy brackets:--[a](<b)c>) +[a](<b)c>) . <p><a href="b)c">a</a></p>Pointy brackets that enclose links must be unescaped:
+Pointy brackets that enclose links must be unescaped:
--[link](<foo\>) +[link](<foo\>) . <p>[link](<foo>)</p>These are not links, because the opening pointy bracket +
These are not links, because the opening pointy bracket is not matched properly:
--[a](<b)c +[a](<b)c [a](<b)c> [a](<b>c) . @@ -6752,46 +6749,46 @@ is not matched properly: [a](<b>c)</p>Parentheses inside the link destination may be escaped:
+Parentheses inside the link destination may be escaped:
--[link](\(foo\)) +[link](\(foo\)) . <p><a href="(foo)">link</a></p>Any number of parentheses are allowed without escaping, as long as they are +
Any number of parentheses are allowed without escaping, as long as they are balanced:
--[link](foo(and(bar))) +[link](foo(and(bar))) . <p><a href="foo(and(bar))">link</a></p>However, if you have unbalanced parentheses, you need to escape or use the +
However, if you have unbalanced parentheses, you need to escape or use the
<...>form:-[link](foo\(and\(bar\)) +[link](foo\(and\(bar\)) . <p><a href="foo(and(bar)">link</a></p>[link](<foo(and(bar)>) +[link](<foo(and(bar)>) . <p><a href="foo(and(bar)">link</a></p>Parentheses and other symbols can also be escaped, as usual +
Parentheses and other symbols can also be escaped, as usual in Markdown:
--[link](foo\)\:) +[link](foo\)\:) . <p><a href="foo):">link</a></p>A link can contain fragment identifiers and queries:
+A link can contain fragment identifiers and queries:
--[link](#fragment) +[link](#fragment) [link](http://example.com#fragment) @@ -6802,15 +6799,15 @@ in Markdown: <p><a href="http://example.com?foo=3#frag">link</a></p>Note that a backslash before a non-escapable character is +
Note that a backslash before a non-escapable character is just a backslash:
--[link](foo\bar) +[link](foo\bar) . <p><a href="foo%5Cbar">link</a></p>URL-escaping should be left alone inside the destination, as all +
URL-escaping should be left alone inside the destination, as all URL-escaped characters are also valid URL characters. Entity and numerical character references in the destination will be parsed into the corresponding Unicode code points, as usual. These may @@ -6819,23 +6816,23 @@ does not enforce any particular policy for rendering URLs in HTML or other formats. Renderers may make different decisions about how to escape or normalize URLs in the output.
--[link](foo%20bä) +[link](foo%20bä) . <p><a href="foo%20b%C3%A4">link</a></p>Note that, because titles can often be parsed as destinations, +
Note that, because titles can often be parsed as destinations, if you try to omit the destination and keep the title, you'll get unexpected results:
--[link]("title") +[link]("title") . <p><a href="%22title%22">link</a></p>Titles may be in single quotes, double quotes, or parentheses:
+Titles may be in single quotes, double quotes, or parentheses:
--[link](/url "title") +[link](/url "title") [link](/url 'title') [link](/url (title)) . @@ -6844,37 +6841,37 @@ get unexpected results: <a href="/url" title="title">link</a></p>Backslash escapes and entity and numeric character references +
Backslash escapes and entity and numeric character references may be used in titles:
--[link](/url "title \""") +[link](/url "title \""") . <p><a href="/url" title="title """>link</a></p>Titles must be separated from the link using a [whitespace]. +
Titles must be separated from the link using a [whitespace]. Other [Unicode whitespace] like non-breaking space doesn't work.
--[link](/url "title") +[link](/url "title") . <p><a href="/url%C2%A0%22title%22">link</a></p>Nested balanced quotes are not allowed without escaping:
+Nested balanced quotes are not allowed without escaping:
--[link](/url "title "and" title") +[link](/url "title "and" title") . <p>[link](/url "title "and" title")</p>But it is easy to work around this by using a different quote type:
+But it is easy to work around this by using a different quote type:
--[link](/url 'title "and" title') +[link](/url 'title "and" title') . <p><a href="/url" title="title "and" title">link</a></p>(Note:
Markdown.pldid allow double quotes inside a double-quoted +(Note:
-Markdown.pldid allow double quotes inside a double-quoted title, and its test suite included a test demonstrating this. But it is hard to see a good rationale for the extra complexity this brings, since there are already many ways---backslash escaping, @@ -6888,136 +6885,136 @@ with"and end with).Markdown.pl1.0.1 titles with no closing quotation mark, though 1.0.2b8 does not. It seems preferable to adopt a simple, rational rule that works the same way in inline links and link reference definitions.)[Whitespace] is allowed around the destination and title:
+[Whitespace] is allowed around the destination and title:
--[link]( /uri +[link]( /uri "title" ) . <p><a href="/uri" title="title">link</a></p>But it is not allowed between the link text and the +
But it is not allowed between the link text and the following parenthesis:
--[link] (/uri) +[link] (/uri) . <p>[link] (/uri)</p>The link text may contain balanced brackets, but not unbalanced ones, +
The link text may contain balanced brackets, but not unbalanced ones, unless they are escaped:
-[link [foo [bar]]](/uri) +[link [foo [bar]]](/uri) . <p><a href="/uri">link [foo [bar]]</a></p>[link] bar](/uri) +[link] bar](/uri) . <p>[link] bar](/uri)</p>[link [bar](/uri) +[link [bar](/uri) . <p>[link <a href="/uri">bar</a></p>[link \[bar](/uri) +[link \[bar](/uri) . <p><a href="/uri">link [bar</a></p>The link text may contain inline content:
+The link text may contain inline content:
-[link *foo **bar** `#`*](/uri) +[link *foo **bar** `#`*](/uri) . <p><a href="/uri">link <em>foo <strong>bar</strong> <code>#</code></em></a></p>[](/uri) +[](/uri) . <p><a href="/uri"><img src="moon.jpg" alt="moon" /></a></p>However, links may not contain other links, at any level of nesting.
+However, links may not contain other links, at any level of nesting.
-[foo [bar](/uri)](/uri) +[foo [bar](/uri)](/uri) . <p>[foo <a href="/uri">bar</a>](/uri)</p>[foo *[bar [baz](/uri)](/uri)*](/uri) +[foo *[bar [baz](/uri)](/uri)*](/uri) . <p>[foo <em>[bar <a href="/uri">baz</a>](/uri)</em>](/uri)</p>](uri2)](uri3) +](uri2)](uri3) . <p><img src="uri3" alt="[foo](uri2)" /></p>These cases illustrate the precedence of link text grouping over +
These cases illustrate the precedence of link text grouping over emphasis grouping:
-*[foo*](/uri) +*[foo*](/uri) . <p>*<a href="/uri">foo*</a></p>[foo *bar](baz*) +[foo *bar](baz*) . <p><a href="baz*">foo *bar</a></p>Note that brackets that aren't part of links do not take +
Note that brackets that aren't part of links do not take precedence:
--*foo [bar* baz] +*foo [bar* baz] . <p><em>foo [bar</em> baz]</p>These cases illustrate the precedence of HTML tags, code spans, +
These cases illustrate the precedence of HTML tags, code spans, and autolinks over link grouping:
-[foo <bar attr="](baz)"> +[foo <bar attr="](baz)"> . <p>[foo <bar attr="](baz)"></p>[foo`](/uri)` +[foo`](/uri)` . <p>[foo<code>](/uri)</code></p>[foo<http://example.com/?search=](uri)> +[foo<http://example.com/?search=](uri)> . <p>[foo<a href="http://example.com/?search=%5D(uri)">http://example.com/?search=](uri)</a></p>There are three kinds of reference links: +
There are three kinds of reference links: full, collapsed, and shortcut.
-A full reference link consists of a [link text] immediately followed by a [link label] that [matches] a [link reference definition] elsewhere in the document.
-A link label begins with a left bracket (
[) and ends +A link label begins with a left bracket (
-[) and ends with the first right bracket (]) that is not backslash-escaped. Between these brackets there must be at least one [non-whitespace character]. Unescaped square bracket characters are not allowed inside the opening and closing square brackets of [link labels]. A link label can have at most 999 characters inside the square brackets.One label matches +
One label matches another just in case their normalized forms are equal. To normalize a label, strip off the opening and closing brackets, perform the Unicode case fold, strip leading and trailing @@ -7025,24 +7022,24 @@ perform the Unicode case fold, strip leading and trailing [whitespace] to a single space. If there are multiple matching reference link definitions, the one that comes first in the document is used. (It is desirable in such cases to emit a warning.)
-The contents of the first link label are parsed as inlines, which are +
The contents of the first link label are parsed as inlines, which are used as the link's text. The link's URI and title are provided by the matching [link reference definition].
-Here is a simple example:
+Here is a simple example:
--[foo][bar] +[foo][bar] [bar]: /url "title" . <p><a href="/url" title="title">foo</a></p>The rules for the [link text] are the same as with +
The rules for the [link text] are the same as with [inline links]. Thus:
-The link text may contain balanced brackets, but not unbalanced ones, +
The link text may contain balanced brackets, but not unbalanced ones, unless they are escaped:
-[link [foo [bar]]][ref] +[link [foo [bar]]][ref] [ref]: /uri . @@ -7050,16 +7047,16 @@ unless they are escaped:[link \[bar][ref] +[link \[bar][ref] [ref]: /uri . <p><a href="/uri">link [bar</a></p>The link text may contain inline content:
+The link text may contain inline content:
-[link *foo **bar** `#`*][ref] +[link *foo **bar** `#`*][ref] [ref]: /uri . @@ -7067,16 +7064,16 @@ unless they are escaped:[][ref] +[][ref] [ref]: /uri . <p><a href="/uri"><img src="moon.jpg" alt="moon" /></a></p>However, links may not contain other links, at any level of nesting.
+However, links may not contain other links, at any level of nesting.
-[foo [bar](/uri)][ref] +[foo [bar](/uri)][ref] [ref]: /uri . @@ -7084,19 +7081,19 @@ unless they are escaped:[foo *bar [baz][ref]*][ref] +[foo *bar [baz][ref]*][ref] [ref]: /uri . <p>[foo <em>bar <a href="/uri">baz</a></em>]<a href="/uri">ref</a></p>(In the examples above, we have two [shortcut reference links] +
(In the examples above, we have two [shortcut reference links] instead of one [full reference link].)
-The following cases illustrate the precedence of link text grouping over +
The following cases illustrate the precedence of link text grouping over emphasis grouping:
-*[foo*][ref] +*[foo*][ref] [ref]: /uri . @@ -7104,17 +7101,17 @@ emphasis grouping:[foo *bar][ref] +[foo *bar][ref] [ref]: /uri . <p><a href="/uri">foo *bar</a></p>These cases illustrate the precedence of HTML tags, code spans, +
These cases illustrate the precedence of HTML tags, code spans, and autolinks over link grouping:
-[foo <bar attr="][ref]"> +[foo <bar attr="][ref]"> [ref]: /uri . @@ -7122,7 +7119,7 @@ and autolinks over link grouping:[foo`][ref]` +[foo`][ref]` [ref]: /uri . @@ -7130,35 +7127,35 @@ and autolinks over link grouping:[foo<http://example.com/?search=][ref]> +[foo<http://example.com/?search=][ref]> [ref]: /uri . <p>[foo<a href="http://example.com/?search=%5D%5Bref%5D">http://example.com/?search=][ref]</a></p>Matching is case-insensitive:
+Matching is case-insensitive:
--[foo][BaR] +[foo][BaR] [bar]: /url "title" . <p><a href="/url" title="title">foo</a></p>Unicode case fold is used:
+Unicode case fold is used:
--[Толпой][Толпой] is a Russian word. +[Толпой][Толпой] is a Russian word. [ТОЛПОЙ]: /url . <p><a href="/url">Толпой</a> is a Russian word.</p>Consecutive internal [whitespace] is treated as one space for +
Consecutive internal [whitespace] is treated as one space for purposes of determining matching:
--[Foo +[Foo bar]: /url [Baz][Foo bar] @@ -7166,10 +7163,10 @@ purposes of determining matching: <p><a href="/url">Baz</a></p>No [whitespace] is allowed between the [link text] and the +
No [whitespace] is allowed between the [link text] and the [link label]:
-[foo] [bar] +[foo] [bar] [bar]: /url "title" . @@ -7177,7 +7174,7 @@ purposes of determining matching:[foo] +[foo] [bar] [bar]: /url "title" @@ -7186,7 +7183,7 @@ purposes of determining matching: <a href="/url" title="title">bar</a></p>This is a departure from John Gruber's original Markdown syntax +
This is a departure from John Gruber's original Markdown syntax description, which explicitly allows whitespace between the link text and the link label. It brings reference links in line with [inline links], which (according to both original Markdown and @@ -7197,24 +7194,24 @@ link text and the link label, then in the following we will have a single reference link, not two shortcut reference links, as intended:
--[foo] +[foo] [bar] [foo]: /url1 [bar]: /url2(Note that [shortcut reference links] were introduced by Gruber +
(Note that [shortcut reference links] were introduced by Gruber himself in a beta version of
-Markdown.pl, but never included in the official syntax description. Without shortcut reference links, it is harmless to allow space between the link text and link label; but once shortcut references are introduced, it is too dangerous to allow this, as it frequently leads to unintended results.)When there are multiple matching [link reference definitions], +
When there are multiple matching [link reference definitions], the first is used:
--[foo]: /url1 +[foo]: /url1 [foo]: /url2 @@ -7223,21 +7220,21 @@ the first is used: <p><a href="/url1">bar</a></p>Note that matching is performed on normalized strings, not parsed +
Note that matching is performed on normalized strings, not parsed inline content. So the following does not match, even though the labels define equivalent inline content:
--[bar][foo\!] +[bar][foo\!] [foo!]: /url . <p>[bar][foo!]</p>[Link labels] cannot contain brackets, unless they are +
[Link labels] cannot contain brackets, unless they are backslash-escaped:
-[foo][ref[] +[foo][ref[] [ref[]: /uri . @@ -7246,7 +7243,7 @@ backslash-escaped:[foo][ref[bar]] +[foo][ref[bar]] [ref[bar]]: /uri . @@ -7255,7 +7252,7 @@ backslash-escaped:[[[foo]]] +[[[foo]]] [[[foo]]]: /url . @@ -7264,25 +7261,25 @@ backslash-escaped:[foo][ref\[] +[foo][ref\[] [ref\[]: /uri . <p><a href="/uri">foo</a></p>Note that in this example
+]is not backslash-escaped:Note that in this example
]is not backslash-escaped:--[bar\\]: /uri +[bar\\]: /uri [bar\\] . <p><a href="/uri">bar\</a></p>A [link label] must contain at least one [non-whitespace character]:
+A [link label] must contain at least one [non-whitespace character]:
-[] +[] []: /uri . @@ -7291,7 +7288,7 @@ backslash-escaped:[ +[ ] [ @@ -7303,7 +7300,7 @@ backslash-escaped: ]: /uri</p>A collapsed reference link consists of a [link label] that [matches] a [link reference definition] elsewhere in the document, followed by the string
[]. @@ -7312,7 +7309,7 @@ which are used as the link's text. The link's URI and title are provided by the matching reference link definition. Thus,[foo][]is equivalent to[foo][foo].-[foo][] +[foo][] [foo]: /url "title" . @@ -7320,26 +7317,26 @@ provided by the matching reference link definition. Thus,[*foo* bar][] +[*foo* bar][] [*foo* bar]: /url "title" . <p><a href="/url" title="title"><em>foo</em> bar</a></p>The link labels are case-insensitive:
+The link labels are case-insensitive:
--[Foo][] +[Foo][] [foo]: /url "title" . <p><a href="/url" title="title">Foo</a></p>As with full reference links, [whitespace] is not +
As with full reference links, [whitespace] is not allowed between the two sets of brackets:
--[foo] +[foo] [] [foo]: /url "title" @@ -7348,7 +7345,7 @@ allowed between the two sets of brackets: []</p>A shortcut reference link consists of a [link label] that [matches] a [link reference definition] elsewhere in the document and is not followed by
[]or a link label. @@ -7357,7 +7354,7 @@ which are used as the link's text. The link's URI and title are provided by the matching link reference definition. Thus,[foo]is equivalent to[foo][].-[foo] +[foo] [foo]: /url "title" . @@ -7365,7 +7362,7 @@ Thus,[foo]is equivalent to[foo][].[*foo* bar] +[*foo* bar] [*foo* bar]: /url "title" . @@ -7373,7 +7370,7 @@ Thus,[foo]is equivalent to[foo][].[[*foo* bar]] +[[*foo* bar]] [*foo* bar]: /url "title" . @@ -7381,55 +7378,55 @@ Thus,[foo]is equivalent to[foo][].[[bar [foo] +[[bar [foo] [foo]: /url . <p>[[bar <a href="/url">foo</a></p>The link labels are case-insensitive:
+The link labels are case-insensitive:
--[Foo] +[Foo] [foo]: /url "title" . <p><a href="/url" title="title">Foo</a></p>A space after the link text should be preserved:
+A space after the link text should be preserved:
--[foo] bar +[foo] bar [foo]: /url . <p><a href="/url">foo</a> bar</p>If you just want bracketed text, you can backslash-escape the +
If you just want bracketed text, you can backslash-escape the opening bracket to avoid links:
--\[foo] +\[foo] [foo]: /url "title" . <p>[foo]</p>Note that this is a link, because a link label ends with the first +
Note that this is a link, because a link label ends with the first following closing bracket:
--[foo*]: /url +[foo*]: /url *[foo*] . <p>*<a href="/url">foo*</a></p>Full and compact references take precedence over shortcut +
Full and compact references take precedence over shortcut references:
-[foo][bar] +[foo][bar] [foo]: /url1 [bar]: /url2 @@ -7438,16 +7435,16 @@ references:[foo][] +[foo][] [foo]: /url1 . <p><a href="/url1">foo</a></p>Inline links also take precedence:
+Inline links also take precedence:
-[foo]() +[foo]() [foo]: /url1 . @@ -7455,27 +7452,27 @@ references:[foo](not a link) +[foo](not a link) [foo]: /url1 . <p><a href="/url1">foo</a>(not a link)</p>In the following case
[bar][baz]is parsed as a reference, +In the following case
[bar][baz]is parsed as a reference,[foo]as normal text:--[foo][bar][baz] +[foo][bar][baz] [baz]: /url . <p>[foo]<a href="/url">bar</a></p>Here, though,
[foo][bar]is parsed as a reference, since +Here, though,
[foo][bar]is parsed as a reference, since[bar]is defined:--[foo][bar][baz] +[foo][bar][baz] [baz]: /url1 [bar]: /url2 @@ -7483,10 +7480,10 @@ references: <p><a href="/url2">foo</a><a href="/url1">baz</a></p>Here
[foo]is not parsed as a shortcut reference, because it +Here
[foo]is not parsed as a shortcut reference, because it is followed by a link label (even though[bar]is not defined):--[foo][bar][baz] +[foo][bar][baz] [baz]: /url1 [foo]: /url2 @@ -7494,9 +7491,9 @@ is followed by a link label (even though[bar]is not defined): <p>[foo]<a href="/url1">bar</a></p>+
Images
-Syntax for images is like the syntax for links, with one +
Syntax for images is like the syntax for links, with one difference. Instead of [link text], we have an image description. The rules for this are the same as for [link text], except that (a) an @@ -7506,13 +7503,13 @@ An image description has inline elements as its contents. When an image is rendered to HTML, this is standardly used as the image's
altattribute.- + . <p><img src="/url" alt="foo" title="title" /></p>![foo *bar*] +![foo *bar*] [foo *bar*]: train.jpg "train & tracks" . @@ -7520,24 +7517,24 @@ this is standardly used as the image'saltattribute.](/url2) +](/url2) . <p><img src="/url2" alt="foo bar" /></p>](/url2) +](/url2) . <p><img src="/url2" alt="foo bar" /></p>Though this spec is concerned with parsing, not rendering, it is +
Though this spec is concerned with parsing, not rendering, it is recommended that in rendering to HTML, only the plain string content of the [image description] be used. Note that in the above example, the alt attribute's value is
foo bar, notfoo [bar](/url)orfoo <a href="/url">bar</a>. Only the plain string content is rendered, without formatting.-![foo *bar*][] +![foo *bar*][] [foo *bar*]: train.jpg "train & tracks" . @@ -7545,7 +7542,7 @@ content is rendered, without formatting.![foo *bar*][foobar] +![foo *bar*][foobar] [FOOBAR]: train.jpg "train & tracks" . @@ -7553,32 +7550,32 @@ content is rendered, without formatting. + . <p><img src="train.jpg" alt="foo" /></p>My  +My  . <p>My <img src="/path/to/train.jpg" alt="foo bar" title="title" /></p> + . <p><img src="url" alt="foo" /></p> + . <p><img src="/url" alt="" /></p>Reference-style:
+Reference-style:
-![foo][bar] +![foo][bar] [bar]: /url . @@ -7586,16 +7583,16 @@ content is rendered, without formatting.![foo][bar] +![foo][bar] [BAR]: /url . <p><img src="/url" alt="foo" /></p>Collapsed:
+Collapsed:
-![foo][] +![foo][] [foo]: /url "title" . @@ -7603,26 +7600,26 @@ content is rendered, without formatting.![*foo* bar][] +![*foo* bar][] [*foo* bar]: /url "title" . <p><img src="/url" alt="foo bar" title="title" /></p>The labels are case-insensitive:
+The labels are case-insensitive:
--![Foo][] +![Foo][] [foo]: /url "title" . <p><img src="/url" alt="Foo" title="title" /></p>As with reference links, [whitespace] is not allowed +
As with reference links, [whitespace] is not allowed between the two sets of brackets:
--![foo] +![foo] [] [foo]: /url "title" @@ -7631,9 +7628,9 @@ between the two sets of brackets: []</p>Shortcut:
+Shortcut:
-![foo] +![foo] [foo]: /url "title" . @@ -7641,16 +7638,16 @@ between the two sets of brackets:![*foo* bar] +![*foo* bar] [*foo* bar]: /url "title" . <p><img src="/url" alt="foo bar" title="title" /></p>Note that link labels cannot contain unescaped brackets:
+Note that link labels cannot contain unescaped brackets:
--![[foo]] +![[foo]] [[foo]]: /url "title" . @@ -7658,228 +7655,228 @@ between the two sets of brackets: <p>[[foo]]: /url "title"</p>The link labels are case-insensitive:
+The link labels are case-insensitive:
--![Foo] +![Foo] [foo]: /url "title" . <p><img src="/url" alt="Foo" title="title" /></p>If you just want a literal
!followed by bracketed text, you can +If you just want a literal
!followed by bracketed text, you can backslash-escape the opening[:--!\[foo] +!\[foo] [foo]: /url "title" . <p>![foo]</p>If you want a link after a literal
!, backslash-escape the +If you want a link after a literal
!, backslash-escape the!:--\![foo] +\![foo] [foo]: /url "title" . <p>!<a href="/url" title="title">foo</a></p>+
Autolinks
-Autolinks are absolute URIs and email addresses inside +
Autolinks are absolute URIs and email addresses inside
-<and>. They are parsed as links, with the URL or email address as the link label.A URI autolink consists of
<, followed by an +A URI autolink consists of
-<, followed by an [absolute URI] followed by>. It is parsed as a link to the URI, with the URI as the link's label.An absolute URI, +
An absolute URI, for these purposes, consists of a [scheme] followed by a colon (
-:) followed by zero or more characters other than ASCII [whitespace] and control characters,<, and>. If the URI includes these characters, they must be percent-encoded (e.g.%20for a space).For purposes of this spec, a scheme is any sequence +
For purposes of this spec, a scheme is any sequence of 2--32 characters beginning with an ASCII letter and followed by any combination of ASCII letters, digits, or the symbols plus ("+"), period ("."), or hyphen ("-").
-Here are some valid autolinks:
+Here are some valid autolinks:
-<http://foo.bar.baz> +<http://foo.bar.baz> . <p><a href="http://foo.bar.baz">http://foo.bar.baz</a></p><http://foo.bar.baz/test?q=hello&id=22&boolean> +<http://foo.bar.baz/test?q=hello&id=22&boolean> . <p><a href="http://foo.bar.baz/test?q=hello&id=22&boolean">http://foo.bar.baz/test?q=hello&id=22&boolean</a></p><irc://foo.bar:2233/baz> +<irc://foo.bar:2233/baz> . <p><a href="irc://foo.bar:2233/baz">irc://foo.bar:2233/baz</a></p>Uppercase is also fine:
+Uppercase is also fine:
--<MAILTO:FOO@BAR.BAZ> +<MAILTO:FOO@BAR.BAZ> . <p><a href="MAILTO:FOO@BAR.BAZ">MAILTO:FOO@BAR.BAZ</a></p>Note that many strings that count as [absolute URIs] for +
Note that many strings that count as [absolute URIs] for purposes of this spec are not valid URIs, because their schemes are not registered or because of other problems with their syntax:
-<a+b+c:d> +<a+b+c:d> . <p><a href="a+b+c:d">a+b+c:d</a></p><made-up-scheme://foo,bar> +<made-up-scheme://foo,bar> . <p><a href="made-up-scheme://foo,bar">made-up-scheme://foo,bar</a></p><http://../> +<http://../> . <p><a href="http://../">http://../</a></p><localhost:5001/foo> +<localhost:5001/foo> . <p><a href="localhost:5001/foo">localhost:5001/foo</a></p>Spaces are not allowed in autolinks:
+Spaces are not allowed in autolinks:
--<http://foo.bar/baz bim> +<http://foo.bar/baz bim> . <p><http://foo.bar/baz bim></p>Backslash-escapes do not work inside autolinks:
+Backslash-escapes do not work inside autolinks:
--<http://example.com/\[\> +<http://example.com/\[\> . <p><a href="http://example.com/%5C%5B%5C">http://example.com/\[\</a></p>An email autolink +
An email autolink consists of
-<, followed by an [email address], followed by>. The link's label is the email address, and the URL ismailto:followed by the email address.An email address, +
An email address, for these purposes, is anything that matches the non-normative regex from the HTML5 spec:
--/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])? +/^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])? (?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$/Examples of email autolinks:
+Examples of email autolinks:
-<foo@bar.example.com> +<foo@bar.example.com> . <p><a href="mailto:foo@bar.example.com">foo@bar.example.com</a></p><foo+special@Bar.baz-bar0.com> +<foo+special@Bar.baz-bar0.com> . <p><a href="mailto:foo+special@Bar.baz-bar0.com">foo+special@Bar.baz-bar0.com</a></p>Backslash-escapes do not work inside email autolinks:
+Backslash-escapes do not work inside email autolinks:
--<foo\+@bar.example.com> +<foo\+@bar.example.com> . <p><foo+@bar.example.com></p>These are not autolinks:
+These are not autolinks:
-<> +<> . <p><></p>< http://foo.bar > +< http://foo.bar > . <p>< http://foo.bar ></p><m:abc> +<m:abc> . <p><m:abc></p><foo.bar.baz> +<foo.bar.baz> . <p><foo.bar.baz></p>http://example.com +http://example.com . <p>http://example.com</p>foo@bar.example.com +foo@bar.example.com . <p>foo@bar.example.com</p>+
Autolinks (extension)
-GFM enables the
autolinkextension, where autolinks will be recognised in a +GFM enables the
-autolinkextension, where autolinks will be recognised in a greater number of conditions.[Autolink]s can also be constructed without requiring the use of
<and to>+[Autolink]s can also be constructed without requiring the use of
-<and to>to delimit them, although they will be recognized under a smaller set of circumstances. All such recognized autolinks can only come at the beginning of a line, after whitespace, or any of the delimiting characters*,_,~, and(.An extended www autolink will be recognized +
An extended www autolink will be recognized when the text
-www.is found followed by a [valid domain]. A valid domain consists of segments of alphanumeric characters, underscores (_) and hyphens (-) separated by periods (.). There must be at least one period, and no underscores may be present in the last two segments of the domain.The scheme
+httpwill be inserted automatically:The scheme
httpwill be inserted automatically:--www.commonmark.org +www.commonmark.org . <p><a href="http://www.commonmark.org">www.commonmark.org</a></p>After a [valid domain], zero or more non-space non-
+<characters may follow:After a [valid domain], zero or more non-space non-
<characters may follow:--Visit www.commonmark.org/help for more information. +Visit www.commonmark.org/help for more information. . <p>Visit <a href="http://www.commonmark.org/help">www.commonmark.org/help</a> for more information.</p>We then apply extended autolink path validation as follows:
-Trailing punctuation (specifically,
?,!,.,,,:,*,_, and~) +We then apply extended autolink path validation as follows:
+Trailing punctuation (specifically,
?,!,.,,,:,*,_, and~) will not be considered part of the autolink, though they may be included in the interior of the link:--Visit www.commonmark.org. +Visit www.commonmark.org. Visit www.commonmark.org/a.b. . @@ -7887,12 +7884,12 @@ interior of the link: <p>Visit <a href="http://www.commonmark.org/a.b">www.commonmark.org/a.b</a>.</p>When an autolink ends in
), we scan the entire autolink for the total number +When an autolink ends in
), we scan the entire autolink for the total number of parentheses. If there is a greater number of closing parentheses than opening ones, we don't consider the unmatched trailing parentheses part of the autolink, in order to facilitate including an autolink inside a parenthesis:--www.google.com/search?q=Markup+(business) +www.google.com/search?q=Markup+(business) www.google.com/search?q=Markup+(business))) @@ -7906,21 +7903,21 @@ autolink, in order to facilitate including an autolink inside a parenthesis: <p>(<a href="http://www.google.com/search?q=Markup+(business)">www.google.com/search?q=Markup+(business)</a></p>This check is only done when the link ends in a closing parentheses
), so if +This check is only done when the link ends in a closing parentheses
), so if the only parentheses are in the interior of the autolink, no special rules are applied:--www.google.com/search?q=(business))+ok +www.google.com/search?q=(business))+ok . <p><a href="http://www.google.com/search?q=(business))+ok">www.google.com/search?q=(business))+ok</a></p>If an autolink ends in a semicolon (
;), we check to see if it appears to +If an autolink ends in a semicolon (
;), we check to see if it appears to resemble an [entity reference][entity references]; if the preceding text is&followed by one or more alphanumeric characters. If so, it is excluded from the autolink:--www.google.com/search?q=commonmark&hl=en +www.google.com/search?q=commonmark&hl=en www.google.com/search?q=commonmark&hl; . @@ -7928,19 +7925,19 @@ the autolink: <p><a href="http://www.google.com/search?q=commonmark">www.google.com/search?q=commonmark</a>&hl;</p>+
<immediately ends an autolink.
<immediately ends an autolink.--www.commonmark.org/he<lp +www.commonmark.org/he<lp . <p><a href="http://www.commonmark.org/he">www.commonmark.org/he</a><lp</p>An extended url autolink will be recognised when one of the schemes +
An extended url autolink will be recognised when one of the schemes
http://,https://, orftp://, followed by a [valid domain], then zero or more non-space non-<characters according to [extended autolink path validation]:--http://commonmark.org +http://commonmark.org (Visit https://encrypted.google.com/search?q=Markup+(business)) @@ -7951,36 +7948,36 @@ more non-space non-<characters according to <p>Anonymous FTP is available at <a href="ftp://foo.bar.baz">ftp://foo.bar.baz</a>.</p>An extended email autolink will be recognised when an email address is +
An extended email autolink will be recognised when an email address is recognised within any text node. Email addresses are recognised according to the following rules:
--
- One ore more characters which are alphanumeric, or
-.,-,_, or+.- An
-@symbol.- One or more characters which are alphanumeric, or
-or_, ++
-- One ore more characters which are alphanumeric, or
+.,-,_, or+.- An
+@symbol.- One or more characters which are alphanumeric, or
-or_, separated by periods (.). There must be at least one period. The last character must not be one of-or_.The scheme
+mailto:will automatically be added to the generated link:The scheme
mailto:will automatically be added to the generated link:--foo@bar.baz +foo@bar.baz . <p><a href="mailto:foo@bar.baz">foo@bar.baz</a></p>+
+can occur before the@, but not after.
+can occur before the@, but not after.--hello@mail+xyz.example isn't valid, but hello+xyz@mail.example is. +hello@mail+xyz.example isn't valid, but hello+xyz@mail.example is. . <p>hello@mail+xyz.example isn't valid, but <a href="mailto:hello+xyz@mail.example">hello+xyz@mail.example</a> is.</p>
.,-, and_can occur on both sides of the@, but only.may occur at +
.,-, and_can occur on both sides of the@, but only.may occur at the end of the email address, in which case it will not be considered part of the address:-a.b-c_d@a.b +a.b-c_d@a.b a.b-c_d@a.b. @@ -7995,125 +7992,125 @@ the address:+
Raw HTML
-Text between
<and>that looks like an HTML tag is parsed as a +Text between
-<and>that looks like an HTML tag is parsed as a raw HTML tag and will be rendered in HTML without escaping. Tag and attribute names are not limited to current HTML tags, so custom tags (and even, say, DocBook tags) may be used.Here is the grammar for tags:
-A tag name consists of an ASCII letter +
Here is the grammar for tags:
+A tag name consists of an ASCII letter followed by zero or more ASCII letters, digits, or hyphens (
--).An attribute consists of [whitespace], +
An attribute consists of [whitespace], an [attribute name], and an optional [attribute value specification].
-An attribute name +
An attribute name consists of an ASCII letter,
-_, or:, followed by zero or more ASCII letters, digits,_,.,:, or-. (Note: This is the XML specification restricted to ASCII. HTML5 is laxer.)An attribute value specification +
An attribute value specification consists of optional [whitespace], a
-=character, optional [whitespace], and an [attribute value].An attribute value +
An attribute value consists of an [unquoted attribute value], a [single-quoted attribute value], or a [double-quoted attribute value].
-An unquoted attribute value is a nonempty string of characters not including [whitespace],
-",',=,<,>, or`.A single-quoted attribute value +
A single-quoted attribute value consists of
-', zero or more characters not including', and a final'.A double-quoted attribute value +
A double-quoted attribute value consists of
-", zero or more characters not including", and a final".An open tag consists of a
<character, a [tag name], +An open tag consists of a
-<character, a [tag name], zero or more [attributes], optional [whitespace], an optional/character, and a>character.A closing tag consists of the string
</, a +A closing tag consists of the string
-</, a [tag name], optional [whitespace], and the character>.An HTML comment consists of
<!--+ text +-->, +An HTML comment consists of
-<!--+ text +-->, where text does not start with>or->, does not end with-, and does not contain--. (See the HTML5 spec.)A processing instruction consists of the string
-<?, a string of characters not including the string?>, and the string?>.A declaration consists of the +
A declaration consists of the string
-<!, a name consisting of one or more uppercase ASCII letters, [whitespace], a string of characters not including the character>, and the character>.A CDATA section consists of +
A CDATA section consists of the string
-<![CDATA[, a string of characters not including the string]]>, and the string]]>.An HTML tag consists of an [open tag], a [closing tag], +
An HTML tag consists of an [open tag], a [closing tag], an [HTML comment], a [processing instruction], a [declaration], or a [CDATA section].
-Here are some simple open tags:
+Here are some simple open tags:
--<a><bab><c2c> +<a><bab><c2c> . <p><a><bab><c2c></p>Empty elements:
+Empty elements:
--<a/><b2/> +<a/><b2/> . <p><a/><b2/></p>[Whitespace] is allowed:
+[Whitespace] is allowed:
--<a /><b2 +<a /><b2 data="foo" > . <p><a /><b2 data="foo" ></p>With attributes:
+With attributes:
--<a foo="bar" bam = 'baz <em>"</em>' +<a foo="bar" bam = 'baz <em>"</em>' _boolean zoop:33=zoop:33 /> . <p><a foo="bar" bam = 'baz <em>"</em>' _boolean zoop:33=zoop:33 /></p>Custom tag names can be used:
+Custom tag names can be used:
--Foo <responsive-image src="foo.jpg" /> +Foo <responsive-image src="foo.jpg" /> . <p>Foo <responsive-image src="foo.jpg" /></p>Illegal tag names, not parsed as HTML:
+Illegal tag names, not parsed as HTML:
--<33> <__> +<33> <__> . <p><33> <__></p>Illegal attribute names:
+Illegal attribute names:
--<a h*#ref="hi"> +<a h*#ref="hi"> . <p><a h*#ref="hi"></p>Illegal attribute values:
+Illegal attribute values:
--<a href="hi'> <a href=hi'> +<a href="hi'> <a href=hi'> . <p><a href="hi'> <a href=hi'></p>Illegal [whitespace]:
+Illegal [whitespace]:
--< a>< +< a>< foo><bar/ > <foo bar=baz bim!bop /> @@ -8124,30 +8121,30 @@ or a [CDATA section]. bim!bop /></p>Missing [whitespace]:
+Missing [whitespace]:
--<a href='bar'title=title> +<a href='bar'title=title> . <p><a href='bar'title=title></p>Closing tags:
+Closing tags:
--</a></foo > +</a></foo > . <p></a></foo ></p>Illegal attributes in closing tag:
+Illegal attributes in closing tag:
--</a href="foo"> +</a href="foo"> . <p></a href="foo"></p>Comments:
+Comments:
-foo <!-- this is a +foo <!-- this is a comment - with hyphen --> . <p>foo <!-- this is a @@ -8155,14 +8152,14 @@ or a [CDATA section].foo <!-- not a comment -- two hyphens --> +foo <!-- not a comment -- two hyphens --> . <p>foo <!-- not a comment -- two hyphens --></p>Not comments:
+Not comments:
--foo <!--> foo --> +foo <!--> foo --> foo <!-- foo---> . @@ -8170,71 +8167,71 @@ or a [CDATA section]. <p>foo <!-- foo---></p>Processing instructions:
+Processing instructions:
--foo <?php echo $a; ?> +foo <?php echo $a; ?> . <p>foo <?php echo $a; ?></p>Declarations:
+Declarations:
--foo <!ELEMENT br EMPTY> +foo <!ELEMENT br EMPTY> . <p>foo <!ELEMENT br EMPTY></p>CDATA sections:
+CDATA sections:
--foo <![CDATA[>&<]]> +foo <![CDATA[>&<]]> . <p>foo <![CDATA[>&<]]></p>Entity and numeric character references are preserved in HTML +
Entity and numeric character references are preserved in HTML attributes:
--foo <a href="ö"> +foo <a href="ö"> . <p>foo <a href="ö"></p>Backslash escapes do not work in HTML attributes:
+Backslash escapes do not work in HTML attributes:
-foo <a href="\*"> +foo <a href="\*"> . <p>foo <a href="\*"></p><a href="\""> +<a href="\""> . <p><a href="""></p>+
Disallowed Raw HTML (extension)
-GFM enables the
tagfilterextension, where the following HTML tags will be +GFM enables the
-tagfilterextension, where the following HTML tags will be filtered when rendering HTML output:-
- -
<title>- -
<textarea>- -
<style>- -
<xmp>- -
<iframe>- -
<noembed>- -
<noframes>- -
<script>- +
<plaintext>+
-- +
<title>- +
<textarea>- +
<style>- +
<xmp>- +
<iframe>- +
<noembed>- +
<noframes>- +
<script><plaintext>Filtering is done by replacing the leading
<with the entity<. These +Filtering is done by replacing the leading
-<with the entity<. These tags are chosen in particular as they change how HTML is interpreted in a way unique to them (i.e. nested HTML is interpreted differently), and this is usually undesireable in the context of other rendered Markdown content.All other HTML tags are left untouched.
+All other HTML tags are left untouched.
-<strong> <title> <style> <em> +<strong> <title> <style> <em> <blockquote> <xmp> is disallowed. <XMP> is also disallowed. @@ -8247,42 +8244,42 @@ usually undesireable in the context of other rendered Markdown content.+
Hard line breaks
-A line break (not in a code span or HTML tag) that is preceded +
A line break (not in a code span or HTML tag) that is preceded by two or more spaces and does not occur at the end of a block is parsed as a hard line break (rendered in HTML as a
<br />tag):--foo +foo baz . <p>foo<br /> baz</p>For a more visible alternative, a backslash before the +
For a more visible alternative, a backslash before the [line ending] may be used instead of two spaces:
--foo\ +foo\ baz . <p>foo<br /> baz</p>More than two spaces can be used:
+More than two spaces can be used:
--foo +foo baz . <p>foo<br /> baz</p>Leading spaces at the beginning of the next line are ignored:
+Leading spaces at the beginning of the next line are ignored:
-foo +foo bar . <p>foo<br /> @@ -8290,17 +8287,17 @@ in HTML as a<br />tag):foo\ +foo\ bar . <p>foo<br /> bar</p>Line breaks can occur inside emphasis, links, and other constructs +
Line breaks can occur inside emphasis, links, and other constructs that allow inline content:
-*foo +*foo bar* . <p><em>foo<br /> @@ -8308,31 +8305,31 @@ that allow inline content:*foo\ +*foo\ bar* . <p><em>foo<br /> bar</em></p>Line breaks do not occur inside code spans
+Line breaks do not occur inside code spans
-`code +`code span` . <p><code>code span</code></p>`code\ +`code\ span` . <p><code>code\ span</code></p>or HTML tags:
+or HTML tags:
-<a href="foo +<a href="foo bar"> . <p><a href="foo @@ -8340,106 +8337,106 @@ that allow inline content:<a href="foo\ +<a href="foo\ bar"> . <p><a href="foo\ bar"></p>Hard line breaks are for separating inline content within a block. +
Hard line breaks are for separating inline content within a block. Neither syntax for hard line breaks works at the end of a paragraph or other block element:
-foo\ +foo\ . <p>foo\</p>foo +foo . <p>foo</p>### foo\ +### foo\ . <h3>foo\</h3>### foo +### foo . <h3>foo</h3>+
Soft line breaks
-A regular line break (not in a code span or HTML tag) that is not +
A regular line break (not in a code span or HTML tag) that is not preceded by two or more spaces or a backslash is parsed as a softbreak. (A softbreak may be rendered in HTML either as a [line ending] or as a space. The result will be the same in browsers. In the examples here, a [line ending] will be used.)
--foo +foo baz . <p>foo baz</p>Spaces at the end of the line and beginning of the next line are +
Spaces at the end of the line and beginning of the next line are removed:
--foo +foo baz . <p>foo baz</p>A conforming parser may render a soft line break in HTML either as a +
A conforming parser may render a soft line break in HTML either as a line break or as a space.
-A renderer may also provide an option to render soft line breaks +
A renderer may also provide an option to render soft line breaks as hard line breaks.
-+
Textual content
-Any characters not given an interpretation by the above rules will +
Any characters not given an interpretation by the above rules will be parsed as plain textual content.
-hello $.;'there +hello $.;'there . <p>hello $.;'there</p>Foo χρῆν +Foo χρῆν . <p>Foo χρῆν</p>Internal spaces are preserved verbatim:
+Internal spaces are preserved verbatim:
--Multiple spaces +Multiple spaces . <p>Multiple spaces</p>+
GitLab Official Specification Markdown
-Currently, only some of the GitLab-specific markdown features are -listed in this section. We will eventually add all +
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 user-facing documentation for GitLab Flavored Markdown.
-There is currently only this single top-level heading, but the +
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 +
See the footnotes section of the user-facing documentation for GitLab Flavored Markdown.
--footnote reference tag [^fortytwo] +footnote reference tag [^fortytwo] [^fortytwo]: footnote text . @@ -8464,19 +8461,19 @@ examples may be split into multiple top-level headings in the future. </section>+
Task list items
-See +
See Task lists in the GitLab Flavored Markdown documentation.
-Task list items (checkboxes) are defined as a GitHub Flavored Markdown extension in a section above. +
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:
+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:
--- [ ] incomplete +- [ ] incomplete . <ul> <li> @@ -8487,9 +8484,9 @@ GitLab Flavored Markdown specification. </ul>Completed task:
+Completed task:
--- [x] completed +- [x] completed . <ul> <li> @@ -8500,9 +8497,9 @@ GitLab Flavored Markdown specification. </ul>Inapplicable task:
+Inapplicable task:
--- [~] inapplicable +- [~] inapplicable . <ul> <li> @@ -8515,10 +8512,10 @@ GitLab Flavored Markdown specification. </ul>Inapplicable task in a "loose" list. Note that the
<del>tag is not applied to the +Inapplicable task in a "loose" list. Note that the
<del>tag is not applied to the loose text; it has strikethrough applied with CSS.--- [~] inapplicable +- [~] inapplicable text in loose list . @@ -8538,15 +8535,15 @@ loose text; it has strikethrough applied with CSS. </ul>+
Front matter
-See +
See Front matter in the GitLab Flavored Markdown documentation.
-Front matter is metadata included at the beginning of a Markdown document, preceding the content. +
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:
+YAML front matter:
----- +--- title: YAML front matter --- . @@ -8557,9 +8554,9 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe </pre>TOML front matter:
+TOML front matter:
--+++ ++++ title: TOML front matter +++ . @@ -8570,9 +8567,9 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe </pre>JSON front matter:
+JSON front matter:
--;;; +;;; { "title": "JSON front matter" } @@ -8587,9 +8584,9 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe </pre>Front matter blocks should be inserted at the top of the document:
+Front matter blocks should be inserted at the top of the document:
--text +text --- title: YAML front matter @@ -8600,9 +8597,9 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <h2>title: YAML front matter</h2>Front matter block delimiters shouldn’t be preceded by space characters:
+Front matter block delimiters shouldn’t be preceded by space characters:
----- +--- title: YAML front matter --- . @@ -8610,14 +8607,13 @@ This data can be used by static site generators like Jekyll, Hugo, and many othe <h2>title: YAML front matter</h2>+
Table of contents
-See +
See table of contents in the GitLab Flavored Markdown documentation.
-A table of contents is an unordered list that links to subheadings in the document. +
A table of contents is an unordered list that links to subheadings in the document. Add either the
[[_TOC_]]or-
- Introduction
- Preliminaries
- Characters and lines
@@ -8688,23 +8684,9 @@ Add either the[[_TOC_]]or- -Appendix: A parsing strategy -
-[TOC] +[TOC] # Heading 1 @@ -8723,7 +8705,7 @@ Add either the[[_TOC_]]or
[[_TOC_]] +[[_TOC_]] # Heading 1 @@ -8741,10 +8723,10 @@ Add either the[[_TOC_]]or<h2>Heading 2</h2>
A table of contents is a block element. It should preceded and followed by a blank +
A table of contents is a block element. It should preceded and followed by a blank line.
--[[_TOC_]] +[[_TOC_]] text text @@ -8754,9 +8736,9 @@ line. <p>text[TOC]</p>A table of contents can be indented with up to three spaces.
+A table of contents can be indented with up to three spaces.
--[[_TOC_]] +[[_TOC_]] # Heading 1 . @@ -8768,452 +8750,100 @@ line. <h1>Heading 1</h1>+
GitLab Internal Extension Markdown
-+
Audio
-See +
See audio in the GitLab Flavored Markdown documentation.
-GLFM renders image elements as an audio player as long as the resource’s file extension is +
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.-- + . <p><audio src="audio.oga" title="audio title"></audio></p>Reference definitions work audio as well:
+Reference definitions work audio as well:
--[audio]: audio.oga "audio title" +[audio]: audio.oga "audio title" ![audio][audio] . <p><audio src="audio.oga" title="audio title"></audio></p>+
Video
-See +
See videos in the GitLab Flavored Markdown documentation.
-GLFM renders image elements as a video player as long as the resource’s file extension is +
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.-- + . <p><video src="video.m4v" title="video title"></video></p>Reference definitions work video as well:
+Reference definitions work video as well:
--[video]: video.mov "video title" +[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
PreviewMarkdownmodule +This section contains examples of all controllers which use
-PreviewMarkdownmodule and use differentmarkdown_context_params. They exercise the variouspreview_markdownendpoints viaglfm_example_metadata.yml.+
preview_markdownexercisinggroupsAPI endpoint andUploadLinkFilter:
preview_markdownexercisinggroupsAPI endpoint andUploadLinkFilter:--[groups-test-file](/uploads/groups-test-file) +[groups-test-file](/uploads/groups-test-file) . <p><a href="groups-test-file">groups-test-file</a></p>+
preview_markdownexercisingprojectsAPI endpoint andRepositoryLinkFilter:
preview_markdownexercisingprojectsAPI endpoint andRepositoryLinkFilter:--[projects-test-file](projects-test-file) +[projects-test-file](projects-test-file) . <p><a href="projects-test-file">projects-test-file</a></p>+
preview_markdownexercisingprojectsAPI endpoint andSnippetReferenceFilter:
preview_markdownexercisingprojectsAPI endpoint andSnippetReferenceFilter:--This project snippet ID reference IS filtered: $88888 +This project snippet ID reference IS filtered: $88888 . <p>This project snippet ID reference IS filtered: $88888</p>
preview_markdownexercising personal (non-project)snippetsAPI endpoint. This is +
preview_markdownexercising personal (non-project)snippetsAPI 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 viaSnippetReferenceFilter, even if the ID is valid.--This personal snippet ID reference is not filtered: $99999 +This personal snippet ID reference is not filtered: $99999 . <p>This personal snippet ID reference is not filtered: $99999</p>+
preview_markdownexercising projectwikisAPI endpoint andWikiLinkFilter:
preview_markdownexercising projectwikisAPI endpoint andWikiLinkFilter:--[project-wikis-test-file](project-wikis-test-file) +[project-wikis-test-file](project-wikis-test-file) . <p><a href="project-wikis-test-file">project-wikis-test-file</a></p>
preview_markdownexercising groupwikisAPI endpoint andWikiLinkFilter. This example +
preview_markdownexercising groupwikisAPI endpoint andWikiLinkFilter. This example also requires an EE license enabling thegroup_wikisfeature:-- -[group-wikis-test-file](group-wikis-test-file) +[group-wikis-test-file](group-wikis-test-file) . <p><a href="group-wikis-test-file">group-wikis-test-file</a></p>-Appendix: A parsing strategy
-In this appendix we describe some features of the parsing strategy -used in the CommonMark reference implementations.
--Overview
-Parsing has two phases:
--
-- -
-In the first phase, lines of input are consumed and the block -structure of the document---its division into paragraphs, block quotes, -list items, and so on---is constructed. Text is assigned to these -blocks but not parsed. Link reference definitions are parsed and a -map of links is constructed.
-- -
-In the second phase, the raw text contents of paragraphs and headings -are parsed into sequences of Markdown inline elements (strings, -code spans, links, emphasis, and so on), using the map of link -references constructed in phase 1.
-At each point in processing, the document is represented as a tree of -blocks. The root of the tree is a
-documentblock. Thedocument-may have any number of other blocks as children. These children -may, in turn, have other blocks as children. The last child of a block -is normally considered open, meaning that subsequent lines of input -can alter its contents. (Blocks that are not open are closed.) -Here, for example, is a possible document tree, with the open blocks -marked by arrows:----> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - list_item - paragraph - "Qui *quodsi iracundia*" - -> list_item - -> paragraph - "aliquando id"- -Phase 1: block structure
-Each line that is processed has an effect on this tree. The line is -analyzed and, depending on its contents, the document may be altered -in one or more of the following ways:
--
-- One or more open blocks may be closed.
-- One or more new blocks may be created as children of the -last open block.
-- Text may be added to the last (deepest) open block remaining -on the tree.
-Once a line has been incorporated into the tree in this way, -it can be discarded, so input can be read in a stream.
-For each line, we follow this procedure:
--
-- -
-First we iterate through the open blocks, starting with the -root document, and descending through last children down to the last -open block. Each block imposes a condition that the line must satisfy -if the block is to remain open. For example, a block quote requires a -
->character. A paragraph requires a non-blank line. -In this phase we may match all or just some of the open -blocks. But we cannot close unmatched blocks yet, because we may have a -[lazy continuation line].- -
-Next, after consuming the continuation markers for existing -blocks, we look for new block starts (e.g.
->for a block quote). -If we encounter a new block start, we close any blocks unmatched -in step 1 before creating the new block as a child of the last -matched block.- -
-Finally, we look at the remainder of the line (after block -markers like
->, list markers, and indentation have been consumed). -This is text that can be incorporated into the last open -block (a paragraph, code block, heading, or raw HTML).Setext headings are formed when we see a line of a paragraph -that is a [setext heading underline].
-Reference link definitions are detected when a paragraph is closed; -the accumulated text lines are parsed to see if they begin with -one or more reference link definitions. Any remainder becomes a -normal paragraph.
-We can see how this works by considering how the tree above is -generated by four lines of Markdown:
----> Lorem ipsum dolor -sit amet. -> - Qui *quodsi iracundia* -> - aliquando id- At the outset, our document model is just
-----> document- The first line of our text,
----> Lorem ipsum dolor- causes a
-block_quoteblock to be created as a child of our -opendocumentblock, and aparagraphblock as a child of -theblock_quote. Then the text is added to the last open -block, theparagraph:----> document - -> block_quote - -> paragraph - "Lorem ipsum dolor"- The next line,
----sit amet.- is a "lazy continuation" of the open
-paragraph, so it gets added -to the paragraph's text:----> document - -> block_quote - -> paragraph - "Lorem ipsum dolor\nsit amet."- The third line,
----> - Qui *quodsi iracundia*- causes the
-paragraphblock to be closed, and a newlistblock -opened as a child of theblock_quote. Alist_itemis also -added as a child of thelist, and aparagraphas a child of -thelist_item. The text is then added to the newparagraph:----> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - -> list_item - -> paragraph - "Qui *quodsi iracundia*"- The fourth line,
----> - aliquando id- causes the
-list_item(and its child theparagraph) to be closed, -and a newlist_itemopened up as child of thelist. Aparagraph-is added as a child of the newlist_item, to contain the text. -We thus obtain the final tree:----> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - list_item - paragraph - "Qui *quodsi iracundia*" - -> list_item - -> paragraph - "aliquando id"- -Phase 2: inline structure
-Once all of the input has been parsed, all open blocks are closed.
-We then "walk the tree," visiting every node, and parse raw -string contents of paragraphs and headings as inlines. At this -point we have seen all the link reference definitions, so we can -resolve reference links as we go.
----document - block_quote - paragraph - str "Lorem ipsum dolor" - softbreak - str "sit amet." - list (type=bullet tight=true bullet_char=-) - list_item - paragraph - str "Qui " - emph - str "quodsi iracundia" - list_item - paragraph - str "aliquando id"- Notice how the [line ending] in the first paragraph has -been parsed as a
-softbreak, and the asterisks in the first list item -have become anemph.-An algorithm for parsing nested emphasis and links
-By far the trickiest part of inline parsing is handling emphasis, -strong emphasis, links, and images. This is done using the following -algorithm.
-When we're parsing inlines and we hit either
--
-- a run of
-*or_characters, or- a
-[or![-we insert a text node with these symbols as its literal content, and we -add a pointer to this text node to the delimiter stack.
-The [delimiter stack] is a doubly linked list. Each -element contains a pointer to a text node, plus information about
--
-- the type of delimiter (
-[,![,*,_)- the number of delimiters,
-- whether the delimiter is "active" (all are active to start), and
-- whether the delimiter is a potential opener, a potential closer, -or both (which depends on what sort of characters precede -and follow the delimiters).
-When we hit a
-]character, we call the look for link or image -procedure (see below).When we hit the end of the input, we call the process emphasis -procedure (see below), with
-stack_bottom= NULL.-look for link or image -
-Starting at the top of the delimiter stack, we look backwards -through the stack for an opening
-[or![delimiter.-
-- -
-If we don't find one, we return a literal text node
-].- -
-If we do find one, but it's not active, we remove the inactive -delimiter from the stack, and return a literal text node
-].- -
-If we find one and it's active, then we parse ahead to see if -we have an inline link/image, reference link/image, compact reference -link/image, or shortcut reference link/image.
--
-- -
-If we don't, then we remove the opening delimiter from the -delimiter stack and return a literal text node
-].- -
-If we do, then
--
-- -
-We return a link or image node whose children are the inlines -after the text node pointed to by the opening delimiter.
-- -
-We run process emphasis on these inlines, with the
-[opener -asstack_bottom.- -
-We remove the opening delimiter.
-- -
-If we have a link (and not an image), we also set all -
-[delimiters before the opening delimiter to inactive. (This -will prevent us from getting links within links.)-process emphasis -
-Parameter
-stack_bottomsets a lower bound to how far we -descend in the [delimiter stack]. If it is NULL, we can -go all the way to the bottom. Otherwise, we stop before -visitingstack_bottom.Let
-current_positionpoint to the element on the [delimiter stack] -just abovestack_bottom(or the first element ifstack_bottom-is NULL).We keep track of the
-openers_bottomfor each delimiter -type (*,_) and each length of the closing delimiter run -(modulo 3). Initialize this tostack_bottom.Then we repeat the following until we run out of potential -closers:
--
-- -
-Move
-current_positionforward in the delimiter stack (if needed) -until we find the first potential closer with delimiter*or_. -(This will be the potential closer closest -to the beginning of the input -- the first one in parse order.)- -
-Now, look back in the stack (staying above
-stack_bottomand -theopeners_bottomfor this delimiter type) for the -first matching potential opener ("matching" means same delimiter).- -
-If one is found:
--
-- -
-Figure out whether we have emphasis or strong emphasis: -if both closer and opener spans have length >= 2, we have -strong, otherwise regular.
-- -
-Insert an emph or strong emph node accordingly, after -the text node corresponding to the opener.
-- -
-Remove any delimiters between the opener and closer from -the delimiter stack.
-- -
-Remove 1 (for regular emph) or 2 (for strong emph) delimiters -from the opening and closing text nodes. If they become empty -as a result, remove them and remove the corresponding element -of the delimiter stack. If the closing node is removed, reset -
-current_positionto the next element in the stack.- -
-If none is found:
--
-- -
-Set
-openers_bottomto the element beforecurrent_position. -(We know that there are no openers for this kind of closer up to and -including this point, so this puts a lower bound on future searches.)- -
-If the closer at
-current_positionis not a potential opener, -remove it from the delimiter stack (since we know it can't -be a closer either).- -
-Advance
-current_positionto the next element in the stack.After we're done, we remove all delimiters above
diff --git a/glfm_specification/output/spec.txt b/glfm_specification/output_example_snapshots/snapshot_spec.md similarity index 94% rename from glfm_specification/output/spec.txt rename to glfm_specification/output_example_snapshots/snapshot_spec.md index a8565b15bc3..ed96c36a58a 100644 --- a/glfm_specification/output/spec.txt +++ b/glfm_specification/output_example_snapshots/snapshot_spec.md @@ -2,11 +2,6 @@ title: GitLab Flavored Markdown (GLFM) Spec version: alpha ... - -# Introduction - -TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section. - # Preliminaries ## Characters and lines @@ -9603,7 +9598,7 @@ Multiple spaces # GitLab Official Specification Markdown Currently, only some of the GitLab-specific markdown features are -listed in this section. We will eventually add all +listed in this section. We may 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). @@ -9989,342 +9984,3 @@ also requires an EE license enabling the `group_wikis` feature: . ```````````````````````````````` - - - -# Appendix: A parsing strategy - -In this appendix we describe some features of the parsing strategy -used in the CommonMark reference implementations. - -## Overview - -Parsing has two phases: - -1. In the first phase, lines of input are consumed and the block -structure of the document---its division into paragraphs, block quotes, -list items, and so on---is constructed. Text is assigned to these -blocks but not parsed. Link reference definitions are parsed and a -map of links is constructed. - -2. In the second phase, the raw text contents of paragraphs and headings -are parsed into sequences of Markdown inline elements (strings, -code spans, links, emphasis, and so on), using the map of link -references constructed in phase 1. - -At each point in processing, the document is represented as a tree of -**blocks**. The root of the tree is a `document` block. The `document` -may have any number of other blocks as **children**. These children -may, in turn, have other blocks as children. The last child of a block -is normally considered **open**, meaning that subsequent lines of input -can alter its contents. (Blocks that are not open are **closed**.) -Here, for example, is a possible document tree, with the open blocks -marked by arrows: - -``` tree --> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - list_item - paragraph - "Qui *quodsi iracundia*" - -> list_item - -> paragraph - "aliquando id" -``` - -## Phase 1: block structure - -Each line that is processed has an effect on this tree. The line is -analyzed and, depending on its contents, the document may be altered -in one or more of the following ways: - -1. One or more open blocks may be closed. -2. One or more new blocks may be created as children of the - last open block. -3. Text may be added to the last (deepest) open block remaining - on the tree. - -Once a line has been incorporated into the tree in this way, -it can be discarded, so input can be read in a stream. - -For each line, we follow this procedure: - -1. First we iterate through the open blocks, starting with the -root document, and descending through last children down to the last -open block. Each block imposes a condition that the line must satisfy -if the block is to remain open. For example, a block quote requires a -`>` character. A paragraph requires a non-blank line. -In this phase we may match all or just some of the open -blocks. But we cannot close unmatched blocks yet, because we may have a -[lazy continuation line]. - -2. Next, after consuming the continuation markers for existing -blocks, we look for new block starts (e.g. `>` for a block quote). -If we encounter a new block start, we close any blocks unmatched -in step 1 before creating the new block as a child of the last -matched block. - -3. Finally, we look at the remainder of the line (after block -markers like `>`, list markers, and indentation have been consumed). -This is text that can be incorporated into the last open -block (a paragraph, code block, heading, or raw HTML). - -Setext headings are formed when we see a line of a paragraph -that is a [setext heading underline]. - -Reference link definitions are detected when a paragraph is closed; -the accumulated text lines are parsed to see if they begin with -one or more reference link definitions. Any remainder becomes a -normal paragraph. - -We can see how this works by considering how the tree above is -generated by four lines of Markdown: - -``` markdown -> Lorem ipsum dolor -sit amet. -> - Qui *quodsi iracundia* -> - aliquando id -``` - -At the outset, our document model is just - -``` tree --> document -``` - -The first line of our text, - -``` markdown -> Lorem ipsum dolor -``` - -causes a `block_quote` block to be created as a child of our -open `document` block, and a `paragraph` block as a child of -the `block_quote`. Then the text is added to the last open -block, the `paragraph`: - -``` tree --> document - -> block_quote - -> paragraph - "Lorem ipsum dolor" -``` - -The next line, - -``` markdown -sit amet. -``` - -is a "lazy continuation" of the open `paragraph`, so it gets added -to the paragraph's text: - -``` tree --> document - -> block_quote - -> paragraph - "Lorem ipsum dolor\nsit amet." -``` - -The third line, - -``` markdown -> - Qui *quodsi iracundia* -``` - -causes the `paragraph` block to be closed, and a new `list` block -opened as a child of the `block_quote`. A `list_item` is also -added as a child of the `list`, and a `paragraph` as a child of -the `list_item`. The text is then added to the new `paragraph`: - -``` tree --> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - -> list_item - -> paragraph - "Qui *quodsi iracundia*" -``` - -The fourth line, - -``` markdown -> - aliquando id -``` - -causes the `list_item` (and its child the `paragraph`) to be closed, -and a new `list_item` opened up as child of the `list`. A `paragraph` -is added as a child of the new `list_item`, to contain the text. -We thus obtain the final tree: - -``` tree --> document - -> block_quote - paragraph - "Lorem ipsum dolor\nsit amet." - -> list (type=bullet tight=true bullet_char=-) - list_item - paragraph - "Qui *quodsi iracundia*" - -> list_item - -> paragraph - "aliquando id" -``` - -## Phase 2: inline structure - -Once all of the input has been parsed, all open blocks are closed. - -We then "walk the tree," visiting every node, and parse raw -string contents of paragraphs and headings as inlines. At this -point we have seen all the link reference definitions, so we can -resolve reference links as we go. - -``` tree -document - block_quote - paragraph - str "Lorem ipsum dolor" - softbreak - str "sit amet." - list (type=bullet tight=true bullet_char=-) - list_item - paragraph - str "Qui " - emph - str "quodsi iracundia" - list_item - paragraph - str "aliquando id" -``` - -Notice how the [line ending] in the first paragraph has -been parsed as a `softbreak`, and the asterisks in the first list item -have become an `emph`. - -### An algorithm for parsing nested emphasis and links - -By far the trickiest part of inline parsing is handling emphasis, -strong emphasis, links, and images. This is done using the following -algorithm. - -When we're parsing inlines and we hit either - -- a run of `*` or `_` characters, or -- a `[` or `. - -The [delimiter stack] is a doubly linked list. Each -element contains a pointer to a text node, plus information about - -- the type of delimiter (`[`, `![`, `*`, `_`) -- the number of delimiters, -- whether the delimiter is "active" (all are active to start), and -- whether the delimiter is a potential opener, a potential closer, - or both (which depends on what sort of characters precede - and follow the delimiters). - -When we hit a `]` character, we call the *look for link or image* -procedure (see below). - -When we hit the end of the input, we call the *process emphasis* -procedure (see below), with `stack_bottom` = NULL. - -#### *look for link or image* - -Starting at the top of the delimiter stack, we look backwards -through the stack for an opening `[` or `![` delimiter. - -- If we don't find one, we return a literal text node `]`. - -- If we do find one, but it's not *active*, we remove the inactive - delimiter from the stack, and return a literal text node `]`. - -- If we find one and it's active, then we parse ahead to see if - we have an inline link/image, reference link/image, compact reference - link/image, or shortcut reference link/image. - - + If we don't, then we remove the opening delimiter from the - delimiter stack and return a literal text node `]`. - - + If we do, then - - * We return a link or image node whose children are the inlines - after the text node pointed to by the opening delimiter. - - * We run *process emphasis* on these inlines, with the `[` opener - as `stack_bottom`. - - * We remove the opening delimiter. - - * If we have a link (and not an image), we also set all - `[` delimiters before the opening delimiter to *inactive*. (This - will prevent us from getting links within links.) - -#### *process emphasis* - -Parameter `stack_bottom` sets a lower bound to how far we -descend in the [delimiter stack]. If it is NULL, we can -go all the way to the bottom. Otherwise, we stop before -visiting `stack_bottom`. - -Let `current_position` point to the element on the [delimiter stack] -just above `stack_bottom` (or the first element if `stack_bottom` -is NULL). - -We keep track of the `openers_bottom` for each delimiter -type (`*`, `_`) and each length of the closing delimiter run -(modulo 3). Initialize this to `stack_bottom`. - -Then we repeat the following until we run out of potential -closers: - -- Move `current_position` forward in the delimiter stack (if needed) - until we find the first potential closer with delimiter `*` or `_`. - (This will be the potential closer closest - to the beginning of the input -- the first one in parse order.) - -- Now, look back in the stack (staying above `stack_bottom` and - the `openers_bottom` for this delimiter type) for the - first matching potential opener ("matching" means same delimiter). - -- If one is found: - - + Figure out whether we have emphasis or strong emphasis: - if both closer and opener spans have length >= 2, we have - strong, otherwise regular. - - + Insert an emph or strong emph node accordingly, after - the text node corresponding to the opener. - - + Remove any delimiters between the opener and closer from - the delimiter stack. - - + Remove 1 (for regular emph) or 2 (for strong emph) delimiters - from the opening and closing text nodes. If they become empty - as a result, remove them and remove the corresponding element - of the delimiter stack. If the closing node is removed, reset - `current_position` to the next element in the stack. - -- If none is found: - - + Set `openers_bottom` to the element before `current_position`. - (We know that there are no openers for this kind of closer up to and - including this point, so this puts a lower bound on future searches.) - - + If the closer at `current_position` is not a potential opener, - remove it from the delimiter stack (since we know it can't - be a closer either). - - + Advance `current_position` to the next element in the stack. - -After we're done, we remove all delimiters above `stack_bottom` from the -delimiter stack. diff --git a/glfm_specification/output_spec/spec.html b/glfm_specification/output_spec/spec.html new file mode 100644 index 00000000000..3a7b08e0a5e --- /dev/null +++ b/glfm_specification/output_spec/spec.html @@ -0,0 +1,276 @@ +stack_bottomfrom the -delimiter stack.+++title: GitLab Flavored Markdown (GLFM) Spec +version: alpha+ +Introduction
+TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section.
+ ++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 +user-facing documentation for GitLab Flavored Markdown.
+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.
++++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 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:
++++- [ ] incomplete +. +<ul> +<li> +<task-button/> +<input type="checkbox" disabled/> +incomplete +</li> +</ul>+ Completed task:
++++- [x] completed +. +<ul> +<li> +<task-button/> +<input type="checkbox" checked disabled/> +completed +</li> +</ul>+ Inapplicable task:
++++- [~] 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.+++- [~] 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 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:
++++--- +title: YAML front matter +--- +. +<pre> +<code> +title: YAML front matter +</code> +</pre>+ TOML front matter:
+++++++ +title: TOML front matter ++++ +. +<pre> +<code> +title: TOML front matter +</code> +</pre>+ JSON front matter:
++++;;; +{ + "title": "JSON front matter" +} +;;; +. +<pre> +<code> +{ + "title": "JSON front matter" +} +</code> +</pre>+ Front matter blocks should be inserted at the top of the document:
++++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:
++++--- +title: YAML front matter +--- +. +<hr> +<h2>title: YAML front matter</h2>+ +Table of contents
+See +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
tag on its own line. +[[_TOC_]]or+++[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>+ +++[[_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.
++++[[_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.
+++ diff --git a/glfm_specification/output_spec/spec.txt b/glfm_specification/output_spec/spec.txt new file mode 100644 index 00000000000..e16975ac51f --- /dev/null +++ b/glfm_specification/output_spec/spec.txt @@ -0,0 +1,287 @@ +--- +title: GitLab Flavored Markdown (GLFM) Spec +version: alpha +... +# Introduction + +TODO: Write a GitLab-specific version of the GitHub Flavored Markdown intro section. + + +# 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 +[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 +. ++[[_TOC_]] + +# Heading 1 +. +<nav> + <ul> + <li><a href="#heading-1">Heading 1</a></li> + </ul> +</nav> +<h1>Heading 1</h1>+ +footnote reference tag + + +1 + + +
++ +```````````````````````````````` + +## 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 +. ++
+- +
++footnote text + + +
++
+```````````````````````````````` + +Completed task: + +```````````````````````````````` example gitlab +- [x] completed +. +- +
++ +incomplete + +
+```````````````````````````````` + +Inapplicable task: + +```````````````````````````````` example gitlab +- [~] inapplicable +. +- +
++ +completed + +
+```````````````````````````````` + +Inapplicable task in a "loose" list. Note that the `- +
++ + +inapplicable ++` tag is not applied to the +loose text; it has strikethrough applied with CSS. + +```````````````````````````````` example gitlab +- [~] inapplicable + + text in loose list +. ++
+```````````````````````````````` + +## 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 +--- +. +- +
++
++ + +inapplicable +++text in loose list +
+++```````````````````````````````` + +TOML front matter: + +```````````````````````````````` example gitlab ++++ +title: TOML front matter ++++ +. ++title: YAML front matter ++++```````````````````````````````` + +JSON front matter: + +```````````````````````````````` example gitlab +;;; +{ + "title": "JSON front matter" +} +;;; +. ++title: TOML front matter ++++```````````````````````````````` + +Front matter blocks should be inserted at the top of the document: + +```````````````````````````````` example gitlab +text + +--- +title: YAML front matter +--- +. ++{ + "title": "JSON front matter" +} ++text
+
+title: YAML front matter
+```````````````````````````````` + +Front matter block delimiters shouldn’t be preceded by space characters: + +```````````````````````````````` example gitlab + --- +title: YAML front matter +--- +. +
+title: YAML front matter
+```````````````````````````````` + +## 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 +. + +Heading 1
+Heading 2
+```````````````````````````````` + +```````````````````````````````` example gitlab +[[_TOC_]] + +# Heading 1 + +## Heading 2 +. + +Heading 1
+Heading 2
+```````````````````````````````` + +A table of contents is a block element. It should preceded and followed by a blank +line. + +```````````````````````````````` example gitlab +[[_TOC_]] +text + +text +[TOC] +. +[[TOC]]text
+text[TOC]
+```````````````````````````````` + +A table of contents can be indented with up to three spaces. + +```````````````````````````````` example gitlab + [[_TOC_]] + +# Heading 1 +. + +Heading 1
+```````````````````````````````` + diff --git a/qa/qa/page/component/lazy_loader.rb b/qa/qa/page/component/lazy_loader.rb index 2123431fc55..1b166efbbff 100644 --- a/qa/qa/page/component/lazy_loader.rb +++ b/qa/qa/page/component/lazy_loader.rb @@ -9,8 +9,8 @@ module QA def self.included(base) super - base.view 'app/assets/javascripts/lazy_loader.js' do - element :js_lazy_loaded + base.view 'app/views/layouts/_img_loader.html.haml' do + element :js_lazy_loaded_content end end end diff --git a/qa/qa/page/component/wiki.rb b/qa/qa/page/component/wiki.rb index ffd31f8d7b7..ed68052f997 100644 --- a/qa/qa/page/component/wiki.rb +++ b/qa/qa/page/component/wiki.rb @@ -38,7 +38,7 @@ module QA # webdriver to miss the hit so we wait for the svg to load before # clicking the button. within_element(:svg_content) do - has_element?(:js_lazy_loaded) + has_element?(:js_lazy_loaded_content) end click_element(:create_first_page_link) diff --git a/qa/qa/page/file/edit.rb b/qa/qa/page/file/edit.rb index d2b8c8260fd..b9b676ee3c4 100644 --- a/qa/qa/page/file/edit.rb +++ b/qa/qa/page/file/edit.rb @@ -12,10 +12,6 @@ module QA element :editor_toolbar_button end - view 'app/views/projects/blob/_editor.html.haml' do - element :source_editor_preview_container - end - def has_markdown_preview?(component, content) within_element(:source_editor_preview_container) do has_css?(component, exact_text: content) diff --git a/qa/qa/page/file/form.rb b/qa/qa/page/file/form.rb index bb8934db498..2e0f8c59213 100644 --- a/qa/qa/page/file/form.rb +++ b/qa/qa/page/file/form.rb @@ -11,7 +11,7 @@ module QA include Shared::Editor view 'app/views/projects/blob/_editor.html.haml' do - element :file_name, "text_field_tag 'file_name'" # rubocop:disable QA/ElementWithPattern + element :file_name_field end view 'app/views/projects/blob/_template_selectors.html.haml' do @@ -23,7 +23,7 @@ module QA end def add_name(name) - fill_in 'file_name', with: name + fill_element(:file_name_field, with: name) end def select_template(template_type, template) diff --git a/qa/qa/page/file/shared/editor.rb b/qa/qa/page/file/shared/editor.rb index dab02c1e34f..f392d52747e 100644 --- a/qa/qa/page/file/shared/editor.rb +++ b/qa/qa/page/file/shared/editor.rb @@ -11,7 +11,7 @@ module QA super base.view 'app/views/projects/blob/_editor.html.haml' do - element :editor + element :source_editor_preview_container end end @@ -30,7 +30,7 @@ module QA private def text_area - within_element :editor do + within_element :source_editor_preview_container do find('textarea', visible: false) end end diff --git a/qa/qa/page/label/index.rb b/qa/qa/page/label/index.rb index e19bc0838c9..70df2e4dc9e 100644 --- a/qa/qa/page/label/index.rb +++ b/qa/qa/page/label/index.rb @@ -23,7 +23,7 @@ module QA # This can cause webdriver to miss the hit so we wait for the svg to load (implicitly with has_element?) # before clicking the button. within_element(:label_svg_content) do - has_element?(:js_lazy_loaded) + has_element?(:js_lazy_loaded_content) end click_element :create_new_label_button diff --git a/qa/qa/page/project/branches/show.rb b/qa/qa/page/project/branches/show.rb index 4bf8abb555b..22b960b47ce 100644 --- a/qa/qa/page/project/branches/show.rb +++ b/qa/qa/page/project/branches/show.rb @@ -16,22 +16,22 @@ module QA end view 'app/views/projects/branches/_branch.html.haml' do - element :branch_name + element :badge_content + element :branch_container + element :branch_link end view 'app/views/projects/branches/_panel.html.haml' do - element :all_branches + element :all_branches_container end view 'app/views/projects/branches/index.html.haml' do - element :delete_merged_branches + element :delete_merged_branches_link end def delete_branch(branch_name) - within_element(:all_branches) do - within(".js-branch-#{branch_name}") do - click_element(:delete_branch_button) - end + within_element(:branch_container, name: branch_name) do + click_element(:delete_branch_button) end click_element(:delete_branch_confirmation_button) @@ -41,22 +41,20 @@ module QA def has_no_branch?(branch_name, reload: false) wait_until(reload: reload) do - within_element(:all_branches) do - has_no_element?(:branch_name, text: branch_name) + within_element(:all_branches_container) do + has_no_element?(:branch_link, text: branch_name) end end end def has_branch_with_badge?(branch_name, badge) - within_element(:all_branches) do - within(".js-branch-#{branch_name} .badge") do - has_text?(badge) - end + within_element(:branch_container, name: branch_name) do + has_element?(:badge_content, text: badge) end end def delete_merged_branches - click_element(:delete_merged_branches) + click_element(:delete_merged_branches_link) click_confirmation_ok_button end end diff --git a/qa/qa/page/project/pipeline/show.rb b/qa/qa/page/project/pipeline/show.rb index 06d154f5178..33ba27a788a 100644 --- a/qa/qa/page/project/pipeline/show.rb +++ b/qa/qa/page/project/pipeline/show.rb @@ -35,10 +35,6 @@ module QA element :status_icon, 'ci-status-icon-${status}' # rubocop:disable QA/ElementWithPattern end - view 'app/views/projects/pipelines/_info.html.haml' do - element :pipeline_badges - end - view 'app/assets/javascripts/pipelines/components/graph/job_group_dropdown.vue' do element :job_dropdown_container element :jobs_dropdown_menu @@ -68,12 +64,6 @@ module QA has_no_element?(:job_link, text: job_name) end - def has_tag?(tag_name) - within_element(:pipeline_badges) do - has_selector?('.badge', text: tag_name) - end - end - def linked_pipelines all_elements(:linked_pipeline_container, minimum: 1) end diff --git a/qa/qa/page/project/settings/mirroring_repositories.rb b/qa/qa/page/project/settings/mirroring_repositories.rb index f55faff19e7..61ee3e4f03c 100644 --- a/qa/qa/page/project/settings/mirroring_repositories.rb +++ b/qa/qa/page/project/settings/mirroring_repositories.rb @@ -6,25 +6,25 @@ module QA module Settings class MirroringRepositories < Page::Base view 'app/views/projects/mirrors/_authentication_method.html.haml' do - element :authentication_method - element :password + element :authentication_method_field + element :password_field end view 'app/views/projects/mirrors/_mirror_repos.html.haml' do - element :mirror_repository_url_input + element :mirror_repository_url_field element :mirror_repository_button end view 'app/views/projects/mirrors/_mirror_repos_list.html.haml' do - element :mirror_repository_url_cell - element :mirror_last_update_at_cell - element :mirror_error_badge - element :mirrored_repository_row + element :mirror_repository_url_content + element :mirror_last_update_at_content + element :mirror_error_badge_content + element :mirrored_repository_row_container element :copy_public_key_button end view 'app/views/projects/mirrors/_mirror_repos_form.html.haml' do - element :mirror_direction + element :mirror_direction_field end view 'app/views/shared/_remote_mirror_update_button.html.haml' do @@ -37,28 +37,23 @@ module QA element :fingerprints_list end - view 'app/views/projects/mirrors/_authentication_method.html.haml' do - element :authentication_method - element :password - end - def repository_url=(value) - fill_element :mirror_repository_url_input, value + fill_element :mirror_repository_url_field, value end def password=(value) - fill_element :password, value + fill_element :password_field, value end def mirror_direction=(value) raise ArgumentError, "Mirror direction must be 'Push' or 'Pull'" unless %w[Push Pull].include?(value) - select_element(:mirror_direction, value) + select_element(:mirror_direction_field, value) # Changing the mirror direction causes the fields below to change, # and that change is animated, so we need to wait for the animation # to complete otherwise changes to those fields could fail - wait_for_animated_element :authentication_method + wait_for_animated_element :authentication_method_field end def authentication_method=(value) @@ -66,13 +61,13 @@ module QA raise ArgumentError, "Authentication method must be 'SSH public key', 'Password', or 'None'" end - select_element(:authentication_method, value) + select_element(:authentication_method_field, value) end def public_key(url) row_index = find_repository_row_index url - within_element_by_index(:mirrored_repository_row, row_index) do + within_element_by_index(:mirrored_repository_row_container, row_index) do find_element(:copy_public_key_button)['data-clipboard-text'] end end @@ -92,7 +87,7 @@ module QA def update(url) row_index = find_repository_row_index(url) - within_element_by_index(:mirrored_repository_row, row_index) do + within_element_by_index(:mirrored_repository_row_container, row_index) do # When a repository is first mirrored, the update process might # already be started, so the button is already "clicked" click_element :update_now_button unless has_element? :updating_button @@ -105,16 +100,16 @@ module QA row_index = find_repository_row_index(url) wait_until(sleep_interval: 1) do - within_element_by_index(:mirrored_repository_row, row_index) do - last_update = find_element(:mirror_last_update_at_cell, wait: 0) + within_element_by_index(:mirrored_repository_row_container, row_index) do + last_update = find_element(:mirror_last_update_at_content, wait: 0) last_update.has_text?('just now') || last_update.has_text?('seconds') end end # Fail early if the page still shows that there has been no update - within_element_by_index(:mirrored_repository_row, row_index) do - find_element(:mirror_last_update_at_cell, wait: 0).assert_no_text('Never') - assert_no_element(:mirror_error_badge) + within_element_by_index(:mirrored_repository_row_container, row_index) do + find_element(:mirror_last_update_at_content, wait: 0).assert_no_text('Never') + assert_no_element(:mirror_error_badge_content) end end @@ -122,7 +117,7 @@ module QA def find_repository_row_index(target_url) wait_until(max_duration: 5, reload: false) do - all_elements(:mirror_repository_url_cell, minimum: 1).index do |url| + all_elements(:mirror_repository_url_content, minimum: 1).index do |url| # The url might be a sanitized url but the target_url won't be so # we compare just the paths instead of the full url URI.parse(url.text).path == target_url.path diff --git a/qa/qa/page/project/settings/protected_branches.rb b/qa/qa/page/project/settings/protected_branches.rb index a78d8a6ccf4..4fbf656210f 100644 --- a/qa/qa/page/project/settings/protected_branches.rb +++ b/qa/qa/page/project/settings/protected_branches.rb @@ -6,8 +6,8 @@ module QA module Settings class ProtectedBranches < Page::Base view 'app/views/projects/protected_branches/shared/_dropdown.html.haml' do - element :protected_branch_select element :protected_branch_dropdown + element :protected_branch_dropdown_content end view 'app/views/projects/protected_branches/_create_protected_branch.html.haml' do @@ -22,9 +22,9 @@ module QA end def select_branch(branch_name) - click_element :protected_branch_select + click_element :protected_branch_dropdown - within_element(:protected_branch_dropdown) do + within_element(:protected_branch_dropdown_content) do click_on branch_name end end diff --git a/qa/qa/page/project/show.rb b/qa/qa/page/project/show.rb index 26c2da07b34..a82fa7f5cf3 100644 --- a/qa/qa/page/project/show.rb +++ b/qa/qa/page/project/show.rb @@ -32,7 +32,7 @@ module QA end view 'app/views/projects/_last_push.html.haml' do - element :create_merge_request + element :create_merge_request_button end view 'app/views/projects/_home_panel.html.haml' do @@ -54,7 +54,7 @@ module QA end view 'app/views/projects/empty.html.haml' do - element :quick_actions + element :quick_actions_container end view 'app/assets/javascripts/repository/components/breadcrumbs.vue' do @@ -72,7 +72,7 @@ module QA end view 'app/views/projects/blob/viewers/_loading.html.haml' do - element :spinner + element :spinner_placeholder end view 'app/views/projects/buttons/_download.html.haml' do @@ -80,11 +80,11 @@ module QA end def wait_for_viewers_to_load - has_no_element?(:spinner, wait: QA::Support::Repeater::DEFAULT_MAX_WAIT_TIME) + has_no_element?(:spinner_placeholder, wait: QA::Support::Repeater::DEFAULT_MAX_WAIT_TIME) end def create_first_new_file! - within_element(:quick_actions) do + within_element(:quick_actions_container) do click_link_with_text 'New file' end end @@ -122,7 +122,7 @@ module QA end def has_create_merge_request_button? - has_css?(element_selector_css(:create_merge_request)) + has_css?(element_selector_css(:create_merge_request_button)) end def has_file?(name) @@ -152,7 +152,7 @@ module QA has_create_merge_request_button? end - click_element :create_merge_request + click_element :create_merge_request_button end def open_web_ide! diff --git a/qa/qa/specs/features/api/4_verify/api_variable_inheritance_with_forward_pipeline_variables_spec.rb b/qa/qa/specs/features/api/4_verify/api_variable_inheritance_with_forward_pipeline_variables_spec.rb index 8ca0ae1f052..8890b3ff317 100644 --- a/qa/qa/specs/features/api/4_verify/api_variable_inheritance_with_forward_pipeline_variables_spec.rb +++ b/qa/qa/specs/features/api/4_verify/api_variable_inheritance_with_forward_pipeline_variables_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Pipeline API defined variable inheritance' do include_context 'variable inheritance test prep' diff --git a/qa/qa/specs/features/api/4_verify/cancel_pipeline_when_block_user_spec.rb b/qa/qa/specs/features/api/4_verify/cancel_pipeline_when_block_user_spec.rb index 7c3fb9ebeba..a360c662cf8 100644 --- a/qa/qa/specs/features/api/4_verify/cancel_pipeline_when_block_user_spec.rb +++ b/qa/qa/specs/features/api/4_verify/cancel_pipeline_when_block_user_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :requires_admin do + RSpec.describe 'Verify', :requires_admin, product_group: :pipeline_execution do describe 'When user is blocked' do let!(:admin_api_client) { Runtime::API::Client.as_admin } let!(:user_api_client) { Runtime::API::Client.new(:gitlab, user: user) } diff --git a/qa/qa/specs/features/api/4_verify/file_variable_spec.rb b/qa/qa/specs/features/api/4_verify/file_variable_spec.rb index 9722f62d5a7..5d6bc5a44f7 100644 --- a/qa/qa/specs/features/api/4_verify/file_variable_spec.rb +++ b/qa/qa/specs/features/api/4_verify/file_variable_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner, feature_flag: { + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring, feature_flag: { name: 'ci_stop_expanding_file_vars_for_runners', scope: :project } do diff --git a/qa/qa/specs/features/api/4_verify/remove_runner_spec.rb b/qa/qa/specs/features/api/4_verify/remove_runner_spec.rb index 6e6198328e5..eb1b085c35c 100644 --- a/qa/qa/specs/features/api/4_verify/remove_runner_spec.rb +++ b/qa/qa/specs/features/api/4_verify/remove_runner_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :runner do describe 'Runner removal' do include Support::API diff --git a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/add_remove_ci_variable_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/add_remove_ci_variable_spec.rb index fa8d0d1501c..d985868b96a 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/add_remove_ci_variable_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/add_remove_ci_variable_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Add or Remove CI variable via UI', :smoke do + describe 'Add or Remove CI variable via UI', :smoke, product_group: :pipeline_authoring do let(:project) do Resource::Project.fabricate_via_api! do |project| project.name = 'project-with-ci-variables' diff --git a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/custom_variable_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/custom_variable_spec.rb index 63801536c34..1db6f48a404 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/custom_variable_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/custom_variable_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Pipeline with customizable variable' do let(:executor) { "qa-runner-#{Time.now.to_i}" } let(:pipeline_job_name) { 'customizable-variable' } diff --git a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/pipeline_with_protected_variable_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/pipeline_with_protected_variable_spec.rb index 5bb60e64da5..52785af1431 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/pipeline_with_protected_variable_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/pipeline_with_protected_variable_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Pipeline with protected variable' do let(:executor) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(8)}" } let(:protected_value) { Faker::Alphanumeric.alphanumeric(8) } diff --git a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/prefill_variables_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/prefill_variables_spec.rb index 8352ad6aa33..7eec0f8870a 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/prefill_variables_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/prefill_variables_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Pipeline with prefill variables' do + describe 'Pipeline with prefill variables', product_group: :pipeline_authoring do let(:prefill_variable_description1) { Faker::Lorem.sentence } let(:prefill_variable_value1) { Faker::Lorem.word } let(:prefill_variable_description2) { Faker::Lorem.sentence } diff --git a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_inheritable_when_forward_pipeline_variables_true_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_inheritable_when_forward_pipeline_variables_true_spec.rb index 7782c0240e9..a5ebd4004d2 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_inheritable_when_forward_pipeline_variables_true_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_inheritable_when_forward_pipeline_variables_true_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'UI defined variable' do include_context 'variable inheritance test prep' diff --git a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_non_inheritable_when_forward_pipeline_variables_false_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_non_inheritable_when_forward_pipeline_variables_false_spec.rb index 69a99483b38..f53454b801c 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_non_inheritable_when_forward_pipeline_variables_false_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/ci_variable/ui_variable_non_inheritable_when_forward_pipeline_variables_false_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'UI defined variable' do include_context 'variable inheritance test prep' diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/create_and_process_pipeline_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/create_and_process_pipeline_spec.rb index 1bba5355790..b6270c11ef6 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/create_and_process_pipeline_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/create_and_process_pipeline_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :smoke, :runner, quarantine: { + RSpec.describe 'Verify', :smoke, :runner, product_group: :pipeline_execution, quarantine: { issue: 'https://gitlab.com/gitlab-org/gitlab/-/issues/356295', type: :investigating } do diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_local_config_file_paths_with_wildcard_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_local_config_file_paths_with_wildcard_spec.rb index b9b87ed29bb..027383550a7 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_local_config_file_paths_with_wildcard_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_local_config_file_paths_with_wildcard_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Include local config file paths with wildcard', :reliable do + describe 'Include local config file paths with wildcard', :reliable, product_group: :pipeline_authoring do let(:project) do Resource::Project.fabricate_via_api! do |project| project.name = 'project-with-pipeline' diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_multiple_files_from_a_project_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_multiple_files_from_a_project_spec.rb index 2fa6b9179ef..5fca2ac392a 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_multiple_files_from_a_project_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/include_multiple_files_from_a_project_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Include multiple files from a project' do let(:executor) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(8)}" } let(:expected_text) { Faker::Lorem.sentence } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/locked_artifacts_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/locked_artifacts_spec.rb index 3356d1274c8..ba1363d79c5 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/locked_artifacts_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/locked_artifacts_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner, :requires_admin do + RSpec.describe 'Verify', :runner, :requires_admin, product_group: :pipeline_insights do describe 'Artifacts' do context 'when locked' do let(:file_name) { 'artifact.txt' } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/merge_mr_when_pipline_is_blocked_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/merge_mr_when_pipline_is_blocked_spec.rb index d201627218e..f63c5d4a85d 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/merge_mr_when_pipline_is_blocked_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/merge_mr_when_pipline_is_blocked_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_execution do context 'When pipeline is blocked' do let(:executor) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(8)}" } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/mr_event_rule_pipeline_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/mr_event_rule_pipeline_spec.rb index 65561bbba29..8ec3209379f 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/mr_event_rule_pipeline_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/mr_event_rule_pipeline_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do context 'When job is configured to only run on merge_request_events' do let(:mr_only_job_name) { 'mr_only_job' } let(:non_mr_only_job_name) { 'non_mr_only_job' } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/parent_child_pipelines_independent_relationship_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/parent_child_pipelines_independent_relationship_spec.rb index 9e3c29db9e7..a7ca7b82d1e 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/parent_child_pipelines_independent_relationship_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/parent_child_pipelines_independent_relationship_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner, :reliable do + RSpec.describe 'Verify', :runner, :reliable, product_group: :pipeline_execution do describe 'Parent-child pipelines independent relationship' do let!(:project) do Resource::Project.fabricate_via_api! do |project| diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pass_dotenv_variables_to_downstream_via_bridge_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pass_dotenv_variables_to_downstream_via_bridge_spec.rb index bbcc71bade7..fca34fc1f8e 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pass_dotenv_variables_to_downstream_via_bridge_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pass_dotenv_variables_to_downstream_via_bridge_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Pass dotenv variables to downstream via bridge' do let(:executor) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(number: 8)}" } let(:upstream_var) { Faker::Alphanumeric.alphanumeric(number: 8) } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_branch_switcher_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_branch_switcher_spec.rb index ac91a9dd2d3..30c71bc590c 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_branch_switcher_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_branch_switcher_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Pipeline editor' do + describe 'Pipeline editor', product_group: :pipeline_authoring do let(:random_test_string) { SecureRandom.hex(10) } let(:project) do diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_can_create_merge_request_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_can_create_merge_request_spec.rb index 931bb97ba32..1f7871b0900 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_can_create_merge_request_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_can_create_merge_request_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Pipeline editor' do + describe 'Pipeline editor', product_group: :pipeline_authoring do let(:project) do Resource::Project.fabricate_via_api! do |project| project.name = 'pipeline-editor-project' diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_tabs_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_tabs_spec.rb index cd3d9eb6a2f..dbe24e2a2b2 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_tabs_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_editor_tabs_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Pipeline editor', :reliable do + describe 'Pipeline editor', :reliable, product_group: :pipeline_authoring do let(:project) do Resource::Project.fabricate_via_api! do |project| project.name = 'pipeline-editor-project' diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_with_image_pull_policy_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_with_image_pull_policy_spec.rb index f9113573295..b1ecce297c9 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_with_image_pull_policy_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/pipeline_with_image_pull_policy_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Pipeline with image:pull_policy' do let(:runner_name) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(number: 8)}" } let(:job_name) { "test-job-#{pull_policies.join('-')}" } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_via_web_only_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_via_web_only_spec.rb index f36593218a9..e8ec01577b1 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_via_web_only_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_via_web_only_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Run pipeline', :reliable do + describe 'Run pipeline', :reliable, product_group: :pipeline_execution do context 'with web only rule' do let(:job_name) { 'test_job' } let(:project) do diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_with_manual_jobs_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_with_manual_jobs_spec.rb index fb7e3a8437f..4223caaafef 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_with_manual_jobs_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/run_pipeline_with_manual_jobs_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_execution do describe 'Run pipeline with manual jobs' do let(:executor) { "qa-runner-#{SecureRandom.hex(4)}" } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_child_pipeline_with_manual_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_child_pipeline_with_manual_spec.rb index 1c75beebb48..536569b1f60 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_child_pipeline_with_manual_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_child_pipeline_with_manual_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_execution do describe "Trigger child pipeline with 'when:manual'" do let(:executor) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(8)}" } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_matrix_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_matrix_spec.rb index 205b4d1168a..6cf534dd21a 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_matrix_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/trigger_matrix_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_authoring do describe 'Trigger matrix' do let(:executor) { "qa-runner-#{Faker::Alphanumeric.alphanumeric(8)}" } diff --git a/qa/qa/specs/features/browser_ui/4_verify/pipeline/update_ci_file_with_pipeline_editor_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/pipeline/update_ci_file_with_pipeline_editor_spec.rb index d34df17c477..1f49c7a3663 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/pipeline/update_ci_file_with_pipeline_editor_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/pipeline/update_ci_file_with_pipeline_editor_spec.rb @@ -2,7 +2,7 @@ module QA RSpec.describe 'Verify' do - describe 'Update CI file with pipeline editor' do + describe 'Update CI file with pipeline editor', product_group: :pipeline_authoring do let(:random_test_string) { SecureRandom.hex(10) } let(:project) do diff --git a/qa/qa/specs/features/browser_ui/4_verify/runner/register_runner_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/runner/register_runner_spec.rb index f8261bba342..24c49be13bb 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/runner/register_runner_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/runner/register_runner_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :runner do describe 'Runner registration' do let(:executor) { "qa-runner-#{Time.now.to_i}" } let!(:runner) do diff --git a/qa/qa/specs/features/browser_ui/4_verify/testing/endpoint_coverage_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/testing/endpoint_coverage_spec.rb index adcf91a550c..0166c53ffd5 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/testing/endpoint_coverage_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/testing/endpoint_coverage_spec.rb @@ -9,7 +9,7 @@ module QA # pipeline created (Sidekiq read/write) -> # runner picks up pipeline (API read/write) -> # User views pipeline succeeds (Web read) - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_insights do context 'Endpoint Coverage' do let!(:project) do Resource::Project.fabricate_via_api! do |project| diff --git a/qa/qa/specs/features/browser_ui/4_verify/testing/view_code_coverage_spec.rb b/qa/qa/specs/features/browser_ui/4_verify/testing/view_code_coverage_spec.rb index 122fb0fc1a0..2a4852a2b8b 100644 --- a/qa/qa/specs/features/browser_ui/4_verify/testing/view_code_coverage_spec.rb +++ b/qa/qa/specs/features/browser_ui/4_verify/testing/view_code_coverage_spec.rb @@ -1,7 +1,7 @@ # frozen_string_literal: true module QA - RSpec.describe 'Verify', :runner do + RSpec.describe 'Verify', :runner, product_group: :pipeline_insights do describe 'Code coverage statistics' do let(:executor) { "qa-runner-#{Time.now.to_i}" } let(:runner) do diff --git a/scripts/lib/glfm/constants.rb b/scripts/lib/glfm/constants.rb index d020d2fec5c..c4feef8464e 100644 --- a/scripts/lib/glfm/constants.rb +++ b/scripts/lib/glfm/constants.rb @@ -15,24 +15,25 @@ module Glfm # GitLab Flavored Markdown specification files specification_input_glfm_path = specification_path.join('input/gitlab_flavored_markdown') - GLFM_INTRO_MD_PATH = specification_input_glfm_path.join('glfm_intro.md') - GLFM_OFFICIAL_SPECIFICATION_EXAMPLES_MD_PATH = - specification_input_glfm_path.join('glfm_official_specification_examples.md') - GLFM_INTERNAL_EXTENSION_EXAMPLES_MD_PATH = specification_input_glfm_path.join('glfm_internal_extension_examples.md') + GLFM_OFFICIAL_SPECIFICATION_MD_PATH = + specification_input_glfm_path.join('glfm_official_specification.md') + GLFM_INTERNAL_EXTENSIONS_MD_PATH = specification_input_glfm_path.join('glfm_internal_extensions.md') GLFM_EXAMPLE_STATUS_YML_PATH = specification_input_glfm_path.join('glfm_example_status.yml') GLFM_EXAMPLE_METADATA_YML_PATH = specification_input_glfm_path.join('glfm_example_metadata.yml') GLFM_EXAMPLE_NORMALIZATIONS_YML_PATH = specification_input_glfm_path.join('glfm_example_normalizations.yml') - GLFM_SPEC_OUTPUT_PATH = specification_path.join('output') - GLFM_SPEC_TXT_PATH = GLFM_SPEC_OUTPUT_PATH.join('spec.txt') - GLFM_SPEC_HTML_PATH = GLFM_SPEC_OUTPUT_PATH.join('spec.html') + GLFM_OUTPUT_SPEC_PATH = specification_path.join('output_spec') + GLFM_SPEC_TXT_PATH = GLFM_OUTPUT_SPEC_PATH.join('spec.txt') + GLFM_SPEC_HTML_PATH = GLFM_OUTPUT_SPEC_PATH.join('spec.html') # Example Snapshot (ES) files - EXAMPLE_SNAPSHOTS_PATH = File.expand_path("../../../glfm_specification/example_snapshots", __dir__) - ES_EXAMPLES_INDEX_YML_PATH = File.join(EXAMPLE_SNAPSHOTS_PATH, 'examples_index.yml') - ES_MARKDOWN_YML_PATH = File.join(EXAMPLE_SNAPSHOTS_PATH, 'markdown.yml') - ES_HTML_YML_PATH = File.join(EXAMPLE_SNAPSHOTS_PATH, 'html.yml') - ES_PROSEMIRROR_JSON_YML_PATH = File.join(EXAMPLE_SNAPSHOTS_PATH, 'prosemirror_json.yml') + ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH = specification_path.join('output_example_snapshots') + ES_SNAPSHOT_SPEC_MD_PATH = ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH.join('snapshot_spec.md') + ES_SNAPSHOT_SPEC_HTML_PATH = ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH.join('snapshot_spec.html') + ES_EXAMPLES_INDEX_YML_PATH = ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH.join('examples_index.yml') + ES_MARKDOWN_YML_PATH = ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH.join('markdown.yml') + ES_HTML_YML_PATH = ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH.join('html.yml') + ES_PROSEMIRROR_JSON_YML_PATH = ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH.join('prosemirror_json.yml') # Other constants used for processing files GLFM_SPEC_TXT_HEADER = <<~MARKDOWN @@ -41,8 +42,9 @@ module Glfm version: alpha ... MARKDOWN - INTRODUCTION_HEADER_LINE_TEXT = /\A# Introduction\Z/.freeze - END_TESTS_COMMENT_LINE_TEXT = /\A\Z/.freeze + INTRODUCTION_HEADER_LINE_TEXT = '# Introduction' + BEGIN_TESTS_COMMENT_LINE_TEXT = '' + END_TESTS_COMMENT_LINE_TEXT = '' MARKDOWN_TEMPFILE_BASENAME = %w[MARKDOWN_TEMPFILE_ .yml].freeze METADATA_TEMPFILE_BASENAME = %w[METADATA_TEMPFILE_ .yml].freeze STATIC_HTML_TEMPFILE_BASENAME = %w[STATIC_HTML_TEMPFILE_ .yml].freeze diff --git a/scripts/lib/glfm/update_example_snapshots.rb b/scripts/lib/glfm/update_example_snapshots.rb index 9075260e748..8f817d0173e 100644 --- a/scripts/lib/glfm/update_example_snapshots.rb +++ b/scripts/lib/glfm/update_example_snapshots.rb @@ -30,12 +30,12 @@ module Glfm def process(skip_static_and_wysiwyg: false) output('Updating example snapshots...') - output("Reading #{GLFM_SPEC_TXT_PATH}...") - glfm_spec_txt_lines = File.open(GLFM_SPEC_TXT_PATH).readlines + output("Reading #{ES_SNAPSHOT_SPEC_MD_PATH}...") + es_snapshot_spec_md_lines = File.open(ES_SNAPSHOT_SPEC_MD_PATH).readlines - # Parse all the examples from `spec.txt`, using a Ruby port of the Python `get_tests` + # Parse all the examples from `snapshot_spec.md`, using a Ruby port of the Python `get_tests` # function the from original CommonMark/GFM `spec_test.py` script. - all_examples = parse_examples(glfm_spec_txt_lines) + all_examples = parse_examples(es_snapshot_spec_md_lines) add_example_names(all_examples) @@ -55,7 +55,7 @@ module Glfm # in the H1 header count. So, even though due to the concatenation it appears before the # GitLab examples sections, it doesn't result in their header counts being off by +1. # 5. If an example contains the 'disabled' string extension, it is skipped (and will thus - # result in a skip in the `spec_txt_example_position`). This behavior is taken from the + # result in a skip in the `spec_example_position`). This behavior is taken from the # GFM `spec_test.py` script (but it's NOT in the original CommonMark `spec_test.py`). # 6. If a section contains ONLY disabled examples, the section numbering will still be # incremented to match the rendered HTML specification section numbering. @@ -202,7 +202,7 @@ module Glfm ) do |example, hash| name = example.fetch(:name).to_sym hash[name] = { - 'spec_txt_example_position' => example.fetch(:example), + 'spec_example_position' => example.fetch(:example), 'source_specification' => source_specification_for_extensions(example.fetch(:extensions)) } end diff --git a/scripts/lib/glfm/update_specification.rb b/scripts/lib/glfm/update_specification.rb index c7264547e44..521c0919f64 100644 --- a/scripts/lib/glfm/update_specification.rb +++ b/scripts/lib/glfm/update_specification.rb @@ -23,17 +23,42 @@ module Glfm def process(skip_spec_html_generation: false) output('Updating specification...') + # read and optionally update `input/github_flavored_markdown/ghfm_spec_v_x.yy.md` ghfm_spec_lines = load_ghfm_spec - glfm_spec_txt_string = build_glfm_spec_txt(ghfm_spec_lines) + + # create `output_spec/spec.txt` + glfm_spec_txt_header_lines = GLFM_SPEC_TXT_HEADER.split("\n").map { |line| "#{line}\n" } + official_spec_lines = readlines_from_path!(GLFM_OFFICIAL_SPECIFICATION_MD_PATH) + + glfm_spec_txt_string = (glfm_spec_txt_header_lines + official_spec_lines).join('') write_glfm_spec_txt(glfm_spec_txt_string) + # create `output_example_snapshots/snapshot_spec.md` + ghfm_spec_example_lines = extract_ghfm_spec_example_lines(ghfm_spec_lines) + official_spec_example_lines = + extract_glfm_spec_example_lines(official_spec_lines, GLFM_OFFICIAL_SPECIFICATION_MD_PATH) + internal_extension_lines = readlines_from_path!(GLFM_INTERNAL_EXTENSIONS_MD_PATH) + internal_extension_example_lines = + extract_glfm_spec_example_lines(internal_extension_lines, GLFM_INTERNAL_EXTENSIONS_MD_PATH) + snapshot_spec_md_string = ( + glfm_spec_txt_header_lines + + ghfm_spec_example_lines + + official_spec_example_lines + + ["\n"] + + internal_extension_example_lines + ).join('') + write_snapshot_spec_md(snapshot_spec_md_string) + if skip_spec_html_generation - output("Skipping GLFM spec.html generation...") + output("Skipping GLFM spec.html and snapshot_spec.html generation...") return end - glfm_spec_html_string = generate_glfm_spec_html(glfm_spec_txt_string) - write_glfm_spec_html(glfm_spec_html_string) + # create `output_spec/spec.html` and `output_snapshot_examples/snapshot_spec.html` + spec_html_string, snapshot_spec_html_string = + generate_spec_html_files(glfm_spec_txt_string, snapshot_spec_md_string) + write_spec_html(spec_html_string) + write_snapshot_spec_html(snapshot_spec_html_string) end private @@ -68,9 +93,7 @@ module Glfm ghfm_spec_txt_uri_parsed = URI.parse(GHFM_SPEC_TXT_URI) ghfm_spec_txt_uri_io = ghfm_spec_txt_uri_parsed.open - # Read IO stream into an array of lines for easy processing later - ghfm_spec_lines = ghfm_spec_txt_uri_io.readlines - raise "Unable to read lines from #{GHFM_SPEC_TXT_URI}" if ghfm_spec_lines.empty? + ghfm_spec_lines = readlines_from_io!(ghfm_spec_txt_uri_io, GHFM_SPEC_TXT_URI) # Make sure the GHFM spec version has not changed validate_expected_spec_version!(ghfm_spec_lines[2]) @@ -95,59 +118,42 @@ module Glfm "Expected 'version: #{GHFM_SPEC_VERSION}', got '#{version_line}'" end - def build_glfm_spec_txt(ghfm_spec_txt_lines) - glfm_spec_txt_lines = ghfm_spec_txt_lines.dup - replace_header(glfm_spec_txt_lines) - replace_intro_section(glfm_spec_txt_lines) - insert_examples(glfm_spec_txt_lines) - glfm_spec_txt_lines.join('') + def extract_ghfm_spec_example_lines(spec_lines) + # In the GHFM spec.txt format, all we have to identify the headers containing examples + # is the presence of a single initial H1 named "Introduction" before the first + # header containing examples, and the comment after the last header + # containing examples. + path = GHFM_SPEC_MD_PATH + first_examples_header_index = spec_lines.index do |line| + line.start_with?('# ') && !line.start_with?(INTRODUCTION_HEADER_LINE_TEXT) + end + raise "Unable to find first examples header in #{path}" unless first_examples_header_index + + end_tests_comment_index = spec_lines.index do |line| + line.start_with?(END_TESTS_COMMENT_LINE_TEXT) + end + raise "Unable to locate 'END TESTS' comment line in #{path}" if end_tests_comment_index.nil? + + spec_lines[first_examples_header_index..(end_tests_comment_index - 1)] end - def replace_header(spec_txt_lines) - spec_txt_lines[0, spec_txt_lines.index("...\n") + 1] = GLFM_SPEC_TXT_HEADER - end - - def replace_intro_section(spec_txt_lines) - glfm_intro_md_lines = File.open(GLFM_INTRO_MD_PATH).readlines - raise "Unable to read lines from #{GLFM_INTRO_MD_PATH}" if glfm_intro_md_lines.empty? - - ghfm_intro_header_begin_index = spec_txt_lines.index do |line| - line =~ INTRODUCTION_HEADER_LINE_TEXT + def extract_glfm_spec_example_lines(spec_lines, path) + # In the GLFM input markdown files (unlike the GLFM spec.txt format), we have control over + # the contents, so we can use explicit and + # is the presence of a single initial H1 named "Introduction" before the first + # header containing examples, and the comment after the last header + # containing examples. + begin_tests_comment_line_index = spec_lines.index do |line| + line.start_with?(BEGIN_TESTS_COMMENT_LINE_TEXT) end - raise "Unable to locate introduction header line in #{GHFM_SPEC_MD_PATH}" if ghfm_intro_header_begin_index.nil? + raise "Unable to locate 'BEGIN TESTS' comment line in #{path}" unless begin_tests_comment_line_index - # Find the index of the next header after the introduction header, starting from the index - # of the introduction header this is the length of the intro section - ghfm_intro_section_length = spec_txt_lines[ghfm_intro_header_begin_index + 1..].index do |line| - line.start_with?('# ') + end_tests_comment_index = spec_lines.index do |line| + line.start_with?(END_TESTS_COMMENT_LINE_TEXT) end + raise "Unable to locate 'END TESTS' comment line in #{path}" if end_tests_comment_index.nil? - # Replace the intro section with the GitLab flavored Markdown intro section - spec_txt_lines[ghfm_intro_header_begin_index, ghfm_intro_section_length] = glfm_intro_md_lines - end - - def insert_examples(spec_txt_lines) - official_spec_lines = File.open(GLFM_OFFICIAL_SPECIFICATION_EXAMPLES_MD_PATH).readlines - raise "Unable to read lines from #{GLFM_OFFICIAL_SPECIFICATION_EXAMPLES_MD_PATH}" if official_spec_lines.empty? - - internal_extension_lines = File.open(GLFM_INTERNAL_EXTENSION_EXAMPLES_MD_PATH).readlines - raise "Unable to read lines from #{GLFM_INTERNAL_EXTENSION_EXAMPLES_MD_PATH}" if internal_extension_lines.empty? - - ghfm_end_tests_comment_index = spec_txt_lines.index do |line| - line =~ END_TESTS_COMMENT_LINE_TEXT - end - raise "Unable to locate 'END TESTS' comment line in #{GHFM_SPEC_MD_PATH}" if ghfm_end_tests_comment_index.nil? - - # Insert the GLFM examples before the 'END TESTS' comment line - spec_txt_lines[ghfm_end_tests_comment_index - 1] = [ - "\n", - official_spec_lines, - "\n", - internal_extension_lines, - "\n" - ].flatten - - spec_txt_lines + spec_lines[(begin_tests_comment_line_index + 1)..(end_tests_comment_index - 1)] end def write_glfm_spec_txt(glfm_spec_txt_string) @@ -156,13 +162,21 @@ module Glfm write_file(GLFM_SPEC_TXT_PATH, glfm_spec_txt_string) end - def generate_glfm_spec_html(glfm_spec_txt_string) - output("Generating spec.html from spec.txt markdown...") + def write_snapshot_spec_md(snapshot_spec_md_string) + output("Writing #{ES_SNAPSHOT_SPEC_MD_PATH}...") + FileUtils.mkdir_p(Pathname.new(ES_SNAPSHOT_SPEC_MD_PATH).dirname) + write_file(ES_SNAPSHOT_SPEC_MD_PATH, snapshot_spec_md_string) + end + + def generate_spec_html_files(spec_txt_string, snapshot_spec_md_string) + output("Generating spec.html and snapshot_spec.html from spec.txt and snapshot_spec.md markdown...") input_markdown_yml_string = <<~MARKDOWN --- spec_txt: | - #{glfm_spec_txt_string.gsub(/^/, ' ')} + #{spec_txt_string.gsub(/^/, ' ')} + snapshot_spec_md: | + #{snapshot_spec_md_string.gsub(/^/, ' ')} MARKDOWN # NOTE: We must copy the input YAML file used by the `render_static_html.rb` @@ -190,14 +204,33 @@ module Glfm cmd = %(bin/rspec #{__dir__}/render_static_html.rb) run_external_cmd(cmd) - output("Reading generated spec.html from tempfile #{static_html_tempfile_path}...") - YAML.safe_load(File.open(static_html_tempfile_path), symbolize_names: true).fetch(:spec_txt) + output("Reading generated html from tempfile #{static_html_tempfile_path}...") + rendered_html_hash = YAML.safe_load(File.open(static_html_tempfile_path), symbolize_names: true) + [rendered_html_hash.fetch(:spec_txt), rendered_html_hash.fetch(:snapshot_spec_md)] end - def write_glfm_spec_html(glfm_spec_html_string) + def write_spec_html(spec_html_string) output("Writing #{GLFM_SPEC_TXT_PATH}...") FileUtils.mkdir_p(Pathname.new(GLFM_SPEC_HTML_PATH).dirname) - write_file(GLFM_SPEC_HTML_PATH, "#{glfm_spec_html_string}\n") + write_file(GLFM_SPEC_HTML_PATH, "#{spec_html_string}\n") + end + + def write_snapshot_spec_html(snapshot_spec_html_string) + output("Writing #{ES_SNAPSHOT_SPEC_HTML_PATH}...") + FileUtils.mkdir_p(Pathname.new(ES_SNAPSHOT_SPEC_HTML_PATH).dirname) + write_file(ES_SNAPSHOT_SPEC_HTML_PATH, "#{snapshot_spec_html_string}\n") + end + + def readlines_from_path!(path) + io = File.open(path) + readlines_from_io!(io, path) + end + + def readlines_from_io!(io, uri_or_path) + lines = io.readlines + raise "Unable to read lines from #{uri_or_path}" if lines.empty? + + lines end end end diff --git a/scripts/lib/glfm/verify_all_generated_files_are_up_to_date.rb b/scripts/lib/glfm/verify_all_generated_files_are_up_to_date.rb index 0b824fc589d..a928c78bfc6 100644 --- a/scripts/lib/glfm/verify_all_generated_files_are_up_to_date.rb +++ b/scripts/lib/glfm/verify_all_generated_files_are_up_to_date.rb @@ -12,7 +12,7 @@ module Glfm include Shared def process - verify_cmd = "git status --porcelain #{GLFM_SPEC_OUTPUT_PATH} #{EXAMPLE_SNAPSHOTS_PATH}" + verify_cmd = "git status --porcelain #{GLFM_OUTPUT_SPEC_PATH} #{ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH}" verify_cmd_output = run_external_cmd(verify_cmd) unless verify_cmd_output.empty? msg = "ERROR: Cannot run `#{__FILE__}` because `#{verify_cmd}` shows the following uncommitted changes:\n" \ diff --git a/spec/graphql/types/permission_types/ci/runner_spec.rb b/spec/graphql/types/permission_types/ci/runner_spec.rb index e5fbbb346e4..b4685794950 100644 --- a/spec/graphql/types/permission_types/ci/runner_spec.rb +++ b/spec/graphql/types/permission_types/ci/runner_spec.rb @@ -5,7 +5,7 @@ require 'spec_helper' RSpec.describe Types::PermissionTypes::Ci::Runner do it do expected_permissions = [ - :read_runner, :update_runner, :delete_runner + :read_runner, :update_runner, :delete_runner, :assign_runner ] expected_permissions.each do |permission| diff --git a/spec/models/integration_spec.rb b/spec/models/integration_spec.rb index 5dc004d661c..3cd08479977 100644 --- a/spec/models/integration_spec.rb +++ b/spec/models/integration_spec.rb @@ -15,6 +15,23 @@ RSpec.describe Integration do it { is_expected.to have_one(:jira_tracker_data).autosave(true).inverse_of(:integration).with_foreign_key(:integration_id).class_name('Integrations::JiraTrackerData') } end + describe 'default values' do + it { is_expected.to be_alert_events } + it { is_expected.to be_commit_events } + it { is_expected.to be_confidential_issues_events } + it { is_expected.to be_confidential_note_events } + it { is_expected.to be_issues_events } + it { is_expected.to be_job_events } + it { is_expected.to be_merge_requests_events } + it { is_expected.to be_note_events } + it { is_expected.to be_pipeline_events } + it { is_expected.to be_push_events } + it { is_expected.to be_tag_push_events } + it { is_expected.to be_wiki_page_events } + it { is_expected.not_to be_active } + it { expect(subject.category).to eq(:common) } + end + describe 'validations' do it { is_expected.to validate_presence_of(:type) } it { is_expected.to validate_exclusion_of(:type).in_array(described_class::BASE_CLASSES) } diff --git a/spec/requests/api/graphql/ci/runner_spec.rb b/spec/requests/api/graphql/ci/runner_spec.rb index bd90753f9ad..94c0a3c41bd 100644 --- a/spec/requests/api/graphql/ci/runner_spec.rb +++ b/spec/requests/api/graphql/ci/runner_spec.rb @@ -104,7 +104,8 @@ RSpec.describe 'Query.runner(id)' do 'userPermissions' => { 'readRunner' => true, 'updateRunner' => true, - 'deleteRunner' => true + 'deleteRunner' => true, + 'assignRunner' => true } ) expect(runner_data['tagList']).to match_array runner.tag_list diff --git a/spec/scripts/lib/glfm/update_example_snapshots_spec.rb b/spec/scripts/lib/glfm/update_example_snapshots_spec.rb index c97226c1a2d..f28a33045ff 100644 --- a/spec/scripts/lib/glfm/update_example_snapshots_spec.rb +++ b/spec/scripts/lib/glfm/update_example_snapshots_spec.rb @@ -32,8 +32,8 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do subject { described_class.new } # GLFM input files - let(:glfm_spec_txt_path) { described_class::GLFM_SPEC_TXT_PATH } - let(:glfm_spec_txt_local_io) { StringIO.new(glfm_spec_txt_contents) } + let(:es_snapshot_spec_md_path) { described_class::ES_SNAPSHOT_SPEC_MD_PATH } + let(:es_snapshot_spec_md_local_io) { StringIO.new(es_snapshot_spec_md_contents) } let(:glfm_example_status_yml_path) { described_class::GLFM_EXAMPLE_STATUS_YML_PATH } let(:glfm_example_metadata_yml_path) { described_class::GLFM_EXAMPLE_METADATA_YML_PATH } let(:glfm_example_normalizations_yml_path) { described_class::GLFM_EXAMPLE_NORMALIZATIONS_YML_PATH } @@ -53,16 +53,11 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do # Internal tempfiles let(:static_html_tempfile_path) { Tempfile.new.path } - let(:glfm_spec_txt_contents) do + let(:es_snapshot_spec_md_contents) do <<~MARKDOWN --- title: GitLab Flavored Markdown Spec ... - - # Introduction - - GLFM intro text... - # Inlines ## Strong @@ -96,7 +91,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do ### Another H3 This is a second consecutive third-level heading. It exists to drive full code coverage - for this scenario, although it doesn't (yet) exist in the actual spec.txt. + for this scenario, although it doesn't (yet) exist in the actual snapshot_spec.md. ## An H2 with all disabled examples @@ -243,12 +238,6 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do . ```````````````````````````````` - - - - # Appendix - - Appendix text. MARKDOWN end @@ -305,11 +294,11 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do --- 01_00_00__obsolete_entry_to_be_deleted__001: canonical: | - This entry is no longer exists in the spec.txt, so it will be deleted. + This entry is no longer exists in the snapshot_spec.md, so it will be deleted. static: |- - This entry is no longer exists in the spec.txt, so it will be deleted. + This entry is no longer exists in the snapshot_spec.md, so it will be deleted. wysiwyg: |- - This entry is no longer exists in the spec.txt, so it will be deleted. + This entry is no longer exists in the snapshot_spec.md, so it will be deleted. 02_01_00__inlines__strong__001: canonical: | This entry is existing, but not skipped, so it will be overwritten. @@ -332,7 +321,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do --- 01_00_00__obsolete_entry_to_be_deleted__001: |- { - "obsolete": "This entry is no longer exists in the spec.txt, and is not skipped, so it will be deleted." + "obsolete": "This entry is no longer exists in the snapshot_spec.md, and is not skipped, so it will be deleted." } 02_01_00__inlines__strong__001: |- { @@ -370,7 +359,7 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do # actual network and filesystem I/O during the spec run. # input files - allow(File).to receive(:open).with(glfm_spec_txt_path) { glfm_spec_txt_local_io } + allow(File).to receive(:open).with(es_snapshot_spec_md_path) { es_snapshot_spec_md_local_io } allow(File).to receive(:open).with(glfm_example_status_yml_path) do StringIO.new(glfm_example_status_yml_contents) end @@ -454,43 +443,43 @@ RSpec.describe Glfm::UpdateExampleSnapshots, '#process' do <<~YAML --- 02_01_00__inlines__strong__001: - spec_txt_example_position: 1 + spec_example_position: 1 source_specification: commonmark 02_01_00__inlines__strong__002: - spec_txt_example_position: 2 + spec_example_position: 2 source_specification: github 02_03_00__inlines__strikethrough_extension__001: - spec_txt_example_position: 4 + spec_example_position: 4 source_specification: github 03_01_00__first_gitlab_specific_section_with_examples__strong_but_with_two_asterisks__001: - spec_txt_example_position: 5 + spec_example_position: 5 source_specification: gitlab 03_02_01__first_gitlab_specific_section_with_examples__h2_which_contains_an_h3__example_in_an_h3__001: - spec_txt_example_position: 6 + spec_example_position: 6 source_specification: gitlab 04_01_00__second_gitlab_specific_section_with_examples__strong_but_with_html__001: - spec_txt_example_position: 7 + spec_example_position: 7 source_specification: gitlab 05_01_00__third_gitlab_specific_section_with_skipped_examples__strong_but_skipped__001: - spec_txt_example_position: 8 + spec_example_position: 8 source_specification: gitlab 05_02_00__third_gitlab_specific_section_with_skipped_examples__strong_but_manually_modified_and_skipped__001: - spec_txt_example_position: 9 + spec_example_position: 9 source_specification: gitlab 06_01_00__api_request_overrides__group_upload_link__001: - spec_txt_example_position: 10 + spec_example_position: 10 source_specification: gitlab 06_02_00__api_request_overrides__project_repo_link__001: - spec_txt_example_position: 11 + spec_example_position: 11 source_specification: gitlab 06_03_00__api_request_overrides__project_snippet_ref__001: - spec_txt_example_position: 12 + spec_example_position: 12 source_specification: gitlab 06_04_00__api_request_overrides__personal_snippet_ref__001: - spec_txt_example_position: 13 + spec_example_position: 13 source_specification: gitlab 06_05_00__api_request_overrides__project_wiki_link__001: - spec_txt_example_position: 14 + spec_example_position: 14 source_specification: gitlab YAML end diff --git a/spec/scripts/lib/glfm/update_specification_spec.rb b/spec/scripts/lib/glfm/update_specification_spec.rb index 83af7cc7ca9..8a7d7100363 100644 --- a/spec/scripts/lib/glfm/update_specification_spec.rb +++ b/spec/scripts/lib/glfm/update_specification_spec.rb @@ -37,18 +37,36 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do let(:ghfm_spec_md_path) { described_class::GHFM_SPEC_MD_PATH } let(:ghfm_spec_txt_local_io) { StringIO.new(ghfm_spec_txt_contents) } - let(:glfm_intro_md_path) { described_class::GLFM_INTRO_MD_PATH } - let(:glfm_intro_md_io) { StringIO.new(glfm_intro_md_contents) } - let(:glfm_official_specification_examples_md_path) { described_class::GLFM_OFFICIAL_SPECIFICATION_EXAMPLES_MD_PATH } - let(:glfm_official_specification_examples_md_io) { StringIO.new(glfm_official_specification_examples_md_contents) } - let(:glfm_internal_extension_examples_md_path) { described_class::GLFM_INTERNAL_EXTENSION_EXAMPLES_MD_PATH } - let(:glfm_internal_extension_examples_md_io) { StringIO.new(glfm_internal_extension_examples_md_contents) } + let(:glfm_official_specification_md_path) { described_class::GLFM_OFFICIAL_SPECIFICATION_MD_PATH } + let(:glfm_official_specification_md_io) { StringIO.new(glfm_official_specification_md_contents) } + let(:glfm_internal_extensions_md_path) { described_class::GLFM_INTERNAL_EXTENSIONS_MD_PATH } + let(:glfm_internal_extensions_md_io) { StringIO.new(glfm_internal_extensions_md_contents) } let(:glfm_spec_txt_path) { described_class::GLFM_SPEC_TXT_PATH } let(:glfm_spec_txt_io) { StringIO.new } let(:glfm_spec_html_path) { described_class::GLFM_SPEC_HTML_PATH } let(:glfm_spec_html_io) { StringIO.new } + let(:es_snapshot_spec_md_path) { described_class::ES_SNAPSHOT_SPEC_MD_PATH } + let(:es_snapshot_spec_md_io) { StringIO.new } + let(:es_snapshot_spec_html_path) { described_class::ES_SNAPSHOT_SPEC_HTML_PATH } + let(:es_snapshot_spec_html_io) { StringIO.new } let(:markdown_tempfile_io) { StringIO.new } + let(:ghfm_spec_txt_examples) do + <<~MARKDOWN + # Section with Examples + + ## Strong + + ```````````````````````````````` example + __bold__ + . +bold
+ ```````````````````````````````` + + End of last GitHub examples section. + MARKDOWN + end + let(:ghfm_spec_txt_contents) do <<~MARKDOWN --- @@ -60,22 +78,9 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do # Introduction - ## What is GitHub Flavored Markdown? - - It's like GLFM, but with an H. - - # Section with Examples - - ## Strong - - ```````````````````````````````` example - __bold__ - . -bold
- ```````````````````````````````` - - End of last GitHub examples section. + GHFM Intro. + #{ghfm_spec_txt_examples} # Appendix @@ -84,18 +89,7 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do MARKDOWN end - let(:glfm_intro_md_contents) do - # language=Markdown - <<~MARKDOWN - # Introduction - - ## What is GitLab Flavored Markdown? - - Intro text about GitLab Flavored Markdown. - MARKDOWN - end - - let(:glfm_official_specification_examples_md_contents) do + let(:glfm_official_specification_md_examples) do <<~MARKDOWN # Official Specification Section with Examples @@ -103,7 +97,20 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do MARKDOWN end - let(:glfm_internal_extension_examples_md_contents) do + let(:glfm_official_specification_md_contents) do + <<~MARKDOWN + # GLFM Introduction + + GLFM intro text. + + + #{glfm_official_specification_md_examples} + + # Non-example official content + MARKDOWN + end + + let(:glfm_internal_extensions_md_examples) do <<~MARKDOWN # Internal Extension Section with Examples @@ -111,6 +118,16 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do MARKDOWN end + let(:glfm_internal_extensions_md_contents) do + <<~MARKDOWN + # Non-example internal content + + #{glfm_internal_extensions_md_examples} + + # More non-example internal content + MARKDOWN + end + before do # Mock default ENV var values stub_env('UPDATE_GHFM_SPEC_MD') @@ -123,17 +140,18 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do allow(URI).to receive(:parse).with(ghfm_spec_txt_uri).and_return(ghfm_spec_txt_uri_parsed) allow(ghfm_spec_txt_uri_parsed).to receive(:open).and_return(ghfm_spec_txt_uri_io) allow(File).to receive(:open).with(ghfm_spec_md_path) { ghfm_spec_txt_local_io } - allow(File).to receive(:open).with(glfm_intro_md_path) { glfm_intro_md_io } - allow(File).to receive(:open).with(glfm_official_specification_examples_md_path) do - glfm_official_specification_examples_md_io + allow(File).to receive(:open).with(glfm_official_specification_md_path) do + glfm_official_specification_md_io end - allow(File).to receive(:open).with(glfm_internal_extension_examples_md_path) do - glfm_internal_extension_examples_md_io + allow(File).to receive(:open).with(glfm_internal_extensions_md_path) do + glfm_internal_extensions_md_io end # output files allow(File).to receive(:open).with(glfm_spec_txt_path, 'w') { glfm_spec_txt_io } allow(File).to receive(:open).with(glfm_spec_html_path, 'w') { glfm_spec_html_io } + allow(File).to receive(:open).with(es_snapshot_spec_md_path, 'w') { es_snapshot_spec_md_io } + allow(File).to receive(:open).with(es_snapshot_spec_html_path, 'w') { es_snapshot_spec_html_io } # Allow normal opening of Tempfile files created during script execution. tempfile_basenames = [ @@ -216,90 +234,109 @@ RSpec.describe Glfm::UpdateSpecification, '#process' do end end - describe 'writing GLFM spec.txt' do - let(:glfm_contents) { reread_io(glfm_spec_txt_io) } + describe 'writing output_spec/spec.txt' do + let(:glfm_spec_txt_contents) { reread_io(glfm_spec_txt_io) } + + before do + subject.process(skip_spec_html_generation: true) + end + + it 'includes only the header and official examples' do + expected = described_class::GLFM_SPEC_TXT_HEADER + glfm_official_specification_md_contents + expect(glfm_spec_txt_contents).to eq(expected) + end + end + + describe 'writing output_example_snapshots/snapshot_spec.md' do + let(:es_snapshot_spec_md_contents) { reread_io(es_snapshot_spec_md_io) } before do subject.process(skip_spec_html_generation: true) end it 'replaces the header text with the GitLab version' do - expect(glfm_contents).not_to match(/GitHub Flavored Markdown Spec/m) - expect(glfm_contents).not_to match(/^version: \d\.\d/m) - expect(glfm_contents).not_to match(/^date: /m) - expect(glfm_contents).not_to match(/^license: /m) - expect(glfm_contents).to match(/#{Regexp.escape(described_class::GLFM_SPEC_TXT_HEADER)}\n/mo) + expect(es_snapshot_spec_md_contents).not_to match(/GitHub Flavored Markdown Spec/m) + expect(es_snapshot_spec_md_contents).not_to match(/^version: \d\.\d/m) + expect(es_snapshot_spec_md_contents).not_to match(/^date: /m) + + expect(es_snapshot_spec_md_contents).to match(/#{Regexp.escape(described_class::GLFM_SPEC_TXT_HEADER)}/mo) end - it 'replaces the intro section with the GitLab version' do - expect(glfm_contents).not_to match(/What is GitHub Flavored Markdown/m) - expect(glfm_contents).to match(/#{Regexp.escape(glfm_intro_md_contents)}/m) - end - - it 'inserts the GitLab official spec and internal extension examples sections before the appendix section' do - expected = <<~MARKDOWN - End of last GitHub examples section. - - # Official Specification Section with Examples - - Some examples. - - # Internal Extension Section with Examples - - Some examples. - - - - # Appendix - MARKDOWN - expect(glfm_contents).to match(/#{Regexp.escape(expected)}/m) + it 'includes header and all examples', :unlimited_max_formatted_output_length do + # rubocop:disable Style/StringConcatenation (string contatenation is more readable) + expected = described_class::GLFM_SPEC_TXT_HEADER + + ghfm_spec_txt_examples + + "\n" + + glfm_official_specification_md_examples + + "\n\n" + # NOTE: We want a blank line between the official and internal examples + glfm_internal_extensions_md_examples + + "\n" + # rubocop:enable Style/StringConcatenation + expect(es_snapshot_spec_md_contents).to eq(expected) end end - describe 'writing GLFM spec.html' do - let(:glfm_contents) { reread_io(glfm_spec_html_io) } + # rubocop:disable RSpec/MultipleMemoizedHelpers + describe 'writing output html files' do + let(:spec_html_contents) { reread_io(glfm_spec_html_io) } + let(:snapshot_spec_html_contents) { reread_io(es_snapshot_spec_html_io) } before do subject.process end - it 'renders HTML from spec.txt', :unlimited_max_formatted_output_length do - expected = <<~HTML + it 'renders expected HTML', :unlimited_max_formatted_output_length do + # NOTE: We do assertions for both output HTML files in this same `it` example block, + # because calling a full `subject.process` without `skip_spec_html_generation: true` + # is very slow, and want to avoid doing it twice. + + expected_spec_html = <<~RENDERED_HTML-title: GitLab Flavored Markdown (GLFM) Spec version: alpha- Introduction
-- What is GitLab Flavored Markdown?
-Intro text about GitLab Flavored Markdown.
-+
+ GLFM Introduction
+GLFM intro text.
+ ++ Official Specification Section with Examples
+Some examples.
+ ++ Non-example official content
+ RENDERED_HTML + expect(spec_html_contents).to be == expected_spec_html + + expected_snapshot_spec_html = <<~RENDERED_HTML ++++title: GitLab Flavored Markdown (GLFM) Spec + version: alpha+ Section with Examples
-+
Strong
--__bold__ +__bold__ . <p><strong>bold</strong></p>End of last GitHub examples section.
-+
End of last GitHub examples section.
+Official Specification Section with Examples
-Some examples.
-+
Some examples.
+Internal Extension Section with Examples
-Some examples.
- -- Appendix
-Appendix text.
- HTML - expect(glfm_contents).to be == expected +Some examples.
+ RENDERED_HTML + expect(snapshot_spec_html_contents).to be == expected_snapshot_spec_html end end + # rubocop:enable RSpec/MultipleMemoizedHelpers def reread_io(io) # Reset the io StringIO to the beginning position of the buffer diff --git a/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb b/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb index fca037c9ff3..a1fd5d080e1 100644 --- a/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb +++ b/spec/scripts/lib/glfm/verify_all_generated_files_are_up_to_date_spec.rb @@ -9,8 +9,8 @@ require_relative '../../../../scripts/lib/glfm/verify_all_generated_files_are_up RSpec.describe Glfm::VerifyAllGeneratedFilesAreUpToDate, '#process' do subject { described_class.new } - let(:output_path) { described_class::GLFM_SPEC_OUTPUT_PATH } - let(:snapshots_path) { described_class::EXAMPLE_SNAPSHOTS_PATH } + let(:output_path) { described_class::GLFM_OUTPUT_SPEC_PATH } + let(:snapshots_path) { described_class::ES_OUTPUT_EXAMPLE_SNAPSHOTS_PATH } let(:verify_cmd) { "git status --porcelain #{output_path} #{snapshots_path}" } before do diff --git a/spec/services/clusters/kubernetes/configure_istio_ingress_service_spec.rb b/spec/services/clusters/kubernetes/configure_istio_ingress_service_spec.rb deleted file mode 100644 index f26177a56d0..00000000000 --- a/spec/services/clusters/kubernetes/configure_istio_ingress_service_spec.rb +++ /dev/null @@ -1,223 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -RSpec.describe Clusters::Kubernetes::ConfigureIstioIngressService, '#execute' do - include KubernetesHelpers - - let(:cluster) { create(:cluster, :project, :provided_by_gcp) } - let(:api_url) { 'https://kubernetes.example.com' } - let(:project) { cluster.project } - let(:environment) { create(:environment, project: project) } - let(:cluster_project) { cluster.cluster_project } - let(:namespace) { "#{project.name}-#{project.id}-#{environment.slug}" } - let(:kubeclient) { cluster.kubeclient } - - subject do - described_class.new( - cluster: cluster - ).execute - end - - before do - stub_kubeclient_discover_istio(api_url) - stub_kubeclient_create_secret(api_url, namespace: namespace) - stub_kubeclient_put_secret(api_url, "#{namespace}-token", namespace: namespace) - - stub_kubeclient_get_secret( - api_url, - metadata_name: "#{namespace}-token", - token: Base64.encode64('sample-token'), - namespace: namespace - ) - - stub_kubeclient_get_secret( - api_url, - metadata_name: 'istio-ingressgateway-ca-certs', - namespace: 'istio-system' - ) - - stub_kubeclient_get_secret( - api_url, - metadata_name: 'istio-ingressgateway-certs', - namespace: 'istio-system' - ) - - stub_kubeclient_put_secret(api_url, 'istio-ingressgateway-ca-certs', namespace: 'istio-system') - stub_kubeclient_put_secret(api_url, 'istio-ingressgateway-certs', namespace: 'istio-system') - stub_kubeclient_get_gateway(api_url, 'knative-ingress-gateway', namespace: 'knative-serving') - stub_kubeclient_put_gateway(api_url, 'knative-ingress-gateway', namespace: 'knative-serving') - end - - context 'without a serverless_domain_cluster' do - it 'configures gateway to use PASSTHROUGH' do - subject - - expect(WebMock).to have_requested(:put, api_url + '/apis/networking.istio.io/v1alpha3/namespaces/knative-serving/gateways/knative-ingress-gateway').with( - body: hash_including( - apiVersion: "networking.istio.io/v1alpha3", - kind: "Gateway", - metadata: { - generation: 1, - labels: { - "networking.knative.dev/ingress-provider" => "istio", - "serving.knative.dev/release" => "v0.7.0" - }, - name: "knative-ingress-gateway", - namespace: "knative-serving", - selfLink: "/apis/networking.istio.io/v1alpha3/namespaces/knative-serving/gateways/knative-ingress-gateway" - }, - spec: { - selector: { - istio: "ingressgateway" - }, - servers: [ - { - hosts: ["*"], - port: { - name: "http", - number: 80, - protocol: "HTTP" - } - }, - { - hosts: ["*"], - port: { - name: "https", - number: 443, - protocol: "HTTPS" - }, - tls: { - mode: "PASSTHROUGH" - } - } - ] - } - ) - ) - end - end - - context 'with a serverless_domain_cluster' do - let(:serverless_domain_cluster) { create(:serverless_domain_cluster) } - let(:certificate) { OpenSSL::X509::Certificate.new(serverless_domain_cluster.certificate) } - - before do - cluster.application_knative = serverless_domain_cluster.knative - end - - it 'configures certificates' do - subject - - expect(serverless_domain_cluster.reload.key).not_to be_blank - expect(serverless_domain_cluster.reload.certificate).not_to be_blank - - expect(certificate.subject.to_s).to include(serverless_domain_cluster.knative.hostname) - - expect(certificate.not_before).to be_within(1.minute).of(Time.current) - expect(certificate.not_after).to be_within(1.minute).of(Time.current + 1000.years) - - expect(WebMock).to have_requested(:put, api_url + '/api/v1/namespaces/istio-system/secrets/istio-ingressgateway-ca-certs').with( - body: hash_including( - metadata: { - name: 'istio-ingressgateway-ca-certs', - namespace: 'istio-system' - }, - type: 'Opaque' - ) - ) - - expect(WebMock).to have_requested(:put, api_url + '/api/v1/namespaces/istio-system/secrets/istio-ingressgateway-certs').with( - body: hash_including( - metadata: { - name: 'istio-ingressgateway-certs', - namespace: 'istio-system' - }, - type: 'kubernetes.io/tls' - ) - ) - end - - it 'configures gateway to use MUTUAL' do - subject - - expect(WebMock).to have_requested(:put, api_url + '/apis/networking.istio.io/v1alpha3/namespaces/knative-serving/gateways/knative-ingress-gateway').with( - body: { - apiVersion: "networking.istio.io/v1alpha3", - kind: "Gateway", - metadata: { - generation: 1, - labels: { - "networking.knative.dev/ingress-provider" => "istio", - "serving.knative.dev/release" => "v0.7.0" - }, - name: "knative-ingress-gateway", - namespace: "knative-serving", - selfLink: "/apis/networking.istio.io/v1alpha3/namespaces/knative-serving/gateways/knative-ingress-gateway" - }, - spec: { - selector: { - istio: "ingressgateway" - }, - servers: [ - { - hosts: ["*"], - port: { - name: "http", - number: 80, - protocol: "HTTP" - } - }, - { - hosts: ["*"], - port: { - name: "https", - number: 443, - protocol: "HTTPS" - }, - tls: { - mode: "MUTUAL", - privateKey: "/etc/istio/ingressgateway-certs/tls.key", - serverCertificate: "/etc/istio/ingressgateway-certs/tls.crt", - caCertificates: "/etc/istio/ingressgateway-ca-certs/cert.pem" - } - } - ] - } - } - ) - end - end - - context 'when there is an error' do - before do - cluster.application_knative = create(:clusters_applications_knative) - - allow_next_instance_of(described_class) do |instance| - allow(instance).to receive(:configure_passthrough).and_raise(error) - end - end - - context 'Kubeclient::HttpError' do - let(:error) { Kubeclient::HttpError.new(404, nil, nil) } - - it 'puts Knative into an errored state' do - subject - - expect(cluster.application_knative).to be_errored - expect(cluster.application_knative.status_reason).to eq('Kubernetes error: 404') - end - end - - context 'StandardError' do - let(:error) { RuntimeError.new('something went wrong') } - - it 'puts Knative into an errored state' do - subject - - expect(cluster.application_knative).to be_errored - expect(cluster.application_knative.status_reason).to eq('Failed to update.') - end - end - end -end diff --git a/spec/services/git/base_hooks_service_spec.rb b/spec/services/git/base_hooks_service_spec.rb index a8d753ff124..9c59b2d1c0b 100644 --- a/spec/services/git/base_hooks_service_spec.rb +++ b/spec/services/git/base_hooks_service_spec.rb @@ -150,11 +150,16 @@ RSpec.describe Git::BaseHooksService do end shared_examples 'creates pipeline with params and expected variables' do + let(:pipeline_service) { double(execute: service_response) } + let(:service_response) { double(error?: false, payload: pipeline, message: "Error") } + let(:pipeline) { double(persisted?: true) } + it 'calls the create pipeline service' do expect(Ci::CreatePipelineService) .to receive(:new) .with(project, user, pipeline_params) - .and_return(double(execute!: true)) + .and_return(pipeline_service) + expect(subject).not_to receive(:log_pipeline_errors) subject.execute end @@ -239,4 +244,141 @@ RSpec.describe Git::BaseHooksService do it_behaves_like 'creates pipeline with params and expected variables' end end + + describe "Pipeline creation" do + context "when refactored_create_pipeline_execution_method feature flag is disabled" do + before do + stub_feature_flags(refactored_create_pipeline_execution_method: false) + end + + let(:pipeline_params) do + { + after: newrev, + before: oldrev, + checkout_sha: checkout_sha, + push_options: push_options, + ref: ref, + variables_attributes: variables_attributes + } + end + + let(:push_options) { {} } + let(:variables_attributes) { [] } + + context 'creates pipeline with params and expected variables' do + it 'calls the create pipeline service' do + expect(Ci::CreatePipelineService) + .to receive(:new) + .with(project, user, pipeline_params) + .and_return(double(execute!: true)) + + subject.execute + end + end + + context 'when logs pipeline errors' do + let(:pipeline) { double(persisted?: false) } + let(:service_response) { double(error?: true, payload: pipeline, message: "Error") } + let(:create_error_string) { Ci::CreatePipelineService::CreateError.new.to_s } + + before do + allow(Ci::CreatePipelineService).to receive(:new) { raise Ci::CreatePipelineService::CreateError } + end + + it 'raises an error' do + expect(subject) + .to receive(:log_pipeline_errors) + .with(create_error_string) + .and_call_original + + subject.execute + end + end + end + + context "when refactored_create_pipeline_execution_method feature flag is enabled" do + before do + stub_feature_flags(refactored_create_pipeline_execution_method: project) + end + + let(:pipeline_params) do + { + after: newrev, + before: oldrev, + checkout_sha: checkout_sha, + push_options: push_options, + ref: ref, + variables_attributes: variables_attributes + } + end + + let(:pipeline_service) { double(execute: service_response) } + let(:push_options) { {} } + let(:variables_attributes) { [] } + + context "when the pipeline is persisted" do + let(:pipeline) { double(persisted?: true) } + + context "and there are no errors" do + let(:service_response) { double(error?: false, payload: pipeline, message: "Error") } + + it "returns success" do + expect(Ci::CreatePipelineService) + .to receive(:new) + .with(project, user, pipeline_params) + .and_return(pipeline_service) + + expect(subject.execute[:status]).to eq(:success) + end + end + + context "and there are errors" do + let(:service_response) { double(error?: true, payload: pipeline, message: "Error") } + + it "does not log errors and returns success" do + # This behaviour is due to the save_on_errors: true setting that is the default in the execute method. + expect(Ci::CreatePipelineService) + .to receive(:new) + .with(project, user, pipeline_params) + .and_return(pipeline_service) + expect(subject).not_to receive(:log_pipeline_errors).with(service_response.message) + + expect(subject.execute[:status]).to eq(:success) + end + end + end + + context "when the pipeline wasnt persisted" do + let(:pipeline) { double(persisted?: false) } + + context "and there are no errors" do + let(:service_response) { double(error?: false, payload: pipeline, message: nil) } + + it "returns success" do + expect(Ci::CreatePipelineService) + .to receive(:new) + .with(project, user, pipeline_params) + .and_return(pipeline_service) + expect(subject).to receive(:log_pipeline_errors).with(service_response.message) + + expect(subject.execute[:status]).to eq(:success) + end + end + + context "and there are errors" do + let(:service_response) { double(error?: true, payload: pipeline, message: "Error") } + + it "logs errors and returns success" do + expect(Ci::CreatePipelineService) + .to receive(:new) + .with(project, user, pipeline_params) + .and_return(pipeline_service) + expect(subject).to receive(:log_pipeline_errors).with(service_response.message) + + expect(subject.execute[:status]).to eq(:success) + end + end + end + end + end end diff --git a/spec/workers/cluster_configure_istio_worker_spec.rb b/spec/workers/cluster_configure_istio_worker_spec.rb deleted file mode 100644 index 5d949fde973..00000000000 --- a/spec/workers/cluster_configure_istio_worker_spec.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -require 'spec_helper' - -RSpec.describe ClusterConfigureIstioWorker do - describe '#perform' do - shared_examples 'configure istio service' do - it 'configures istio' do - expect_any_instance_of(Clusters::Kubernetes::ConfigureIstioIngressService).to receive(:execute) - - described_class.new.perform(cluster.id) - end - end - - context 'when provider type is gcp' do - let(:cluster) { create(:cluster, :project, :provided_by_gcp) } - - it_behaves_like 'configure istio service' - end - - context 'when provider type is aws' do - let(:cluster) { create(:cluster, :project, :provided_by_aws) } - - it_behaves_like 'configure istio service' - end - - context 'when provider type is user' do - let(:cluster) { create(:cluster, :project, :provided_by_user) } - - it_behaves_like 'configure istio service' - end - - context 'when cluster does not exist' do - it 'does not provision a cluster' do - expect_any_instance_of(Clusters::Kubernetes::ConfigureIstioIngressService).not_to receive(:execute) - - described_class.new.perform(123) - end - end - end -end diff --git a/spec/workers/run_pipeline_schedule_worker_spec.rb b/spec/workers/run_pipeline_schedule_worker_spec.rb index 10c22b736d2..8ae77706118 100644 --- a/spec/workers/run_pipeline_schedule_worker_spec.rb +++ b/spec/workers/run_pipeline_schedule_worker_spec.rb @@ -42,14 +42,77 @@ RSpec.describe RunPipelineScheduleWorker do end end - context 'when everything is ok' do - let(:create_pipeline_service) { instance_double(Ci::CreatePipelineService) } + describe "#run_pipeline_schedule" do + context "when refactored_create_pipeline_execution_method feature flag is disabled" do + before do + stub_feature_flags(refactored_create_pipeline_execution_method: false) + end - it 'calls the Service' do - expect(Ci::CreatePipelineService).to receive(:new).with(project, user, ref: pipeline_schedule.ref).and_return(create_pipeline_service) - expect(create_pipeline_service).to receive(:execute!).with(:schedule, ignore_skip_ci: true, save_on_errors: false, schedule: pipeline_schedule) + context 'when everything is ok' do + let(:create_pipeline_service) { instance_double(Ci::CreatePipelineService) } - worker.perform(pipeline_schedule.id, user.id) + it 'calls the Service' do + expect(Ci::CreatePipelineService).to receive(:new).with(project, user, ref: pipeline_schedule.ref).and_return(create_pipeline_service) + expect(create_pipeline_service).to receive(:execute!).with(:schedule, ignore_skip_ci: true, save_on_errors: false, schedule: pipeline_schedule) + + worker.perform(pipeline_schedule.id, user.id) + end + end + + context 'when pipeline cannot be created' do + before do + allow(Ci::CreatePipelineService).to receive(:new) { raise Ci::CreatePipelineService::CreateError } + end + + it 'logs a pipeline error' do + expect(worker) + .to receive(:log_extra_metadata_on_done) + .with(:pipeline_creation_error, an_instance_of(Ci::CreatePipelineService::CreateError)) + .and_call_original + + worker.perform(pipeline_schedule.id, user.id) + end + end + end + + context "when refactored_create_pipeline_execution_method feature flag is enabled" do + let(:create_pipeline_service) { instance_double(Ci::CreatePipelineService, execute: service_response) } + let(:service_response) { instance_double(ServiceResponse, payload: pipeline, error?: false) } + + before do + stub_feature_flags(refactored_create_pipeline_execution_method: project) + expect(Ci::CreatePipelineService).to receive(:new).with(project, user, ref: pipeline_schedule.ref).and_return(create_pipeline_service) + + expect(create_pipeline_service).to receive(:execute).with(:schedule, ignore_skip_ci: true, save_on_errors: false, schedule: pipeline_schedule).and_return(service_response) + end + + context "when pipeline is persisted" do + let(:pipeline) { instance_double(Ci::Pipeline, persisted?: true) } + + it "returns the service response" do + expect(worker.perform(pipeline_schedule.id, user.id)).to eq(service_response) + end + + it "does not log errors" do + expect(worker).not_to receive(:log_extra_metadata_on_done) # aka pipeline_creation_error + + expect(worker.perform(pipeline_schedule.id, user.id)).to eq(service_response) + end + end + + context "when pipeline was not persisted" do + let(:service_response) { instance_double(ServiceResponse, error?: true, message: "Error", payload: pipeline) } + let(:pipeline) { instance_double(Ci::Pipeline, persisted?: false) } + + it "logs a pipeline creation error" do + expect(worker) + .to receive(:log_extra_metadata_on_done) + .with(:pipeline_creation_error, service_response.message) + .and_call_original + + expect(worker.perform(pipeline_schedule.id, user.id)).to eq(service_response.message) + end + end end end @@ -82,20 +145,5 @@ RSpec.describe RunPipelineScheduleWorker do worker.perform(pipeline_schedule.id, user.id) end end - - context 'when pipeline cannot be created' do - before do - allow(Ci::CreatePipelineService).to receive(:new) { raise Ci::CreatePipelineService::CreateError } - end - - it 'logging a pipeline error' do - expect(worker) - .to receive(:log_extra_metadata_on_done) - .with(:pipeline_creation_error, an_instance_of(Ci::CreatePipelineService::CreateError)) - .and_call_original - - worker.perform(pipeline_schedule.id, user.id) - end - end end end