GitBucket Markdown Enhanced Plugin

Powered by flexmark-java

[TOC]

The goal

Visual Studio Code extension Markdown Preview Enhanced

• Basic Syntax
• Extended syntax
  • Table
  • Emoji & Font-Awesome(Emoji only)
  • Superscript(0.1.1)
  • Subscript(0.1.1)
  • Footnotes
  • Abbreviation(0.2.0)
  • Mark
  • CriticMarkup
  • Admonition(different grammar. since 0.2.0)
• Math Typesetting(Katex only)
• Diagrams
  • Mermaid
  • PlantUML(0.3.0)
  • WaveDrom
  • GraphViz
  • Vega and Vega-lite
  • Kroki
• Table of Contents(Sidebar not supported)
• File Imports
• Code Chunk
• Presentation
• Pandoc

Extensions used

• AbbreviationExtension
• AdmonitionExtension
• AnchorLinkExtension
• EmojiExtension (Under investigation)
• FootnoteExtension
• GitLabExtension
• StrikethroughSubscriptExtension
• SuperscriptExtension
• TablesExtension
• TaskListExtension
• TocExtension

AbbreviationExtension

Allows to create abbreviations which will be replaced in plain text into tags or optionally into with titles for the abbreviation expansion.

*[HTML]: Hyper Text Markup Language
*[W3C]: World Wide Web Consortium
The HTML specification
is maintained by the W3C.

to

*[HTML]: Hyper Text Markup Language *[W3C]: World Wide Web Consortium The HTML specification is maintained by the W3C.

AdmonitionExtension

To create block-styled side content.

!!! qualifier "Optional Title"
    block content 

to

!!! qualifier "Optional Title" block content

See also Admonition Extension · vsch/flexmark-java Wiki

AnchorLinkExtension

Automatically adds anchor links to heading, using GitHub id generation algorithm.

EmojiExtension

:grinning: -> 😀

FootnoteExtension

Creates footnote references in the document.

FootnoteExtension[^1] creates footnote references in the document.

[^1]: https://github.com/vsch/flexmark-java/wiki/Extensions#footnotes

FootnoteExtension¹ creates footnote references in the document.

GitLabExtension

Parses and renders GitLab Flavoured Markdown.

Katex support

a^2+b^2=c^2

to

$$a^2+b^2=c^2$$

mermaid support

graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;

to

graph TD;
  A-->B;
  A-->C;
  B-->D;
  C-->D;

Loading

StrikethroughSubscriptExtension

~~Strikethrough~~ -> Strikethrough

H~2~O -> H2O

SuperscriptExtension

x^2^ -> x^2^

TablesExtension

See Tables Extension · vsch/flexmark-java Wiki

TaskListExtension

- [x] Katex support
- [x] mermaid support
- [ ] PlantUML support

to

• Katex support
• mermaid support
• PlantUML support

TocExtension

[TOC] create table of contents.

[TOC]

PlantUML Support

@startuml
Bob -> Alice : hello
@enduml

to

@startuml
Bob -> Alice : hello
@enduml

Footnotes

1. https://github.com/vsch/flexmark-java/wiki/Extensions#footnotes ↩