Markdown-cheetseat
Markdown is een set conventies voor het schrijven van opgemaakte tekst in een plein bestand, en het aantrekkingspunt ervan is dat de bron leesbaar blijft, zelfs als niets het weergeeft. De onderstaande syntaxis is gegroepeerd op wat je probeert te doen, en elke rij toont de HTML die het daadwerkelijk produceert.
Deze HTML-fragmenten zijn niet handmatig getypt. Elk ervan is de echte uitvoer van de Markdown-converter van deze site, vergeleken met de tabel door de testsuite op elke build — dus als een rij en het gereedschap het niet eens waren, zou de build mislukken in plaats van de pagina je misleiden.
De dialect is CommonMark plus de GitHub-extensies die bijna universeel zijn: tabellen, takenlijsten en doorhaling. Voetnoten, definitielijsten en richtlijnen ontbreken opzettelijk, omdat het documenteren van een syntaxis die vervolgens niets in de convertor één klik verderop doet, erger is dan het weglaten.
Nadruk en inlinecode
9Inlinesyntaxis werkt in alinea's, koppen, lijstitems en tabelcellen.
| Syntaxis | Wat het doet | Geproduceerde HTML |
|---|---|---|
| *italic* | Cursief | <p><em>italic</em></p> |
| _italic_ | Cursief, alternatiefdvormGenegeerd binnen een woord, dus snake_case overleeft. | <p><em>italic</em></p> |
| **bold** | Vet | <p><strong>bold</strong></p> |
| __bold__ | Vet, alternatiefdvorm | <p><strong>bold</strong></p> |
| ***both*** | Vet en cursief samen | <p><em><strong>both</strong></em></p> |
| ~~gone~~ | Doorhaling | <p><del>gone</del></p> |
| `code` | Inlinecode — niets erin wordt geïnterpreteerd | <p><code>code</code></p> |
| ``a ` b`` | Inlinecode met een backtickGebruik meer backticks buiten dan verschijnen binnenin. | <p><code>a ` b</code></p> |
| \*not italic\* | Een letterlijk sterretje in plaats van nadruk | <p>*not italic*</p> |
Koppelingen
7Het hash-formulier is degene die moet worden gebruikt; het onderstreepingsformulier bereikt alleen twee niveaus.
| Syntaxis | Wat het doet | Geproduceerde HTML |
|---|---|---|
| # Heading | Kopje niveau 1 | <h1>Heading</h1> |
| ## Heading | Kopje niveau 2 | <h2>Heading</h2> |
| ### Heading | Kopje niveau 3 | <h3>Heading</h3> |
| ###### Heading | Kopje niveau 6 — het diepste dat er is | <h6>Heading</h6> |
| Heading ======= | Kopje niveau 1, onderstreepte vorm | <h1>Heading</h1> |
| Heading ------- | Kopje niveau 2, onderstreepte vorm | <h2>Heading</h2> |
| ## Heading ## | Achtervolgende hashes zijn decoratie en worden verwijderdHet aantal aan de rechterkant wordt genegeerd; alleen het linkerkant stelt het niveau in. | <h2>Heading</h2> |
Lijsten
7Inspringen met twee spaties om in te nesten. Een lege regel tussen items maakt elk ervan een alinea.
| Syntaxis | Wat het doet | Geproduceerde HTML |
|---|---|---|
| - one - two | Opsommingslijst | <ul> <li>one</li> <li>two</li> </ul> |
| * one * two | Opsommingslijst, alternatieve markering | <ul> <li>one</li> <li>two</li> </ul> |
| 1. one 2. two | Genummerde lijst | <ol> <li>one</li> <li>two</li> </ol> |
| 1. one 1. two | Ook een genummerde lijst, opnieuw nummering op renderAlleen het eerste getal wordt gebruikt; de rest kan alles 1 zijn. | <ol> <li>one</li> <li>two</li> </ol> |
| - one - nested | Geneste lijst — inspringen het kind met twee spaties | <ul> <li>one <ul> <li>nested</li> </ul></li> </ul> |
| - [ ] todo | Ongeselecteerde takenlijstitem | <ul> <li><input type="checkbox" disabled /> todo</li> </ul> |
| - [x] done | Geselecteerde takenlijstitem | <ul> <li><input type="checkbox" checked disabled /> done</li> </ul> |
Koppelingen en afbeeldingen
6| Syntaxis | Wat het doet | Geproduceerde HTML |
|---|---|---|
| [text](https://a.co) | Koppeling | <p><a href="https://a.co">text</a></p> |
| [text](https://a.co "Tip") | Koppeling met een tooltiptitel | <p><a href="https://a.co" title="Tip">text</a></p> |
| <https://a.co> | Blote URL omgezet in een koppeling | <p><a href="https://a.co">https://a.co</a></p> |
| [mail](mailto:[email protected]) | E-mailkoppeling | <p><a href="mailto:[email protected]">mail</a></p> |
|  | Afbeelding, met alt-tekst | <p><img src="cat.png" alt="alt" /></p> |
| [x](javascript:alert(1)) | Onveilig schema — de koppeling wordt verwijderd, de tekst blijftjavascript:, data: en vbscript: URL's verliezen hun href. | <p>x</p> |
Blokelementen
9Elk ervan moet aan het begin van een regel beginnen.
| Syntaxis | Wat het doet | Geproduceerde HTML |
|---|---|---|
| > quoted | Blockquote | <blockquote> <p>quoted</p> </blockquote> |
| > > deeper | Geneste blockquote | <blockquote> <blockquote> <p>deeper</p> </blockquote> </blockquote> |
| ``` code ``` | Omheinde codeblok | <pre><code>code </code></pre> |
| ```js let a = 1; ``` | Omheinde codeblok met een taalklasse voor markering | <pre><code class="language-js">let a = 1; </code></pre> |
| code | Codeblok door vier-spatie-inspring | <pre><code>code </code></pre> |
| --- | Horizontale regel | <hr /> |
| *** | Horizontale regel, alternatiefdvorm | <hr /> |
| one two | Regelafbreking in een alineaTwee sleepspaties. Onzichtbaar in de meeste editors, daarom faalt het zo vaak. | <p>one<br /> two</p> |
| one two | Een lege regel scheidt alinea's | <p>one</p> <p>two</p> |
Tabellen
4De scheidingsrij is wat het een tabel maakt. Uitlijning wordt ingesteld door dubbele punten in die rij.
| Syntaxis | Wat het doet | Geproduceerde HTML |
|---|---|---|
| | a | b | | - | - | | 1 | 2 | | Tabel — kop, scheidingsrij, vervolgens lichaamrijen | |
| | :--- | | De kolom links uitlijnen, in de scheidingsrij | |
| | :---: | | Centre de kolom | |
| | ---: | | De kolom rechts uitlijnen |