Test¶

plain badge

primary, primary-line

secondary, secondary-line

success, success-line

info, info-line

warning, warning-line

danger, danger-line

light, light-line

dark, dark-line

Title

Text

Header

Title

Content

Footer

Header

Title

Content

Footer

One

Two (only-dark)

Two (only-light)

Three

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!

斜体

粗体

代码样例

This is a bulleted list.
It has two items, the second item uses two lines.

This is a numbered list.
It has two items too.
This is a numbered list.
It has two items too.

this is
a list
- with a nested list
- and some subitems
and here the parent list continues

term (up to a line of text)

Definition of the term, which must be indented

and can even consist of multiple paragraphs

next term

Description.

These lines are
broken exactly like in
the source file.

This is a normal text paragraph. The next paragraph is a code sample:

It is not processed in any way, except
that the indentation is removed.

It can span multiple lines.

This is a normal text paragraph again.

CPP code::: int a = 0;

>>> 1 + 1
2

Header row, column 1 (header rows optional)	Header 2	Header 3	Header 4
body row 1, column 1	column 2	column 3	column 4
body row 2	…	…

A	B	A and B
False	False	False
True	False	False
False	True	False
True	True	True

This is a paragraph that contains a link.

Math¶

This is a test. Here is an equation: \(X_{0:5} = (X_0, X_1, X_2, X_3, X_4)\). Here is another:

(1)¶\[\nabla^2 f = \frac{1}{r^2} \frac{\partial}{\partial r} \left( r^2 \frac{\partial f}{\partial r} \right) + \frac{1}{r^2 \sin \theta} \frac{\partial f}{\partial \theta} \left( \sin \theta \, \frac{\partial f}{\partial \theta} \right) + \frac{1}{r^2 \sin^2\theta} \frac{\partial^2 f}{\partial \phi^2}\]

You can add a link to equations like the one above (1) by using :eq:.

This is a heading 2¶

This is a heading 3¶

This is a heading 4¶

This is a heading 5¶

This is a heading 6¶

fieldname:: Field content

def my_function(my_arg, my_other_arg):

“””A function just for me.

param my_arg:: The first of my arguments.
param my_other_arg:: The second of my arguments.
returns:: A message (just for me, of course).

“””

This is interpreted text

This is abbreviation text

This is acronym text

This is code text

This is emphasis text

This is literal text

This is \(math text\)

This is strong text

This is _{subscript text}

This is ^{superscript text}

This is title-reference text

Please RTFM [1].

Here is a citation reference: [CIT2002].

[CIT2002]

This is the citation. It’s just like a footnote, except the label is textual.

Clicking on this internal hyperlink will take us to the target below.

The hyperlink target above points to this paragraph.

备注

This is a paragraph

Here is a bullet list.

[this]

however, is a citation.

危险

Beware killer rabbits!

class MyClass : public MyBase, MyOtherBase¶

备注

This is a note admonition. This is the second line of the first paragraph.

The note contains all indented body elements following.
It includes this bullet list.

注意

This is a attention admonition. This is attention.

小心

This is a caution admonition. This is caution.

危险

This is a danger admonition. This is danger.

错误

This is a error admonition. This is error.

提示

This is a hint admonition. This is hint.

重要

This is a important admonition. This is important.

备注

This is a note admonition.

This is note.

小技巧

This is a tip admonition. This is tip.

警告

This is a warning admonition. This is warning.

And, by the way…

You can make up your own admonition too.

Version:: 1.1

map to buried treasure — This is the caption of the figure (a simple paragraph).¶

The legend consists of all elements after the caption. In this case, the legend consists of this paragraph and the following table:

Symbol

Meaning

Campground

Lake

Mountain

Symbol	Meaning
	Campground
	Lake
	Mountain

备注

texts

This paragraph might be rendered in a custom way.

( (title, subtitle?)?,
  decoration?,
  (docinfo, transition?)?,
  %structure.model; )

def my_function():
    "just a test"
    print 8/2

float value = 10.0f;
VkPhysicalDevice physical_device = VK_NULL_HANDLE;

int32_t value = 0;
VkInstance instance = VK_NULL_HANDLE;

No matter where you go, there you are.

—Buckaroo Banzai

highlights

—highlights

pull-quote

—pull-quote

The ‘rm’ command is very dangerous. If you are logged in as root and enter

cd /
rm -rf *

you will erase the entire contents of your file system.

Truth table for “not”¶
A	not A
False	True
True	False

Frozen Delights!¶
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

Frozen Delights!¶
Treat	Quantity	Description
Albatross	2.99	On a stick!
Crunchy Frog	1.49	If we took the bones out, it wouldn’t be crunchy, now would it?
Gannet Ripple	1.99	On a stick!

An example of a default role.

An example of using interpreted text

some.module.name.foo(x)¶
some.module.name.foo(y, z): Return a line of text input from the user.

Lorem ipsum [Ref] dolor sit amet.

[Ref]

Book or article reference, URL or whatever.

try_stmt  ::=  try1_stmt | try2_stmt
try1_stmt ::=  "try" ":" suite
               ("except" [expression ["," target]] ":" suite)+
               ["else" ":" suite]
               ["finally" ":" suite]
try2_stmt ::=  "try" ":" suite
               "finally" ":" suite

It refers to the section itself, see This is a heading 2.