Skip to content

[Markdown] Add admonition blocks #4578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
deathaxe merged 1 commit into from
Jun 30, 2026
Merged

[Markdown] Add admonition blocks #4578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions Markdown/Markdown.sublime-syntax
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ variables:
# Common Block Indicators
# =======================

admonition_escape: ^(?!\s*$|\1\s{4,}\S)

block_quote: '>' # a greater than sign, (followed by any character or the end of the line)
indented_code_block: (?:[ ]{4}|[ ]{0,3}\t) # a visual tab of width 4 consisting of 4 spaces or 0 to 3 spaces followed by 1 tab

Expand Down Expand Up @@ -503,6 +505,7 @@ contexts:
- include: fenced-div-blocks
- include: html-blocks
- include: reference-definitions
- include: admonitions
- include: atx-headings
- include: setext-headings-or-paragraphs

Expand Down Expand Up @@ -982,6 +985,7 @@ contexts:
- include: fenced-div-blocks
- include: html-blocks
- include: reference-definitions
- include: admonitions
- include: list-block-common
- include: list-block-quotes
- include: list-setext-headings-or-paragraphs
Expand Down Expand Up @@ -3450,6 +3454,145 @@ contexts:
0: meta.hard-line-break.markdown
1: constant.character.escape.markdown

###[ EXTENSIONS: ADMONITIONS ]################################################

admonitions:
# https://python-markdown.github.io/extensions/admonition/
- match: '^([ \t]*)(!!!)[ \t]+(caution|danger)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-caution-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(bug|failure)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-error-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(important)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-important-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(abstract|info|note|question|success)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-note-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(quote)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-quote-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(tip)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-tip-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(warning)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-warning-heading
escape: '{{admonition_escape}}'
- match: '^([ \t]*)(!!!)[ \t]+(\w+)\b'
captures:
2: punctuation.definition.admonition.markdown
embed: admonation-other-heading
escape: '{{admonition_escape}}'

admonation-caution-heading:
- meta_scope: meta.admonition.caution.markdown markup.heading.admonition.caution.markdown
- match: ^
set: admonation-caution-body
- include: admonation-titles

admonation-caution-body:
- meta_scope: meta.admonition.caution.markdown
- include: indented-markdown

admonation-error-heading:
- meta_scope: meta.admonition.error.markdown markup.heading.admonition.error.markdown
- match: ^
set: admonation-error-body
- include: admonation-titles

admonation-error-body:
- meta_scope: meta.admonition.error.markdown
- include: indented-markdown

admonation-important-heading:
- meta_scope: meta.admonition.important.markdown markup.heading.admonition.important.markdown
- match: ^
set: admonation-important-body
- include: admonation-titles

admonation-important-body:
- meta_scope: meta.admonition.important.markdown
- include: indented-markdown

admonation-note-heading:
- meta_scope: meta.admonition.note.markdown markup.heading.admonition.note.markdown
- match: ^
set: admonation-note-body
- include: admonation-titles

admonation-note-body:
- meta_scope: meta.admonition.note.markdown
- include: indented-markdown

admonation-quote-heading:
- meta_scope: meta.admonition.quote.markdown markup.heading.admonition.quote.markdown
- match: ^
set: admonation-quote-body
- include: admonation-titles

admonation-quote-body:
- meta_scope: meta.admonition.quote.markdown
- include: indented-markdown

admonation-tip-heading:
- meta_scope: meta.admonition.tip.markdown markup.heading.admonition.tip.markdown
- match: ^
set: admonation-tip-body
- include: admonation-titles

admonation-tip-body:
- meta_scope: meta.admonition.tip.markdown
- include: indented-markdown

admonation-warning-heading:
- meta_scope: meta.admonition.warning.markdown markup.heading.admonition.warning.markdown
- match: ^
set: admonation-warning-body
- include: admonation-titles

admonation-warning-body:
- meta_scope: meta.admonition.warning.markdown
- include: indented-markdown

admonation-other-heading:
- meta_scope: meta.admonition.other.markdown markup.heading.admonition.other.markdown
- match: ^
set: admonation-other-body
- include: admonation-titles

admonation-other-body:
- meta_scope: meta.admonition.other.markdown
- include: indented-markdown

admonation-titles:
- match: \"
scope: punctuation.definition.title.begin.markdown
push: admonation-title-body

admonation-title-body:
- meta_scope: meta.title.markdown
- match: \"
scope: punctuation.definition.title.end.markdown
pop: 1
- match: $
pop: 1
- include: inlines

###[ EXTENSIONS: CRITIC MARKUP ]##############################################

critics:
Expand Down
120 changes: 120 additions & 0 deletions Markdown/tests/syntax_test_markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8845,6 +8845,126 @@ soft line break
not a hard line break`


# TEST: ADMONITIONS ###########################################################

!!! bug "Bug Title"
|^^^^^^^^^^^^^^^^^^^ meta.admonition.error.markdown markup.heading.admonition.error.markdown
|^^ punctuation.definition.admonition.markdown
| ^^^^^^^^^^^ meta.title.markdown
| ^ punctuation.definition.title.begin.markdown
| ^ punctuation.definition.title.end.markdown

!!! danger "Be very careful"
|^^^^^^^^^^^^^^^^^^^^^^^^^^^^ meta.admonition.caution.markdown markup.heading.admonition.caution.markdown
|^^ punctuation.definition.admonition.markdown
| ^^^^^^^^^^^^^^^^^ meta.title.markdown
| ^ punctuation.definition.title.begin.markdown
| ^ punctuation.definition.title.end.markdown

!!! failure
|^^^^^^^^^^^ meta.admonition.error.markdown markup.heading.admonition.error.markdown
|^^ punctuation.definition.admonition.markdown

!!! failure blinking
|^^^^^^^^^^^^^^^^^^^^ meta.admonition.error.markdown markup.heading.admonition.error.markdown
|^^ punctuation.definition.admonition.markdown

!!! failure "Error Title"
|^^^^^^^^^^^^^^^^^^^^^^^^^ meta.admonition.error.markdown markup.heading.admonition.error.markdown
|^^ punctuation.definition.admonition.markdown
| ^^^^^^^^^^^^^ meta.title.markdown
| ^ punctuation.definition.title.begin.markdown
| ^ punctuation.definition.title.end.markdown

!!! quote
|^^^^^^^^^ meta.admonition.quote.markdown markup.heading.admonition.quote.markdown
|^^ punctuation.definition.admonition.markdown

!!! danger "Be very careful"

# Heading
| <- meta.admonition.caution.markdown markup.heading.1.markdown punctuation.definition.heading.begin.markdown
|^^^^^^^^^ meta.admonition.caution.markdown markup.heading.1.markdown

Tip Body
| <- meta.admonition.caution.markdown meta.paragraph.list.markdown
|^^^^^^^^ meta.admonition.caution.markdown meta.paragraph.list.markdown

- list
| <- meta.admonition.caution.markdown markup.list.unnumbered.bullet.markdown punctuation.definition.list_item.markdown
|^ meta.admonition.caution.markdown markup.list.unnumbered.markdown
| ^^^^^ meta.admonition.caution.markdown meta.paragraph.list.markdown

!!! quote

# Heading
| <- meta.admonition.quote.markdown markup.heading.1.markdown punctuation.definition.heading.begin.markdown
|^^^^^^^^^ meta.admonition.quote.markdown markup.heading.1.markdown

Tip Body
| <- meta.admonition.quote.markdown meta.paragraph.list.markdown
|^^^^^^^^ meta.admonition.quote.markdown meta.paragraph.list.markdown

- list
| <- meta.admonition.quote.markdown markup.list.unnumbered.bullet.markdown punctuation.definition.list_item.markdown
|^ meta.admonition.quote.markdown markup.list.unnumbered.markdown
| ^^^^^ meta.admonition.quote.markdown meta.paragraph.list.markdown

!!! tip "This may help you"

# Heading
| <- meta.admonition.tip.markdown markup.heading.1.markdown punctuation.definition.heading.begin.markdown
|^^^^^^^^^ meta.admonition.tip.markdown markup.heading.1.markdown

Tip Body
| <- meta.admonition.tip.markdown meta.paragraph.list.markdown
|^^^^^^^^ meta.admonition.tip.markdown meta.paragraph.list.markdown

- list
| <- meta.admonition.tip.markdown markup.list.unnumbered.bullet.markdown punctuation.definition.list_item.markdown
|^ meta.admonition.tip.markdown markup.list.unnumbered.markdown
| ^^^^^ meta.admonition.tip.markdown meta.paragraph.list.markdown

!!! warning "Heads up"

# Heading
| <- meta.admonition.warning.markdown markup.heading.1.markdown punctuation.definition.heading.begin.markdown
|^^^^^^^^^ meta.admonition.warning.markdown markup.heading.1.markdown

Tip Body
| <- meta.admonition.warning.markdown meta.paragraph.list.markdown
|^^^^^^^^ meta.admonition.warning.markdown meta.paragraph.list.markdown

- list
| <- meta.admonition.warning.markdown markup.list.unnumbered.bullet.markdown punctuation.definition.list_item.markdown
|^ meta.admonition.warning.markdown markup.list.unnumbered.markdown
| ^^^^^ meta.admonition.warning.markdown meta.paragraph.list.markdown

- list item
| <- markup.list.unnumbered.bullet.markdown punctuation.definition.list_item.markdown - meta.admonition

!!! tip "Title"
|^^^^^^^^^^^^^^^^ markup.list.unnumbered.markdown meta.admonition.tip.markdown markup.heading.admonition.tip.markdown
| ^^^ punctuation.definition.admonition.markdown

- list item

!!! warning "Title"
|^^^^^^^^^^^^^^^^^^^^^ markup.list.unnumbered.markdown meta.admonition.warning.markdown markup.heading.admonition.warning.markdown
| ^^^ punctuation.definition.admonition.markdown

!!! success "Title"

paragraph
|^^^^^^^^^ meta.admonition.note.markdown meta.paragraph.list.markdown

- list
|<- markup.list.unnumbered.bullet.markdown punctuation.definition.list_item.markdown
|^^^^^^ meta.admonition.note.markdown
|^ markup.list.unnumbered.markdown
| ^^^^^ meta.paragraph.list.markdown


# TEST: CRITIC MARKUP #########################################################

This is an {++additional++} word in {++**bold**++}.
Expand Down