Remarkdown styles
Here are all the styles provided by Remarkdown. When using the remarkdown.css stylesheet:
- Default styles are enabled with the
remarkdownclass. - Optional styles are enabled with their respective class names:
class="remarkdown style-name".
| Style name | Default | Description |
|---|---|---|
| base-reset | Yes † | Set the base font and line-height |
| hn-reset | Yes † | Reset heading text styles |
| hn-prefix | Yes | Add “#” characters before headings |
| h1-line | — | Underline H1s with equals |
| h2-line | — | Underline H2s with hyphens |
| ol-decimal | Yes | Use decimal numbers for OL items |
| ol-zero | — | Use zeroes for all OL items |
| ol-alpha | — | Use lowercase letters for OL items |
| ul-dash | Yes | Use “-” for bullets |
| ul-star | — | Use “*” for bullets |
| ul-plus | — | Use “+” for bullets |
| quote-mark | — | Use “>” signs for blockquotes |
| a-bracket | Yes | Add square brackets around links. |
| a-showurl | — | Show URLs after links |
| em-reset | Yes † | Reset EM font style |
| em-star | Yes | Surround EMs with “*” |
| em-underscore | — | Surround EMs with “_” |
| strong-reset | Yes † | Reset STRONG font style |
| strong-star | Yes | Surround STRONGs with “**” |
| strong-underscore | — | Surround STRONGs with “__” |
| code-tick | Yes | Wrap CODE in “`” (backticks) |
| pre-indent | Yes | Left indent PRE elements |
| pre-tick | — | Wrap PRE in “```” |
| pre-tilde | — | Wrap PRE in “~~~” |
| pre-tilde-full | — | Wrap PRE in a full line of “~” |
| hr-star | Yes | Use “*” signs for HRs |
| hr-dash | — | Use “-” signs for HRs |
| hr-center | — | Horizontally center HRs |
| del-tilde | — | Wrap DEL in “~~” (GFM style) |
| table-reset | — | Plain text rendering for TABLE |
| table-border | — | Use “|” and “-” for TABLE borders |
| table-border-full | — | Add left and right borders |
† Default styles for the Remarkdown-zero variant.
Base text style
Default: base-reset
Text should be rendered in a monospace font (unless specified otherwise with the --rmd-base-font CSS variable or the $base-font Sass option).
Paragraphs should be separated by a blank line.
Headings
Defaults: hn-reset and hn-prefix
Heading level 1
Heading level 2
Heading level 3
Heading level 4
Heading level 5
Heading level 6
Options: h1-line and h2-line
Underlined H1
Underlined H2
Underlined headings cannot be centered with text-align:center. You will need to use auto margins:
Underlined H1
Underlined H2
Note that headings with text wrapping will have a full-width underline:
A long heading… possimus officia, ducimus nihil beatae dolore vitae, perspiciatis ex quaerat placeat, perferendis
Unordered lists
Default: ul-dash
- This is a list.
- With a second item.
- Nested lists work too.
- This is so cool.
- And a third one.
Option: ul-star
- This is a list.
- With a second item.
- And a third one.
Option: ul-plus
- This is a list.
- With a second item.
- And a third one.
Ordered lists
Default: ol-decimal
- This is a list.
- With a second item.
- Nested lists work too.
- This is so cool.
- And a third one.
Option: ol-zero
- This is a list.
- With a second item.
- And a third one.
Option: ol-alpha
- This is a list.
- With a second item.
- And a third one.
Blockquotes
Default: quote-mark
Saepe blanditiis ratione ipsum tempore quam aspernatur at doloremque deleniti minima commodi. Impedit, assumenda.
Here comes a second paragraph.
Links
Default: a-bracket
Fly me to the moon, and let me play among the stars. Let me see what spring is like on a-Jupiter and Mars.
Option: a-showurl
Fly me to the moon, and let me play among the stars. Let me see what spring is like on a-Jupiter and Mars.
Emphasis
Default: em-reset and em-star
This is literally figurative!
Option: em-underscore
This is literally figurative!
Default: strong-reset and strong-star
This is figurative. Literally.
Option: strong-underscore
This is figurative. Literally.
Code and code blocks
Default: code-tick
Some inline code: var someCode = 'lulz'.
Default: pre-indent
A paragraph.
pre {
margin-left: 3ch;
tab-size: 4;
}
Another paragraph.
Option: pre-tick
A code block
Option: pre-tilde
A code block
Option: pre-tilde-full
A code block
Horizontal rules
Default: hr-star
Option: hr-dash
Option: hr-center
Other
Option: del-tilde
Remarkdown is preposterous peculiar.
Tables
Option: table-reset
Resets some table styles: no borders, no centered text, no bold table headers.
| Col 1 | Col 2 | Col 3 |
|---|---|---|
| Lorem ipsum | Dolor sit amet | Consectetur adipisicing elit |
| Quae enim corrupti | Excepturi laudantium molestiae nam | Repellat ab nostrum, est tempora minus dolores magni voluptatibus? |
Option: table-border
Print | separators between columns, and -- underlines below column headers. This style draws inspiration from Markdown Extra.
| Col 1 | Col 2 | Col 3 |
|---|---|---|
| Lorem ipsum | Dolor sit amet | Consectetur adipisicing elit |
| Quae enim corrupti | Excepturi laudantium molestiae nam | Repellat ab nostrum, est tempora minus dolores magni voluptatibus? |
Option: table-border-full
Also print | borders at the left and right edges of the table. Works in Chrome and Firefox, but only partially in Safari (rightmost border will be missing; WebKit doesn’t support pseudo-elements for <tr>).
| Col 1 | Col 2 | Col 3 |
|---|---|---|
| Lorem ipsum | Dolor sit amet | Consectetur adipisicing elit |
| Quae enim corrupti | Excepturi laudantium molestiae nam | Repellat ab nostrum, est tempora minus dolores magni voluptatibus? |