Markdown
Markdown is een eenvoudige opmaaktaal waarmee je tekst kunt opmaken zonder ingewikkelde editors. Binnen StepBridge wordt Markdown gebruikt op allerlei plekken, zoals bij sjablonen, berichten en spelcommentaar.
Waarom Markdown?
- Eenvoudig te leren: je hoeft geen HTML of andere code te kennen.
- Leesbaar zonder opmaak: de brontekst blijft goed leesbaar, ook zonder voorvertoning.
- Consistent: dezelfde opmaak levert overal hetzelfde resultaat op.
Markdown editors
Op sommige plekken binnen StepBridge, zoals bij sjablonen, is een Markdown-editor beschikbaar die zowel de Markdown-codes toevoegt als direct de opmaak toont en waarbij je de opmaak kan toepassen via een knoppenbalk in de editor.
Waar geen Markdown-editor aanwezig is, kun je ervoor kiezen om teksten via een externe tool op te maken en vervolgens de Markdown te kopiëren. Voor eenvoudige opmaak raden we echter aan om de basiscodes uit je hoofd te leren — dat gaat uiteindelijk sneller. Zie de sectie Handige links onderaan deze pagina voor verwijzingen naar externe editors.
Kaartsymbolen
StepBridge heeft de Markdown standaard uitgebreid met kaartsymbolen. Overal waar je binnen StepBridge Markdown kan gebruiken, kan je ook de kaartsymbolen gebruiken.
| Code | Symbool | Betekenis |
|---|---|---|
#S | ♠ | Schoppen |
#H | ♥ | Harten |
#R of #D | ♦ | Ruiten |
#K of #C | ♣ | Klaveren |
Voorbeeld:
De speler speelde #H7 in plaats van #SA.
Resultaat: De speler speelde ♥7 in plaats van ♠A.
Koppen
Gebruik hekjes # voor koppen. Hoe meer hekjes, hoe kleiner de kop.
# Kop niveau 1
## Kop niveau 2
### Kop niveau 3
Vet en cursief
**vetgedrukte tekst**
*cursieve tekst*
***vetgedrukt en cursief***
Resultaat:
- vetgedrukte tekst
- cursieve tekst
- vetgedrukt en cursief
Opsommingen
Ongenummerde lijst:
- Eerste item
- Tweede item
- Derde item
Genummerde lijst:
1. Eerste stap
2. Tweede stap
3. Derde stap
Links
[klikbare tekst](https://www.stepbridge.nl)
Resultaat: klikbare tekst
Link in nieuw tabblad openen:
Standaard opent een link in hetzelfde venster. Wil je dat de link in een nieuw tabblad opent, voeg dan {:target="_blank"} toe achter de link:
[klikbare tekst](https://www.stepbridge.nl){:target="_blank"}
Citaten
Gebruik > voor een citaat of opvallende tekst:
> Dit is een belangrijk bericht dat opvalt in de tekst.
Dit is een belangrijk bericht dat opvalt in de tekst.
Codeblokken
Gebruik drie backticks (```) om een codeblok te maken. Tekst in een codeblok wordt weergegeven in een lettertype met vaste tekenbreedte, wat handig is voor het tonen van logs of andere technische informatie:
```
12:34:56 Speler1> Hoi
12:34:58 Speler2> Psa
```
Resultaat:
12:34:56 Speler1> Hoi
12:34:58 Speler2> Psa
Tips
Tips voor goed leesbare berichten:
- Gebruik witregels: een lege regel tussen alinea's maakt de tekst overzichtelijker.
- Wees spaarzaam met opmaak: te veel vetgedrukte tekst of koppen maakt het juist onoverzichtelijk.
- Controleer de voorvertoning: gebruik altijd de voorvertoningstab om te zien hoe je bericht eruitziet.
Samenvatting
| Wat je wilt | Wat je typt |
|---|---|
| Vetgedrukt | **tekst** |
| Cursief | *tekst* |
| Kop | ## Koptekst |
| Link | [tekst](url) |
| Opsomming | - item |
| Citaat | > tekst |
| Schoppen | #S |
| Harten | #H |
| Ruiten | #R |
| Klaveren | #K |
Handige links
- Markdown Guide - Basic Syntax - uitgebreid overzicht van alle mogelijkheden
- Tables Generator - handige tool om Markdown tabellen te maken
- StackEdit - online wysiwyg Markdown editor
- Awesome Markdown Editors - overzicht van Markdown editors