Markdown guide
Markdown is a simple markup language that can be converted to plain HTML. Here are some of the basic elements you can use.
Headings
You can create headings by placing #
in front of your text. The number of #
determines the level of the heading.
# Heading 1
## Heading 2
### Heading 3
Text formatting
You can make text bold by placing it between two **
. To make text italic, place it between two two _
.
**This text is bold**
_This text is italic_
Lists
You can create unordered lists by placing -
in front of your list items.
- Element 1
- Element 2
- Element 3
Ordered lists can be created by placing the number and a dot in front of the list elements.
1st element 1
2. element 2
3. element 3
Links
You can create links by putting the link text in square brackets []
and the URL in round brackets ()
.
However, most links are also automatically recognized and converted into clickable links.
[Linktext](https://www.example.com)
Quotes
You can create quotes by prefixing the text with a >
.
> This is a quote
Horizontal lines
You can create horizontal lines by writing three or more -
in a line.
This allows you to separate sections.
---
Create new page (like wiki links)
You can create a new page by placing the link text or page name in double square brackets [[ ]]
.
The page is created automatically when it is called up and can then be edited.
[[target page]]
or
[[Target page|Displayed text]]
Usernames
The user name is automatically linked and displays information about the user on mouseover.
<user id=“shaack”/>
or in short form
<user id="shaack"/>
Diagrams
You can create chess diagrams with the following syntax.
<diagram value="rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 1" />
<diagram interactive="false" size="xs" value="rnbqkbnr/ppp1pppp/8/3p4/3P4/8/PPP1PPPP/RNBQKBNR w KQkq - 0 1" />
Parameters
value
: FEN notation of the diagram (required)interactive
: Allows pieces to be moved (true
orfalse
, optional, default:true
)size
: Maximum size of the diagram (xs
,sm
,md
,lg
, optional, standard:md
)orientation
: The color shown at bottom (white
,black
orauto
, optional, default:auto
)
Games
Games can be linked so that the current status of the game is automatically displayed.
Shows player names and the current half moves or the result:
<game id=“hg4JpONwsqFe”/>
Shows the score from the perspective of the player “shaack”:
<game id=“hg4JpONwsqFe” view=“shaack”/>
Shows the score from the white player's point of view:
<game id=“hg4JpONwsqFe” view=“white” note=“Note for the tournament committee”/>
In the first case, something like “shaack - Maiholz (1-0)” is displayed.
In the second case, the score is displayed from the point of view of the player “shaack”, i.e. simply “1”. This display can be used for tournament tables.
If the game is still in progress, the half-move is displayed, i.e. “shaack - Maiholz [23]” or simply “[23]”.
Parameters
id
: ID of the game (required)view
: Name of the player whose perspective is to be displayed (optional)