Components

Typography

Headings

Heading is bold, larger font-size style has been applied. And heading takes a lot of margin in order to stand out.

This is an H1 Heading

This is an H2 Heading

This is an H3 Heading

This is an H4 Heading

This is an H5 Heading
This is an H6 Heading

Paragraph

Here are some paragraphs.

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Anchor

The a element is used to denote hyperlink text, for example:

Click here to go to Google or Click here to return to the Admonitions.

Strong, Emphasis

Strong: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante venenatis.

Emphasis: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante venenatis.

Table

The following example illustrates continuation lines (row 2 consists of two lines of text, and four lines for row 3), a blank line separating paragraphs (row 3, column 2), text extending past the right edge of the table, and a new row which will have no text in the first column in the processed output (row 4):

Header row, column 1 Header row, column 2
body row 1 Second column of row 1
body row 2

Second column of row 2

Second line of paragraph

body row 3
  • Second column of row 3
  • Second item in bullet list (row 3, column 2)
Row 4; column 1 will be empty

List

Unordered list

The ul element denotes an unordered list.

  • Unordered list
  • Unordered list
  • Unordered list

Ordered list

The ol element denotes an ordered list.

  1. Ordered list
  2. Ordered list
  3. Ordered list

Definition Lists

Definition lists, denoted by the dl element contain a list of terms and definitions. Terms are displayed with the dt, and definitions are displayed with the dd element.

term 1
Definition 1.
term 2
Definition 2, paragraph 1. Definition 2, paragraph 2.
term 3 : classifier
Definition 3.
term 4 : classifier one : classifier two
Definition 4.

Images

There are two image directives: “image” and “figure”.

image

Cherry Blossom

An “image” is a simple picture.

The URI for the image source file is specified in the directive argument. As with hyperlink targets, the image URI may begin on the same line as the explicit markup start and target name, or it may begin in an indented text block immediately following, with no intervening blank lines. If there are multiple lines in the link block, they are stripped of leading and trailing whitespace and joined together.

The following options are recognized:

  • alt
  • width
  • height
  • scale
  • align
  • target

figure

Cherry Blossom

Figure Cherry Blossom

A “figure” consists of image data (including image options), an optional caption (a single paragraph), and an optional legend (arbitrary body elements).

The following options are recognized:

  • alt
  • figwidth
  • figclass
  • width
  • height
  • scale
  • align
  • target

Pre, Code

import sys

def fact(x):
    if x == 0:
        return 1
    else:
        return x * fact(x-1)

Topic

A topic is like a block quote with a title, or a self-contained section with no subsections. Use the “topic” directive to indicate a self-contained idea that is separate from the flow of the document. Topics may occur anywhere a section or transition may occur. Body elements and topics may not contain nested topics.

Topic Title

Subsequent indented lines comprise the body of the topic, and are interpreted as body elements.

Admonitions

Admonitions are specially marked “topics” that can appear anywhere an ordinary body element can. They contain arbitrary body elements. Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded, with a title matching the admonition type.

For example:

Admonition title

This is sample of “Generic” admonition directive.

Attention

This is sample of “Attention” admonition directive.

Caution

This is sample of “Caution” admonition directive.

Danger

This is sample of “Danger” admonition directive.

Error

This is sample of “Error” admonition directive.

Hint

This is sample of “Hint” admonition directive.

Important

This is sample of “Important” admonition directive.

Note

This is sample of “Note” admonition directive.

Tip

This is sample of “Tip” admonition directive.

Warning

This is sample of “Warning” admonition directive.