Text can be bold, italic, strikethrough, bold and italic, or bold strikethrough.

Inline code looks like this.

Link to another page.

There should be whitespace between this paragraph and the one below.

There should be whitespace this paragraph and the one above. But consecutive lines in the Markdown, like these two, are rendered in the same paragraph.

Markdown Kitchen Sink Example

Hovering over the headers show anchor links on their left.

Header h2

Header h3

Header h4

Header h5

Header h6

Quotes 2 - 1

This is a blockquote following a header.

When something is important enough, you do it even if the odds are not in your favor.

Admonitions 3 - 1.1

Admonitions (more info here) are added via Markdown blockquotes and rendered like this:

[!TIP] Hover over any code block from the following section to reveal the copy-to-clipboard button.

[!WARNING] Admonitons and Mermaid diagrams are transformed on page load.

[!DANGER]

Not locking a theme version (remote_theme: carlosperate/jekyll-theme-rtd@v1.4.0) in your _config.yml file could result in changes on your built site between theme releases.

Code Blocks 4 - 1.1.1

Hover on the code blocks to show a “copy code to clipboard” button on the top right corner.

// Javascript code with syntax highlighting.
var fun = function lang(l) {
  dateformat.i18n = require('./lang/' + l)
  return true;
}

# Ruby code with syntax highlighting
GitHubPages::Dependencies.gems.each do |gem, version|
  s.add_dependency(gem, "= #{version}")
end

# Python code with syntax highlighting
from microbit import *

while True:
    reading = accelerometer.get_x()
    if reading > 20:
        display.show("R")
    elif reading < -20:
        display.show("L")
    else:
        display.show("-")

Buttons 5 - 1.1.1.1

Buttons (more info here) are inlined and have multiple options:

Default Neutral Info Success Warning Danger Small button Link button

Tables 6 - 1.1.1.1.1

Labels 7 - 1.2 New

Labels (more info here) are badges for status, releases, or other metadata: Default colour

Blue

Green

Fuchsia

Yellow

Red

Gray

Lists 8 - 1.3

Here is an unordered list:

• Item foo
• Item bar
• Item baz
• Item zip

And an ordered list:

1. Item one
2. Item two
3. Item three
4. Item four

Nested Lists 9 - 1.3.1

And a nested list:

• level 1 item
  • level 2 item
  • level 2 item
    • level 3 item
    • level 3 item
• level 1 item
  • level 2 item
  • level 2 item
  • level 2 item
• level 1 item
  • level 2 item
  • level 2 item
• level 1 item

Nesting an ol in ul in an ol:

• level 1 item (ul)
  1. level 2 item (ol)
  2. level 2 item (ol)
     • level 3 item (ul)
     • level 3 item (ul)
• level 1 item (ul)
  1. level 2 item (ol)
  2. level 2 item (ol)
     • level 3 item (ul)
     • level 3 item (ul)
  3. level 4 item (ol)
  4. level 4 item (ol)
     • level 3 item (ul)
     • level 3 item (ul)
• level 1 item (ul)

Task List 10 - 1.3.2

And a task list

• Hello, this is a TODO item
• Hello, this is another TODO item
• Goodbye, this item is done

Images 11 - 1.4

Small image

Large Image 12 - 1.5

Definition Lists 13 - 2

Definition lists can be used with HTML syntax.

Name

Godzilla

Born

1952

Birthplace

Japan

Color

Green

Collapsibles 14 - 2.1

This is a <details>/<summary> collapsible :

Horizonal Rule 15 - 2.2

There’s a horizontal rule below this.

Mermaid Diagrams 16 - 2.2.1

Mermaid diagrams (more info here) are rendered from code blocks with language mermaid:

sequenceDiagram
Alice->>John: Hello John, how are you?
loop HealthCheck
    John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!