A Simple Guide To Markdown on Republic-Online
Table of Contents
About Markdown
Markdown is a plain text formatting syntax created by John Gruber, aiming to provide an easy-to-read and feasible markup. The original Markdown syntax specification can be found here.
On Republic-Online, we try to support most of the important Markdown syntax. We love and appreciate markdown as opposed to raw html or bbcodes.
We have compiled a list of syntax below to help you get started and tame the beauty and power of Markdown - Enjoy!
PS: This whole content was written in Markdown :)
Line Breaks
To force a line break, put two spaces and a newline (return) at the end of the line.
-
This two-line bullet
won't break -
This is a one-line bullet
Here is the code:
* This two-line bullet
won't break
* This is a one-line bullet
Strong and Emphasize
Strong:
**Strong** or __Strong__
Emphasize:
*Emphasize* or _Emphasize_
Strikethrough
~~Much wow~~ becomes Much wow
Underline
<u>So doge</u> becomes So doge
Superscript
hoge<sup>fuga</sup> becomes hogefuga
Intra-word emphasis:
So A\*maz\*ing becomes So A*maz*ing
Headers (like this one!)
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
or
Header 1
========
Header 2
--------
Links and Email
Inline
-
Just put angle brackets around an email and it becomes clickable: contact@republic-online.net
<contact@republic-online.net> -
Same thing with urls: https://republic-online.net
<https://republic-online.net> -
Perhaps you want to some link text like this: Republic-Online Game Website
[Republic-Online Game Website](https://republic-online.net "Title")(The title is optional)
Reference style
Sometimes it looks too messy to include big long urls inline, or you want to keep all your urls together.
Make a link [a link][arbitrary_id] then on it's own line anywhere else in the file:
[arbitrary_id]: https://republic-online.net "Title"
If the link text itself would make a good id, you can link like this [like this][], then on it's own line anywhere else in the file:
[like this]: https://republic-online.net
Images
Example:
will display the following avatar:
Lists
- Lists must be preceded by a blank line (or block element)
- Unordered lists start each item with a
*
-works too- Indent a level to make a nested list
- Ordered lists are supported.
- Start each item (number-period-space) like
1. - It doesn't matter what number you use, I will render them sequentially
- So you might want to start each line with
1.and let me sort it out
- Indent a level to make a nested list
Here is the code:
* Lists must be preceded by a blank line (or block element)
* Unordered lists start each item with a `*`
- `-` works too
* Indent a level to make a nested list
1. Ordered lists are supported.
2. Start each item (number-period-space) like `1. `
42. It doesn't matter what number you use, I will render them sequentially
1. So you might want to start each line with `1.` and let me sort it out
Block Quote
Angle brackets > are used for block quotes.
Technically not every line needs to start with a > as long as
there are no empty lines between paragraphs.
Looks kinda ugly though.
but who cares
as long as you know what you are doingOne last line in this quote.. here we end!
Here is the code:
> Looks kinda ugly though.
> but who cares
> as long as you know what you are doing
>
> One last line in this quote.. here we end!
Horizontal Rules
If you type three asterisks *** or three dashes --- on a line, I'll display a horizontal rule:
Table of Content
Apart from the above syntax, Republic-Online also allows you to generate a Table of Content (aka toc) for your "content".
To enable the toc, simple copy and paste the below at the start of your contents:
[scode]toc[/scode]
The rendered toc is exactly the same as the toc at the start of this page as you have already observed ;)
Enjoy!