Markdown Demo#

1
2
3
4
5
6
7

import numpy as np
import matplotlib.pyplot as plt

x = np.linspace(0, 2 * np.pi, 400) # (1)!
y = np.sin(x ** 2)
plt.plot(x, y)
plt.show()

1. This is a comment in the code block.

Subheading#

Markdown is a lightweight markup language with plain-text-formatting syntax. Its design allows it to be converted to many output formats, but the original tool by the same name only supports HTML. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor.

Lorem Ipsum#

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Tables#

Lists#

Unordered#

• Item 1
• Item 2
• Item 2a
• Item 2b

Ordered#

1. Item 1
2. Item 2
3. Item 3
   1. Item 3a
   2. Item 3b

Tabs#

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

Images#

Links#

http://github.com - automatic! GitHub

Blockquotes#

As Kanye West said:

We're living the future so the present is our past.

Inline code#

Run the command: pip install my_package

Task Lists#

• @mentions, #refs, links, formatting, and tags supported
• list syntax required (any unordered or ordered list supported)
• this is a complete item
• this is an incomplete item

Emoji#

@octocat This PR looks great - it's ready to merge!

Definition Lists#

term

definition

term2

definition2

Strikethrough#

The world is flat

Heading IDs#

My Great Heading#

Line Breaks#

Here's a line for us to start with.

This line is separated from the one above by two newlines, so it will be a separate paragraph.

This line is also a separate paragraph, but... This line is only separated by a single newline, so it's a separate line in the same paragraph.

Admonitions#

from my_package import my_function

see docs on Custom Admonitions for customizing the icon

Inline Admonitions#

(must be declared prior to the block they are next to)

!!! info inline end "Lorem ipsum"

    Lorem ipsum dolor sit amet, consectetur
    adipiscing elit. Nulla et euismod nulla.
    Curabitur feugiat, tortor non consequat
    finibus, justo purus auctor massa, nec
    semper lorem quam in massa.

Keyboard keys#

Ctrl+Cmd+F

Buttons#

Subscribe to our newsletter

with icons

Send