Markdown Syntax

Markdown Syntax

The DyvilDoc syntax inherits a lot of styles from the Markdown standard. This chapter lists all the available styles.

Italics

Italics can be created using single asterisks around a sequence of words or letters.
*italic text*
italic text

Bold

Bold Text is marked with two consecutive asterisks.
**bold text**
bold text

Underline

Underlined text uses single underscores around the text.
_underlined text_
underlined text

Strikethrough

Text can be striked-through using tilde symbols ~ around it.
~strikethrough text~
strikethrough text
Links use the standard Markdown syntax, with the link text in square brackets [] and the link in parentheses ().
[Example](example.com)
Example

Images

Images can be included in DyvilDoc comments as well, prefixing the link syntax with an exclamation mark. Hovering the mouse over the image displays the text in square brackets.
![Example](https://avatars0.githubusercontent.com/u/13403711?v=3&s=200)
Example

Headlines

Headlines are marked with one to six hash symbols at the beginning of a line
# Title
## Headline
### Section
#### Subsection
##### Subsubsection
###### Caption

Title

Headline

Section

Subsection
Subsubsection
Caption

Separators

Separator lines are marked with three or more dashes at the beginning of a line
---

Quote Blocks

To display quotes in DyvilDoc comments, you can add a > symbol at the beginning of a line. Quoted text follows syntax and style rules.
> Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.