Intro to Markdown

This page contains a brief introduction to the Markdown markup used by this *PuzzleFoundry wiki.

Markdown is intended to be as easy-to-read and easy-to-write as is feasible. Markdown’s syntax is designed to be used as a format for writing for the web.

Tags are punctuation characters, which have been chosen so as to look like what they mean. End each paragraph with a blank line.

Wiki links

Links within the PuzzleFoundry Wiki need to have this format: [Have a look at this](/wiki/en/AwesomeWikiPage)

The word "wiki" followed by the two-letter code for the wiki language of the page, followed by the name of the page.

Wiki filenames are in normally CamelCase. Wiki links can include letters, numbers, dashes, underscores,and forward slashes.

Do not use HTML in this wiki

Normally HTML can be used in Markdown, but for security reasons HTML will be ignored in this Wiki.

Table of contents

You can add a table of contents anywhere in the wiki page by putting [TOC] on a line by itself.

Formatting of text

Character formats supported: **bold** bold , *italic* italic and `monospace` monospace

Superscript

E = mc2

Code:

*E = mc<sup>2</sup>*

Subscript

Plants need CO2 and H2O

Code:

Plants need CO<sub>2</sub> and H<sub>2</sub>O

Headings

Headings start with hashes: one for the main heading, two for a subheading, etc up to six hashes. Markdown code:

## Headings ##

Escaping special characters

If you ever need to use a literal such as [ for some reason,- use a backslash (\) immediately before the square bracket. This will prevent MarkWiki from turning it into a wiki link.

Blockquotes

In Markdown you can use email-style > characters for blockquoting. You can put a > before every line, or you can just put a quote at the start of each paragraph. This shows the markdown codes for a two-line paragraph.

In Markdown you can use email-style > characters for blockquoting. You can put one before
every line, or you can just put one at the start of each paragraph. You can put one before every line, or you can just put one at the start of each paragraph.

Code:

> In Markdown you can use email-style > characters for blockquoting.
> You can put one before every line, or you can just put one at the start of each paragraph.You can put one before every line, or you can just put one at the start of each paragraph.

Lists

There are two types of list. A list needs to start after a blank line. Bulleted lists can be started by typing *, -, or +. Numbered lists can be started by typing 1.

Bulleted lists

  • This is an bulleted list
  • These lists can be started by typing *, or -, or +
  • The list will automatically continue as you type
  • Press Enter twice to end the list

Numbered lists

  1. This is a numbered list
  2. Numbered lists can be started by typing 1.
  3. Press Enter twice to end the list

You can also embed images

Yes

Code:

![Yes](http://i.imgur.com/sZlktY7.png)

Tables

The Tables extension adds the ability to create tables in Markdown documents. In the code it is not necessary to line up the separators; when it is rendered they will line up automatically.

First Header Second Third Total widgets
First Cell first row Second Cell Third cell 2
Second row Second row second Cell Third cell 2222

Table code:

|First Header | Second | Third | Total widgets|
|------------ |:-------------:|:--------:| ----:|
|First Cell first row | Second Cell | Third cell | 2 |
|Second row | Second row second Cell | Third cell | 2222 |

Horizontal rule

Code:

---

Further details

For more details about Markdown see Daring Fireball

janusdelange 2018-01-27 10h14

PuzzleFoundry
PuzzleMan