¶ Overview
Markdown is a lightweight markup language with plain text formatting syntax. It’s the de-facto syntax for writing documentation on major code repositories such as GitHub.
Urantiapedia supports the full CommonMark specification + adds some useful extensions (including the Github Flavored Markdown addons).
This is a comprehensive list of Markdown markup that is supported in Urantiapedia. For each element supported you have: how to use it in editor, shortcuts if exist and examples with the markup and the result. Give a look at all the available options before using Markdown format in any page.
¶ Headings
Using between 1 and 6 hashtag symbol(s), followed by a space, before the text selection.
- On the desired line, then clicking the
dropdown button in the toolbar. - On the desired line, press CTRL + ALT + Right to increase the header level.
- On the desired line, press CTRL + ALT + Left to decrease the header level.
Markdown
# h1 Heading 8-)
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
Result
For a list of supported emojis see below.
¶ Horizontal lines
Using triple dash symbols on a dedicated line.
- By clicking the
button in the toolbar.
Markdown
___
---
***
Result
¶ Typographic replacements
Type text as usual.
Markdown
(c) (C) (r) (R) (tm) (TM) (p) (P) +-
test.. test... test..... test?..... test!....
!!!!!! ???? ,, -- ---
"Smartypants, double quotes" and 'single quotes'
Result
© © ® ® ™ ™ § § ±
test… test… test… test?.. test!..
!!! ??? , – —
“Smartypants, double quotes” and ‘single quotes’
¶ Emphasis
Italic: Using a single asterisk symbol before and after the text selection.
Bold: Using double asterisks symbols before and after the text selection.
- By selecting text, then clicking the
button in the toolbar. - By selecting text, then pressing CTRL + B
Markdown
**This is bold text**
__This is bold text__
*This is italic text*
_This is italic text_
~~Strikethrough~~
***Bold & italic***
Result
This is bold text
This is bold text
This is italic text
This is italic text
Strikethrough
Bold & italic
¶ Blockquotes
Using a greater-than symbol, followed by a space, before each line of text.
- By selecting text, then clicking the
button in the toolbar.
Markdown
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
Result
Blockquotes can also be nested…
…by using additional greater-than signs right next to each other…
…or with spaces between arrows.
Custom blockquotes
Markdown
> This is an info blockquote
{.is-info}
> This is a success blockquote
{.is-success}
> This is a warning blockquote
{.is-warning}
> This is an error blockquote
{.is-danger}
Result
This is an info blockquote
This is a success blockquote
This is a warning blockquote
This is an error blockquote
¶ Unordered Lists
Using an asterisk or a dash symbol, followed by a space, before each line of text.
- By selecting text, then clicking the
button in the toolbar.
Markdown
+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
* Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
+ Very easy!
Result
- Create a list by starting a line with
+,-, or* - Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
By adding a class on a separate line, after the list, you can change the look of the list:
links-listgrid-list
Markdown
- Grid Item 1
- Grid Item 2
- Grid Item 3
{.grid-list}
- [Lorem ipsum dolor sit amet *Subtitle description here*](https://www.google.com)
- [Consectetur adipiscing elit *Another subtitle description here*](https://www.google.com)
- [Morbi vehicula aliquam *Third subtitle description here*](https://www.google.com)
{.links-list}
Result
- Grid Item 1
- Grid Item 2
- Grid Item 3
and:
- Link Title 1 Subtitle description here
- Link Title 2 Another subtitle description here
- Link Title 3 Third subtitle description here
Note that these stylings are specific to Urantiapedia and will fallback to standard list styling in other applications.
¶ Ordered Lists
Using an number, followed by a dot symbol, followed by a space, before each line of text.
- By selecting text, then clicking the
button in the toolbar.
Markdown
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`
Result
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Integer molestie lorem at massa
-
You can use sequential numbers…
-
…or keep all the numbers as
1.
Start numbering with offset:
Markdown
1. foo
2. bar
Result
57. foo
- bar
¶ Code
¶ Inline code
Using backticks before and after the text selected.
- By selecting text, then clicking the
button on the toolbar.
Markdown
Inline `code`
Result
Inline code
¶ Indented code
Adding tabs before each line.
Markdown
// Some comments
line 1 of code
line 2 of code
line 3 of code
Result
// Some comments
line 1 of code
line 2 of code
line 3 of code
¶ Block code “fences”
Use triple backticks symbols before and after text selection, on dedicated lines.
- Using the Code Block tool on the left toolbar.
Markdown
```
Sample text here...
```
Result
Sample text here...
¶ Syntax highlighting
Use triple backticks symbols before and after the text selection, on dedicated lines, and then the programming language code (js, html, css, etc).
- Using the Code Block tool on the left toolbar.
Markdown
```js
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
```
Result
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
¶ Tables
Separate cells in the table using vertical bar.
Markdown
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Result
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right aligned columns
Markdown
| Option | Description |
| ------:| -----------:|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Result
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
¶ Links
Using the syntax [Link Text](Link Target).
- Using the Link tool on the left toolbar.
Markdown
[link text](http://dev.nodeca.com)
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
Result
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
¶ Images
Using the syntax .
- Using the Resources tool on the left toolbar.
Markdown
![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat" =300x300)
Result
Like links, Images also have a footnote style syntax
Markdown
![Alt text][id]
Result
With a reference later in the document defining the URL location:
Markdown
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat" =300x300
Result
Sometimes the images are too big or maybe you want the image to take up all the available space.
Simply in the dimensions at the end of the image path in the following format:
You can also omit one of the values to automatically maintain the image ratio:
It is also possible to use other units, such as %. Useful when you need the image to take up all the available space:
¶ SVG
SVG can be included as any other content supported by browsers.
Markdown
<svg width="100" height="100">
<circle cx="50" cy="50" r="40" stroke="green" stroke-width="4" fill="yellow" />
</svg>
Result
¶ Maps
By means of an iframe that points to a map made on a map platform. This is a temporary way to add dynamic maps until the map editor is available.
Markdown
<iframe src="https://www.google.com/maps/d/u/0/embed?mid=1BmwnWua1TecE9a0-es5FFKCRO2ZmqYQ&ehbc=2E312F" width="640" height="480"></iframe>
Result
¶ Emojies
Using the :identifier: syntax
See supported emojis in Emoji Cheat sheet
See how to change output with twemoji.
Markdown
> Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:
>
> Shortcuts (emoticons): :-) :-( 8-) ;)
Result
Classic markup:
:crush:
:tear:
Shortcuts (emoticons):
See supported emojis at Emoji Cheat sheet
See how to change output with twemoji.
¶ Subscript
Use a simple tilde symbol before and after the text selection.
- Selecting text, then clicking the
button on the toolbar .
Markdown
- H~2~O
Result
- H2O
¶ Superscript
Using a unique caret before and after the text selection.
- Selecting text, then clicking the
button on the toolbar .
mark down
- 19^th^
Result
- 19th
¶ Inserted text
Markdown
++Inserted text++
Result
++Inserted text++
¶ Mark text
Markdown
==Marked text==
Result
==Marked text==
¶ Footnotes
Use the syntax [^1] for the footnote location in the main text, and [^1]: this is a footnote for the actual footnote. The footnotes themselves will automatically appear at the bottom of the page below a horizontal line.
Markdown
Footnote 1 link[^first].
Footnote 2 link[^second].
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference[^second].
[^first]: Footnote **can have markup**
and multiple paragraphs.
[^second]: Footnote text.
Result
Footnote 1 link[1].
Footnote 2 link[2].
Inline footnote[3] definition.
Duplicated footnote reference[2:1].
¶ Definition lists
Markdown
Term 1
: Definition 1
with lazy continuation.
Term 2 with *inline markup*
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Result
Term 1
: Definition 1
with lazy continuation.
Term 2 with inline markup
: Definition 2
{ some code, part of Definition 2 }
Third paragraph of definition 2.
Markdown
Term 1
~ Definition 1
Term 2
~ Definition 2a
~ Definition 2b
Result
Term 1
~ Definition 1
Term 2
~ Definition 2a
~ Definition 2b
¶ Abbreviations
This is HTML abbreviation example.
It converts “HTML”, but keep intact partial entries like “xxxHTMLyyy” and so on.
Markdown
*[HTML]: Hyper Text Markup Language
Result
¶ Custom containers
Markdown
::: warning
*here be dragons*
:::
Result
::: warning
here be dragons
:::
¶ Advanced tables
Markdown
| | Grouping ||
First Header | Second Header | Third Header |
------------ | :-----------: | -----------: |
Content | *Long Cell* ||
Content | **Cell** | Cell |
New section | More | Data |
And more | With an escaped \| ||
[Prototype table]
Result
| Grouping | ||
|---|---|---|
| First Header | Second Header | Third Header |
| Content | Long Cell | |
| Content | Cell | Cell |
| New section | More | Data |
| And more | With an escaped | | |
Markdown
| Markdown | Rendered HTML |
|--------------|---------------|
| *Italic* | *Italic* | \
| | |
| - Item 1 | - Item 1 | \
| - Item 2 | - Item 2 |
| ```python | ```python \
| .1 + .2 | .1 + .2 \
| ``` | ``` |
Result
| Markdown | Rendered HTML |
|---|---|
|
Italic |
|
|
|
|
Markdown
Stage | Direct Products | ATP Yields
----: | --------------: | ---------:
Glycolysis | 2 ATP ||
^^ | 2 NADH | 3--5 ATP |
Pyruvaye oxidation | 2 NADH | 5 ATP |
Citric acid cycle | 2 ATP ||
^^ | 6 NADH | 15 ATP |
^^ | 2 FADH2 | 3 ATP |
**30--32** ATP |||
[Net ATP yields per hexose]
Result
| Stage | Direct Products | ATP Yields |
|---|---|---|
| Glycolysis | 2 ATP | |
| 2 NADH | 3–5 ATP | |
| Pyruvaye oxidation | 2 NADH | 5 ATP |
| Citric acid cycle | 2 ATP | |
| 6 NADH | 15 ATP | |
| 2 FADH2 | 3 ATP | |
| 30–32 ATP | ||
Markdown
| Archetypes ||
--- | ---
Adam and Eve | Faith
Lucifer | Prophecy
Satan Guardian | Angels
Melchizedek | Life after death
Seraphim | The Kingdom of Heaven
Heaven | The Apostles
Hell | Jesus and the stories of His Life and Teachings
Salvation | The “Second Coming”
Result
| Archetypes | |
|---|---|
| Adam and Eve | Faith |
| Lucifer | Prophecy |
| Satan Guardian | Angels |
| Melchizedek | Life after death |
| Seraphim | The Kingdom of Heaven |
| Heaven | The Apostles |
| Hell | Jesus and the stories of His Life and Teachings |
| Salvation | The “Second Coming” |
¶ Mathematical expressions (Mathjax)
See the external links to learn more about using Math in Markdown.
Processes TeX displayed math
Markdown
$$1 *2* 3$$
Processes TeX in-line math $1 *2* 3$
Result
Processes TeX in-line math
Markdown
When $a \ne 0$, there are two solutions to $ax^2 + bx + c = 0$ and they are
$$x = {-b \pm \sqrt{b^2-4ac} \over 2a}.$$
$$\frac{1}{\sqrt{x^2 + 1}}$$
Result
When , there are two solutions to and they are
Markdown
__O^1^ O^2^ O^3^ O^4^ O^5^ O^6^ O^7^ O^8^ O^9^ <u>O</u>^10^ O^11^ O^12^__
Result
O1 O2 O3 O4 O5 O6 O7 O8 O9 O10 O11 O12
Markdown
$$V = H_0 * D, $$
Result
Markdown
In most part yes, in $1/4$ no.
Result
In most part yes, in no.
Markdown
description | code | examples
--- | --- | ---
Greek letters | \alpha \beta \gamma \rho \sigma \delta \epsilon | $\alpha \beta \gamma \rho \sigma \delta \epsilon$
Binary operators | \times \otimes \oplus \cup \cap | $\times \otimes \oplus \cup \cap$
Relation operators | < > \subset \supset \subseteq \supseteq | $< > \subset \supset \subseteq \supseteq$
Others | \int \oint \sum \prod | $\int \oint \sum \prod$
Result
| description | code | examples |
|---|---|---|
| Greek letters | \alpha \beta \gamma \rho \sigma \delta \epsilon | |
| Binary operators | \times \otimes \oplus \cup \cap | |
| Relation operators | < > \subset \supset \subseteq \supseteq | |
| Others | \int \oint \sum \prod |
Markdown
$$ \max dS/dt = \pm \begin{cases} wR, R \leq D \\ wD, R \geq D \end{cases}$$
Result
Markdown
Earth mass = $M^\odot$
Result
Earth mass =
¶ Content Tabs
Use headers and add the {.tabset} class to the main header. The main header text will not be displayed in the final result.
Note that you can use any header level, as long as the child headers are one level higher. For example, if a main header is ### (h3), tab headers should be #### (h4). The maximum header level for a parent is 5 and children are 6.
# Tabs {.tabset}
## FirstTab
Any content here will go into the first tab...
## Second Tab
Any content here will go into the second tab...
## ThirdTab
Any content here will go into the third tab...
¶ Show keyboard keys
Using <kbd> before and </kbd> after the text selection.
- Selecting text, then clicking the
button on the bar of tools.
Lorem ipsum pain <kbd>CTRL</kbd> + <kbd>C</kbd>
Lorem ipsum pain CTRL + C
¶ External links
- Urantiapedia Tools - GitHub project
- Urantiapedia-backup - GitHub project
- Urantia Foundation
- Blue Fields
- Wiki.js
- MultiMarkdown User’s Guide
- Markdown Specification
- Markdown Help
- Markdown Extended Syntax
- Markdown Wiki.js Help
- Emoji Cheat sheet
- Change emoji output
- Mathjax
- Mathjax documentation
- LaTeX Math expressions