aboutsummaryrefslogtreecommitdiff
path: root/src/Markdown/markdown.bnf
blob: 2e4979ecb0c1219c62fb0e68f56fec04635291f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
{
  psiPackage = 'org.jetbrains.markdown'
  psiImplPackage = 'org.jetbrains.markdown.impl'

  parserClass="org.jetbrains.markdown.MarkdownParser"
  parserUtilClass="org.jetbrains.dokka.Markdown.GeneratedParserUtilBase"
  elementTypeHolderClass = 'org.jetbrains.markdown.MarkdownElementTypes'

  tokenTypeClass = 'org.jetbrains.dokka.Markdown.MarkdownTokenType'

  generatePsi = false

  tokens=[
    BOM
    EOL
    EOP
    Number
    SPECIAL
    Word
  ]

}

Document ::= BOM? Whitespace* AnonymousSection? (Whitespace* NamedSection)*

AnonymousSection ::= SectionBody
NamedSection ::= SectionHeader SectionBody
private SectionHeader ::= '$' SectionName OptionalSpace ':' OptionalSpace
SectionName ::= SectionNameStart | '{' OptionalSpace SectionNameStart (Space+ Word)* OptionalSpace '}'
private SectionNameStart ::= '$'? Word
SectionBody::= Block*

Unused ::= Special
BlankLine ::= OptionalSpace EOL

Whitespace ::= Space | EOL | EOP
private OptionalSpace ::= Space*
private NonindentSpace ::= ("   " | "  " | " ")?

EndLine ::= TerminalEndline | NormalEndline
private NormalEndline ::=   EOL !BlankLine
private TerminalEndline ::= OptionalSpace <<eof>>
private Indent ::=            "\t" | "    "

// ---- BLOCKS ----
Block ::= BlankLine* (
              OrderedList
            | BulletList
            | HorizontalRule
            | Directive
            | Para
            )

Para ::= Inlines (EOP | Space* <<eof>>)?

HorizontalRule ::= NonindentSpace
                 ( '*' OptionalSpace '*' OptionalSpace '*' (OptionalSpace '*')*
                 | '-' OptionalSpace '-' OptionalSpace '-' (OptionalSpace '-')*
                 | '_' OptionalSpace '_' OptionalSpace '_' (OptionalSpace '_')*)
                 OptionalSpace EOL BlankLine+

Directive ::= '{' DirectiveName Space+ DirectiveParams '}'
DirectiveName ::= Word
DirectiveParams ::= PlainText

Bullet ::= !HorizontalRule NonindentSpace ('+' | '*' | '-') Space+
Enumerator ::= NonindentSpace Number '.' Space+

BulletList ::= &Bullet List
OrderedList ::= &Enumerator List

private List ::=  (ListItem BlankLine*)+
ListItem      ::= (Bullet | Enumerator) ListBlock ( ListContinuationBlock )*

ListBlock ::= !BlankLine Inlines ( ListBlockLine )*
ListBlockLine ::= !BlankLine !(Indent? (Bullet | Enumerator)) !HorizontalRule Indent? Inlines

ListContinuationBlock ::= BlankLine* (Indent ListBlock)+


// ---- INLINES ----
private Inlines ::= (!EndLine Inline | EndLine &Inline )+ EndLine?
Inline  ::= Strong | Emph | Code | Link | PlainText
PlainText ::= (Word | Number | Space | ':')+

Emph ::= EmphStar | EmphUnderscore
private EmphStar ::= '*' !Whitespace (!'*' Inline)+ '*'
private EmphUnderscore ::= '_' !Whitespace (!'_' Inline)+ '_'

Code ::= '`' !Whitespace (!'`' Inline)+ '`'

Strong ::= StrongStar | StrongUnderscore
StrongStar ::= '**' !Whitespace (!'**' Inline)+ '**'
StrongUnderscore ::= '__' !Whitespace (!'__' Inline)+ '__'

Link ::=  '[' Target ']' ('(' Href ')')?
Target ::= Word+
Href ::= (Word | Number | ':' | '/')+