Markdown segédlet
A Markdown egy sor konvenció formázott szöveg írásához egyszerű szöveges fájlba, és vonzereje abban rejlik, hogy a forrás akkor is olvasható marad, ha semmi sem rendereli. Az alábbi szintaxis csoportosítva van az alapján, hogy mit próbálsz tenni, és minden sor mutatja az HTML-t, amit ténylegesen kitölt.
Ezek a HTML-fragmentumok nincsenek kézzel begépelve. Minden egyes a webhely saját Markdown konvertere valódi kimenete, a tesztcsomag által összevetítve a táblázattal az egyes fordítások során — így ha egy sor és az eszköz valaha eltérne, az összeállítás kudarcot vallana, ahelyett hogy félrevezethesse az oldalt.
Az nyelvjárás a CommonMark plusz a szinte univerzális GitHub kiterjesztések: táblázatok, feladatlisták és áthúzás. A lábjegyzetek, definíciós listák és direktívák szándékosan hiányoznak, mivel egy szintaxis dokumentálása, amely majd nem csinál semmit az egy kattintásra eltávolított konvertorban, rosszabb, mint elhagyni.
Kiemelés és beépített kód
9Beépített szintaxis az bekezdéseken, fejléceken, listaelemeken és táblázatcellákon belül működik.
| Szintaxis | Amit csinál | HTML kitöltve |
|---|---|---|
| *italic* | Dőlt | <p><em>italic</em></p> |
| _italic_ | Dőlt, alternatív formaFigyelmen kívül hagyva az egy szó belsejében, így a snake_case túléli. | <p><em>italic</em></p> |
| **bold** | Félkövér | <p><strong>bold</strong></p> |
| __bold__ | Félkövér, alternatív forma | <p><strong>bold</strong></p> |
| ***both*** | Félkövér és dőlt együtt | <p><em><strong>both</strong></em></p> |
| ~~gone~~ | Áthúzás | <p><del>gone</del></p> |
| `code` | Beépített kód — a belseje nem értelmeződik | <p><code>code</code></p> |
| ``a ` b`` | Beépített kód, amely egy backtick-t tartalmazHasználjon több backtick-et kívülről, mint belülről jelennek meg. | <p><code>a ` b</code></p> |
| \*not italic\* | Literális asteriszk a kiemelés helyett | <p>*not italic*</p> |
Fejlécek
7A hash forma az, amely használatos; az aláhúzás forma csak két szintet ér el.
| Szintaxis | Amit csinál | HTML kitöltve |
|---|---|---|
| # Heading | 1. szintű fejléc | <h1>Heading</h1> |
| ## Heading | 2. szintű fejléc | <h2>Heading</h2> |
| ### Heading | 3. szintű fejléc | <h3>Heading</h3> |
| ###### Heading | 6. szintű fejléc — a legmélyebb van | <h6>Heading</h6> |
| Heading ======= | 1. szintű fejléc, aláhúzás forma | <h1>Heading</h1> |
| Heading ------- | 2. szintű fejléc, aláhúzás forma | <h2>Heading</h2> |
| ## Heading ## | A záró ketések díszek és eldobódnakA jobb fél száma figyelmen kívül hagyódik; csak a bal szint szorozódik a szintet. | <h2>Heading</h2> |
Listák
7Két szóközzel behúzva, hogy beágyazódjon. Egy üres sor az elemek között minden egyet egy bekezdésbe tesz.
| Szintaxis | Amit csinál | HTML kitöltve |
|---|---|---|
| - one - two | Felsorolás lista | <ul> <li>one</li> <li>two</li> </ul> |
| * one * two | Felsorolás lista, alternatív jelölő | <ul> <li>one</li> <li>two</li> </ul> |
| 1. one 2. two | Számozott lista | <ol> <li>one</li> <li>two</li> </ol> |
| 1. one 1. two | Ugyancsak egy számozott lista, átsorszámozva a renderelésreCsak az első szám használódik; a többi minden 1 lehet. | <ol> <li>one</li> <li>two</li> </ol> |
| - one - nested | Beágyazott lista — a gyermek által két szóközzel behúzva | <ul> <li>one <ul> <li>nested</li> </ul></li> </ul> |
| - [ ] todo | Be nem jelölt feladatlista elem | <ul> <li><input type="checkbox" disabled /> todo</li> </ul> |
| - [x] done | Bejelölt feladatlista elem | <ul> <li><input type="checkbox" checked disabled /> done</li> </ul> |
Linkek és képek
6| Szintaxis | Amit csinál | HTML kitöltve |
|---|---|---|
| [text](https://a.co) | Link | <p><a href="https://a.co">text</a></p> |
| [text](https://a.co "Tip") | Link egy tipp címével | <p><a href="https://a.co" title="Tip">text</a></p> |
| <https://a.co> | Meztelen URL egy linkké alakítva | <p><a href="https://a.co">https://a.co</a></p> |
| [mail](mailto:a@b.co) | Email link | <p><a href="mailto:a@b.co">mail</a></p> |
|  | Kép, alt szöveggel | <p><img src="cat.png" alt="alt" /></p> |
| [x](javascript:alert(1)) | Nem biztonságos séma — a link le van dobva, a szöveg maradjavascript:, data: és vbscript: URL-ek elveszítik azok href-et. | <p>x</p> |
Blokkos elemek
9Ezek közül mindegyiknek egy sor elején kell kezdődnie.
| Szintaxis | Amit csinál | HTML kitöltve |
|---|---|---|
| > quoted | Idézetek | <blockquote> <p>quoted</p> </blockquote> |
| > > deeper | Beágyazott idézet | <blockquote> <blockquote> <p>deeper</p> </blockquote> </blockquote> |
| ``` code ``` | Fenced kódblokk | <pre><code>code </code></pre> |
| ```js let a = 1; ``` | Fenced kódblokk egy nyelvű jelöléssel a kiemeléséhez | <pre><code class="language-js">let a = 1; </code></pre> |
| code | Kódblokk négy szóköz behúzásával | <pre><code>code </code></pre> |
| --- | Vízszintes szabály | <hr /> |
| *** | Vízszintes szabály, alternatív forma | <hr /> |
| one two | Sortörés egy bekezdésen belülKét záró szóköz. Láthatatlan a legtöbb szerkesztőben, amely így gyakran kudarcot vall. | <p>one<br /> two</p> |
| one two | Egy üres sor elkülöníti a bekezdéseket | <p>one</p> <p>two</p> |
Táblázatok
4Az elválasztó sor az, amely táblázattá teszi. Az igazítás az adott sor kettőpontja által van beállítva.
| Szintaxis | Amit csinál | HTML kitöltve |
|---|---|---|
| | a | b | | - | - | | 1 | 2 | | Táblázat — fejléc, elválasztó sor, majd testsorok | |
| | :--- | | Balra igazítsa az oszlopot az elválasztó sorban | |
| | :---: | | Középre az oszlop | |
| | ---: | | Jobbra igazítsa az oszlopot |