Markdown-snabbreferens
Markdown är en uppsättning konventioner för att skriva formaterad text i en vanlig fil, och dess styrka är att källan förblir läsbar även när ingenting renderar den. Syntaxen nedan är grupperad efter vad du försöker göra, och varje rad visar den HTML den faktiskt producerar.
De HTML-fragmenten är inte handskrivna. Var och en är den faktiska utdata från denna webbplats egen Markdown-konverterare, jämförd med tabellen av testsviten vid varje build — så om en rad och verktyget någonsin var oense, skulle bygget misslyckas i stället för att sidan vilseledde dig.
Dialekten är CommonMark plus de GitHub-tillägg som är nära universella: tabeller, uppgiftslistor och genomstrykning. Fotnoter, definitionslistor och direktiv är medvetet frånvarande, för att dokumentera en syntax som sedan inte gör något i konverteraren ett klick bort är värre än att utelämna det.
Betoning och inlinekod
9Inlinesyntax fungerar inuti paragrafer, rubriker, listitems och tabellceller.
| Syntax | Vad det gör | HTML producerad |
|---|---|---|
| *italic* | Kursiv | <p><em>italic</em></p> |
| _italic_ | Kursiv, alternativ formIgnorerad inuti ett ord, så snake_case överlever. | <p><em>italic</em></p> |
| **bold** | Fetstil | <p><strong>bold</strong></p> |
| __bold__ | Fetstil, alternativ form | <p><strong>bold</strong></p> |
| ***both*** | Fetstil och kursiv tillsammans | <p><em><strong>both</strong></em></p> |
| ~~gone~~ | Genomstrykning | <p><del>gone</del></p> |
| `code` | Inlinekod — ingenting inuti tolkas | <p><code>code</code></p> |
| ``a ` b`` | Inlinekod som innehåller ett backtickAnvänd fler backticks utanför än visas inuti. | <p><code>a ` b</code></p> |
| \*not italic\* | En bokstavlig asterisk istället för betoning | <p>*not italic*</p> |
Rubriker
7Hash-formen är den som ska användas; underline-formen når bara två nivåer.
| Syntax | Vad det gör | HTML producerad |
|---|---|---|
| # Heading | Nivå 1-rubrik | <h1>Heading</h1> |
| ## Heading | Nivå 2-rubrik | <h2>Heading</h2> |
| ### Heading | Nivå 3-rubrik | <h3>Heading</h3> |
| ###### Heading | Nivå 6-rubrik — det djupaste som finns | <h6>Heading</h6> |
| Heading ======= | Nivå 1-rubrik, underline-form | <h1>Heading</h1> |
| Heading ------- | Nivå 2-rubrik, underline-form | <h2>Heading</h2> |
| ## Heading ## | Efterföljande hashar är dekoration och tas bortRäkningen på höger ignoreras; bara den vänstra anger nivån. | <h2>Heading</h2> |
Listor
7Indrag två mellanslag för att kapsla. En tom rad mellan objekt gör vart och ett till en paragraf.
| Syntax | Vad det gör | HTML producerad |
|---|---|---|
| - one - two | Punktlista | <ul> <li>one</li> <li>two</li> </ul> |
| * one * two | Punktlista, alternativ markör | <ul> <li>one</li> <li>two</li> </ul> |
| 1. one 2. two | Numrerad lista | <ol> <li>one</li> <li>two</li> </ol> |
| 1. one 1. two | Även en numrerad lista, omnumrerad vid renderingBara det första numret används; resten kan alla vara 1. | <ol> <li>one</li> <li>two</li> </ol> |
| - one - nested | Kapslad lista — indrag barnet två mellanslag | <ul> <li>one <ul> <li>nested</li> </ul></li> </ul> |
| - [ ] todo | Omarkerad uppgiftslistobjekt | <ul> <li><input type="checkbox" disabled /> todo</li> </ul> |
| - [x] done | Markerad uppgiftslistobjekt | <ul> <li><input type="checkbox" checked disabled /> done</li> </ul> |
Länkar och bilder
6| Syntax | Vad det gör | HTML producerad |
|---|---|---|
| [text](https://a.co) | Länk | <p><a href="https://a.co">text</a></p> |
| [text](https://a.co "Tip") | Länka med en tooltip-titel | <p><a href="https://a.co" title="Tip">text</a></p> |
| <https://a.co> | Barögnad URL omvandlad till en länk | <p><a href="https://a.co">https://a.co</a></p> |
| [mail](mailto:a@b.co) | E-postlänk | <p><a href="mailto:a@b.co">mail</a></p> |
|  | Bild, med alt-text | <p><img src="cat.png" alt="alt" /></p> |
| [x](javascript:alert(1)) | Osäker schema — länken tas bort, texten stannarjavascript:, data: och vbscript: URL förlorar sin href. | <p>x</p> |
Blockelement
9Var och en av dessa måste börja i början av en rad.
| Syntax | Vad det gör | HTML producerad |
|---|---|---|
| > quoted | Blockquote | <blockquote> <p>quoted</p> </blockquote> |
| > > deeper | Kapslad blockquote | <blockquote> <blockquote> <p>deeper</p> </blockquote> </blockquote> |
| ``` code ``` | Fenced code block | <pre><code>code </code></pre> |
| ```js let a = 1; ``` | Fenced code block med en språkklass för markering | <pre><code class="language-js">let a = 1; </code></pre> |
| code | Kodblock med fyra mellanslag-indrag | <pre><code>code </code></pre> |
| --- | Horisontell regel | <hr /> |
| *** | Horisontell regel, alternativ form | <hr /> |
| one two | Radslut inuti en paragrafTvå efterföljande mellanslag. Osynlig i de flesta redigerare, vilket är varför det så ofta misslyckas. | <p>one<br /> two</p> |
| one two | En tom rad skiljer paragrafer | <p>one</p> <p>two</p> |
Tabeller
4Avgränsningsraden är det som gör det till en tabell. Justering ställs in av koloner i den raden.
| Syntax | Vad det gör | HTML producerad |
|---|---|---|
| | a | b | | - | - | | 1 | 2 | | Tabell — rubrik, avgränsningsrad, sedan brödtextraderna | |
| | :--- | | Vänsterjustera kolumnen, i avgränsningsraden | |
| | :---: | | Centrera kolumnen | |
| | ---: | | Högerjustera kolumnen |