3. Markdown
- Auteur
Tom De Mey
- Aanmaak
18 okt 2010 13:16
- Aangepast door
Tom De Mey
- Aangepast op
18 okt 2010 10:20
3.1. Abstract
Waar vroeger gebruikt gemaakt werd van HTML codes, zullen teksten die via Brocade online gepubliceerd worden (nieuwsitems Brocade desktop, archieftoepassingen, ...) nu ook opgemaakt kunnen worden met Markdown, een opmaaktaal met zeer eenvoudige/gebruiksvriendelijke syntax.
Dit document beschrijft de syntax van het Markdown-formaat.
3.2. Syntax
Om een nieuwe regel te beginnen:
In html:
<br>
In markdown
spatie spatie enter
Om een nieuwe paragraaf te beginnen:
In html:
<p>
In markdown
enter enter
Om hoofdingen/headers te creëren: Gebruik x aantal hekjes aan begin en eind van de hoofding of onderlijn met ==== (voor <h1>) of ---- (voor <h2>)
In html:
<h1>
Header 1</h1>
,<h2>
Header 2</h2>
, etc...In markdown
#header 1#, ##header 2##, ###header 3###, etc...
of
Header 1, header 2 ======== --------
Om tekst in italic te zetten:
In html:
<i>
italic</i>
In markdown
'*'italic'*'
Om tekst in bold te zetten:
In html:
<b>
bold</b>
In markdown
'**'bold'**'
Een combinatie van beide zijnde bold en italic:
In html:
<b><i>
bold en italic</i></b>
In markdown
'***'bold en italic'***'
Ongenummerde lijsten maken
- In html:
<ul>
<li>
item 1</li>
<li>
item 2</li>
</ul>
In markdown: Gebruik * of - of + aan begin van lijn. Blanco lijn toevoegen voor begin van lijst
* item 1 * item 2 * item 3 of - item 1 - item 2 - item 3 of + item 1 + item 2 + item 3
Genummerde lijsten
In html:
<ol>
<li>
item 1</li>
<li>
item 2</li>
</ol>
In markdown: Laat elke lijn voorafgaan door nummer - punt - spatie
1. item 1 2. item 2 3. item 3
Geneste lijsten creëren (= lijst in lijst)
- In html:
<ul>
<li>
item 1</li>
<ul>
<li>
item 1.1</li>
<li>
item 1.2</li>
</ul>
<li>
item 2</li>
<li>
item 3</li>
</ul>
In markdown: Laat item voorafgaan door 4 spaties
- item 1 - item 1.1 - item 1.2 - item 2 - item 3
Links: Meer info over markdown vind je hier
In html: Meer info vind je <a href="http://daringfireball.net/projects/markdown/">hier</a>
In markdown : Meer info vind je [hier](http://daringfireball.net/projects/markdown/)
Escaping
Om de tekens hieronder netjes in een html te kunnen tonen, dien je ze te "escapen":
<
wordt<
>
wordt>
&
moet worden&
Tools
Beschik je over HTML en wil je die omzetten naar Markdown?
In Brocade: gebruik https://anet.be/menu/cnvmd om je HTML om te zetten naar Markdown.
Gebruik bv. pandoc : conversie html, pandoc , rst, …
Wil je in Markdown invoeren en meteen het resultaat zien in HTML?
Online Markdown editor: dingus
op je PC: MarkdownPad
Tutorial: http://commonmark.org/help/tutorial/