Markdown
Markdown aims to provide a light-weight markup language, so that you can format text without having to learn a more involved language like HTML. You can use markdown on pages on the Fifth World website, along with a few options specific to this site, like linking to wiki pages, tagging pages, and using templates. This page provides our documentation on how to use markdown on the Fifth World website. We have leaned heavily on Adam Pritchard’s [Markdown Cheatsheet] (https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) as a base.
#Contents
#Headers
## Section heading (h2)
### Subsection (h3)
#### Sub-subsection (h4)
##### Do you really need to go down this deep? (h5)
#Emphasis
Emphasis, aka italics, with *asterisks* or _underscores_.
Strong emphasis, aka bold, with **asterisks** or __underscores__.
Combined emphasis with **asterisks and _underscores_**.
Strikethrough uses two tildes. ~~Scratch this.~~
Emphasis, aka italics, with asterisks or underscores.
Strong emphasis, aka bold, with asterisks or underscores.
Combined emphasis with asterisks and underscores.
Strikethrough uses two tildes. Scratch this.
#Lists
In this example, we show leading and trailing spaces with dots.
1. First ordered list item
2. Another item
⋅⋅* Unordered sub-list.
1. Actual numbers don’t matter, just that it’s a number
⋅⋅1. Ordered sub-list
4. And another item.
⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we’ll use three here to also align the raw Markdown).
⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅
⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅
⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
* Unordered list can use asterisks
- Or minuses
+ Or pluses
- First ordered list item
- Another item
- Unordered sub-list.
- Actual numbers don’t matter, just that it’s a number
- Ordered sub-list
- And another item.
You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we’ll use three here to also align the raw Markdown).
To have a line break without a paragraph, you will need to use two trailing spaces. Note that this line is separate, but within the same paragraph.⋅⋅ (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.)
- Unordered list can use asterisks
- Or minuses
- Or pluses
#Links
Create a link to a page on the site like this: [[Orality]]
You can link to a page with your own text [[Orality | like this]].
Sometimes multiple pages might have the same name, if they have different parents, so you might want to specify a specific path, like [[/orality]]. Generally, you should use this with the pipe option to provide text for the link, [[/orality | like this]].
[You can link to other sites, too.](https://thefifthworld.com)
[You can also provide a title along with your external links.](https://thefifthworld.com “The Fifth World Homepage”)
URLs and URLs in angle brackets will automatically get turned into links.
https://thefifthworld.com or
Create a link to a page on the site like this: Orality
You can link to a page with your own text like this.
Sometimes multiple pages might have the same name, if they have different parents, so you might want to specify a specific path, like /orality. Generally, you should use this with the pipe option to provide text for the link, like this.
[I’m an external link with a title](https://thefifthworld.com “The Fifth World Homepage”)
URLs and URLs in angle brackets will automatically get turned into links. https://thefifthworld.com or https://thefifthworld.com
#Tables
You can use colons to align columns.
| Tables | Are | Cool |
| ——————- |:——————-:| ——-:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |
You need at least 3 dashes separating each header cell.
You can leave out the outer pipes (|), and you don’t need to make the raw Markdown line up You can also use inline Markdown.
Markdown | Less | Pretty
—- | —- | —-
*Still* | `renders` | **nicely**
1 | 2 | 3
You can use colons to align columns.
| Tables | Are | Cool | | ——————- |:——————-:| ——-:| | col 3 is | right-aligned | $1600 | | col 2 is | centered | $12 | | zebra stripes | are neat | $1 |
You need at least 3 dashes separating each header cell. You can leave out the outer pipes (|), and you don’t need to make the raw Markdown line up You can also use inline Markdown.
Markdown | Less | Pretty
—- | —- | —-
Still | renders
| nicely
1 | 2 | 3
#Quotes
> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.
Quote break.
> This is a very long line that will still be quoted properly when it wraps. Oh boy let’s keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote.
Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.
Quote break.
This is a very long line that will still be quoted properly when it wraps. Oh boy let’s keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can put Markdown into a blockquote.
#Horizontal rules
Three or more…
—-
Hyphens
***
Asterisks
___
Underscores
Three or more…
—-
Hyphens
Asterisks
Underscores
#Tags
You can tag a page with a particular value, providing a key-value pair by which you can later search for or list pages. For example, you can add the name of an author to a story or novel with a tag like this:
[[Author:Giulianna Maria Lamanna]]
You can add any tag you like to any page, and set it to any value. The site won't render tags, but you can search for them using the Fifth World API's GET /pages
endpoint, or list them with the ListPages template.
#Templates
Templates allow us to make pages with regular, reusable parts, render special, dynamic content, or mark pages with particular data structures.
Using a template on a page usually involves a string of text wrapped in a pair of curly brackets, like so:
{{TemplateName}}
Templates can have parameters, too, written like this:
{{TemplateName parameter1=”v1” parameter2=”v2”}}
If you add this to a page, rather than rendering the string as you wrote it, the Fifth World API will look for a template called TemplateName
. If the template exists, the API will render it (using v1
for parameter1
and v2
for parameter2
), and replace the string with the result of that rendering. If it doesn’t exist, the API will simply remove the string from the rendered page.