Basic Markdown syntax example, from markdown-it demo.
π§βππ₯οΈβοΈπ
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Emphasis
This is bold text
This is italic text
bold + italic
Strikethrough
Blockquotes
Blockquotes can also be nestedβ¦
bold text
strikethrough
code
linkβ¦by using additional greater-than signs right next to each otherβ¦
β¦or with spaces between arrows.
Lists
Unordered
- Create a list by starting a line with
+
,-
, or*
- Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
Ordered
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
or
- You can use sequential numbersβ¦
- β¦or keep all the numbers as
1.
Start numbering with offset:
- foo
- bar
Indent
-
Git clone
-
Install package
-
Run!
Code
Inline code
Syntax highlighting
Tables
Option | Description |
---|---|
data | path to data files to supply the data that will be passed into templates. |
engine | engine to be used for processing templates. Handlebars is the default. |
ext | extension to be used for dest files. |
Links
Images
Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
Footnotes
Footnote 1 link1.
Footnote 2 link2.
Duplicated footnote reference2.
KaTex
Inline:
Block:
Typography
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas eget sollicitudin eros, non malesuada dolor. Duis bibendum eros ac tellus imperdiet semper. Aenean sodales mauris sed vulputate tempus. Morbi eget diam eleifend ipsum sollicitudin consectetur ac nec turpis. Nam luctus mi faucibus, tincidunt nisi a, maximus neque.3
Pellentesque eu eros est. Donec ac quam sed felis eleifend egestas ac non orci. Curabitur metus enim, rutrum et nunc vel, volutpat iaculis turpis. Vivamus ornare sollicitudin dui non posuere. Curabitur at dui vel urna scelerisque
rutrum ut ac augue. Ut bibendum urna quis urna fringilla ultrices.
Vestibulum
Morbi interdum ipsum magna, et ullamcorper tortor dapibus eu. Donec commodo tristique felis non luctus. Donec vel tempor diam. Phasellus ac nulla et erat vehicula pulvinar. Curabitur ac nunc iaculis augue pellentesque consequat id eget justo. Fusce tempor fermentum tellus et dignissim.
Mauris
Nulla interdum, augue nec lobortis scelerisque, est nunc malesuada augue, at consectetur neque turpis nec tellus. Donec quis ligula in tellus tempor porttitor eu quis lorem. Vivamus ac interdum purus, eget congue ex. Curabitur at placerat nisl (Etiam nec metus feugiat), eget semper sapien.
Cras placerat augue eu nunc scelerisque, ac sagittis justo euismod. Vestibulum nec magna in erat interdum sagittis et eget dui. Aliquam placerat, orci sed sollicitudin commodo, eros libero mollis sapien, a egestas turpis mauris nec sem. Curabitur non sodales massa.
Morbi Rutrum Libero
Morbi ultrices nunc ipsum, ut gravida odio laoreet vitae. Quisque ut ornare libero, ut iaculis magna. Nulla in arcu bibendum, faucibus turpis in, egestas nisl. Fusce a accumsan ligula, ut suscipit velit. Duis auctor egestas dui eget efficitur. Proin egestas porttitor leo, eu varius felis consequat in. In congue mauris non tellus pretium posuere.
Vestibulum
Ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; In gravida, nunc sit amet suscipit viverra, turpis massa porttitor quam, in fringilla erat ante ut turpis.
Nunc Et Pretium Velit
Ut aliquet fringilla dolor eu vehicula. Phasellus vel dui finibus, euismod augue eu, mollis magna. Sed ullamcorper dictum nunc sit amet lacinia. Nullam in est orci. Mauris hendrerit mauris sit amet volutpat aliquam. Vivamus in ante ut ligula fermentum mattis id tempor purus. Duis euismod porttitor elit, eu hendrerit est vehicula a. Sed ac quam tincidunt, commodo eros non, laoreet diam. Nulla in pulvinar justo. Praesent et purus orci.