Demonstration Document
h1 This is a large heading heading
h2 Heading This a slightly smaller heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Horizontal Rules
Body Copy
Either the well was very deep, or she fell very slowly, for she had plenty of time, as she went down, to look about her. First, she tried to make out what she was coming to, but it was too dark to see anything; then she looked at the sides of the well and noticed that they were filled with cupboards and book-shelves; here and there she saw maps and pictures hung upon pegs. She took down a jar from one of the shelves as she passed. It was labeled “ORANGE MARMALADE,” but, to her great disappointment, it was empty; she did not like to drop the jar, so managed to put it into one of the cupboards as she fell past it.
Down, down, down! Would the fall never come to an end? There was nothing else to do, so Alice soon began talking to herself. “Dinah’ll miss me very much to-night, I should think!” (Dinah was the cat.) “I hope they’ll remember her saucer of milk at tea-time. Dinah, my dear, I wish you were down here with me!” Alice felt that she was dozing off, when suddenly, thump! thump! down she came upon a heap of sticks and dry leaves, and the fall was over.
Typographic replacements
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
!!!!!! ???? ,, — --- …
“Smartypants, double quotes” and ‘single quotes’
Emphasis
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough
==Highlighting==
Sub and superscript
19^th^
H~2~O
Blockquotes
Blockquotes can also be nested…
…by using additional greater-than signs right next to each other…
…or with spaces between arrows.
Centered text
->You can wrap text in ->
and <-
to center it<-
->What kind of thoughts now, do you carry
In your travels day by day
Are they bright and lofty visions,
Or neglected, gone astray?<-
Links
Autoconverted link https://github.com/nodeca/pica
Lists
Bulleted
- 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!
Numbered
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
Automatic numbering:
- You can use sequential numbers…
- …or keep all the numbers as
1.
Start numbering with offset:
- foo
- bar
Checklists
These can be clicked toggled from the preview panel as well
- First
- Second
- TODO
- TODO #2
-
Strikeout- Nested
- Items
- Nested
Code
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code “fences”
Sample text here...
Syntax highlighting
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
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. |
Right aligned columns
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. |
Center aligned columns
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. |
Math
AsciiMath
sum_(i=1)^n i^3=((n(n+1))/2)^2
Inline math math lim_(N->oo) sum_(i=0)^N
Format reference: http://asciimath.org/
LaTeX
{\sum_{{{i}={1}}}^{{n}}}{i}^{{3}}={\left(\frac{{{n}{\left({n}+{1}\right)}}}{{2}}\right)}^{{2}}
Inline LaTeX latex \lim_{{{N}\to\infty}}{\sum_{{{i}={0}}}^{{N}}}
$$
delimiters can also be used for latex blocks:
$$ {\sum_{{{i}={1}}}^{{n}}}{i}^{{3}}={\left(\frac{{{n}{\left({n}+{1}\right)}}}{{2}}\right)}^{{2}} $$
and single $
delimiters can be used for inline latex: ${N}\to\infty$
Format reference: https://katex.org/docs/supported.html
Chemistry
\ce{Hg^2+ ->[I-] HgI2 ->[I-] [Hg^{II}I4]^2-}
Format reference: https://mhchem.github.io/MathJax-mhchem/
Graphs and Diagrams
graph LR
A-->B
A-->C
B-->D
C-->D
graph TD
A-.->B(B)
A-->C((C))
B==>D
C-.->D{D}
flowchart TB
c1-->a2
subgraph one
a1-->a2
end
subgraph two
b1-->b2
end
subgraph three
c1-->c2
end
one --> two
three --> two
two --> c2
Full format reference: https://mermaid-js.github.io/mermaid/#/flowchart
Sequence Diagrams
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
Full format reference: https://mermaid-js.github.io/mermaid/#/sequenceDiagram?id=sequence-diagrams
Gantt Diagram
gantt
title A Gantt Diagram
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
Full format reference: https://mermaid-js.github.io/mermaid/#/gantt?id=gantt-diagrams
State Diagrams
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
stateDiagram-v2
[*] --> First
First --> Second
First --> Third
state First {
[*] --> fir
fir --> [*]
}
state Second {
[*] --> sec
sec --> [*]
}
state Third {
[*] --> thi
thi --> [*]
}
Full format reference: https://mermaid-js.github.io/mermaid/#/stateDiagram?id=state-diagrams
ER Diagram
erDiagram
CUSTOMER ||--o{ ORDER : places
CUSTOMER {
string name
string custNumber
string sector
}
ORDER ||--|{ LINE-ITEM : contains
ORDER {
int orderNumber
string deliveryAddress
}
LINE-ITEM {
string productCode
int quantity
float pricePerUnit
}
Full format reference: https://mermaid-js.github.io/mermaid/#/entityRelationshipDiagram
Class Diagram
classDiagram
Animal <|-- Duck
Animal <|-- Fish
Animal <|-- Zebra
Animal : +int age
Animal : +String gender
Animal: +isMammal()
Animal: +mate()
class Duck{
+String beakColor
+swim()
+quack()
}
class Fish{
-int sizeInFeet
-canEat()
}
class Zebra{
+bool is_wild
+run()
}
Full format reference: https://mermaid-js.github.io/mermaid/#/classDiagram
Music
ABC Notation
ABC
X:1
T: Cooley's
M: 4/4
L: 1/8
R: reel
K: Emin
D2|:"Em"EB{c}BA B2 EB|~B2 AB dBAG|"D"FDAD BDAD|FDAD dAFD|
"Em"EBBA B2 EB|B2 AB defg|"D"afe^c dBAF|1"Em"DEFD E2 D2:|2"Em"DEFD E2 gf||
|:"Em"eB B2 efge|eB B2 gedB|"D"A2 FA DAFA|A2 FA defg|
"Em"eB B2 eBgB|eB B2 defg|"D"afe^c dBAF|1"Em"DEFD E2 gf:|2"Em"DEFD E4|]
Full format reference (not all options currently supported): http://abcnotation.com/learn
Songbooks
{title: Rockin' Robin}
{artist: Bobby Day}
{section: Verse}
He [G7]rocks in the treetops [G]all day long,
[G7]Hoppin' and a-boppin' and a-[G]singin' his song.
[G7]All the little birds on [G]J-Bird Street,
Love to hear the robin go [G7]tweet, tweet, tweet.
Guitar Chords and Tabs
Chords
C:1 C:2 Eb7 Bm7b5
Tabs
F# G# Fm A#m F# G# Fm
$D 6 8 $G 6 $D 8 $B 6 6 $G 8 |
$D 6 8 $G 6 $D 8 $G 6h8 8 6 5 $D 8 |
$d 6 8 $G 6 $D 8 $G 6 8 $D 8/10 6 6 $G 8 6 ||
Full format reference: https://jtab.tardate.com
In addition to the above, Deepdwn supports a couple of other symbols:
-
Used for alignment when playing multiple notes at the same time.|:
Begin repeat sign:|
End repeat sign
|: $D.6h8.$G.--6 :|
Tabs (ascii tab format)
e|---------------|---------------------|----------------------|
B|---------6-6---|---------------------|----------------------|
G|-----6-------8-|-----6---6h8-8-6-5---|-6---6-8----------8-6-|
D|-6-8---8-------|-6-8---8-----------8-|---8-----8/10-6-6-----|
A|---------------|---------------------|----------------------|
E|---------------|---------------------|----------------------|
Images
Like links, Images also have a footnote style syntax
With a reference later in the document defining the URL location:
Abbreviations
[HTML]: Hyper Text Markup Language [W3C]: World Wide Web Consortium
The HTML specification is maintained by the W3C.
Footnotes
Footnote 1 linkfirst.
Footnote 2 linksecond.
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote referencesecond.
Definition Lists
Term 1
: Definition 1 with lazy continuation.
Term 2 with inline markup
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Compact style:
Term 1 ~ Definition 1
Term 2 ~ Definition 2a ~ Definition 2b