Navodilo za Markdown
Markdown je niz dogovorov za pisanje oblikovanega besedila v navadno datoteko, njegova privlačnost pa je v tem, da ostane vir berljiv tudi, ko ga nič ne upodobi. Spodnja sintaksa je razvrščena po tem, kaj poskušaš storiti, vsaka vrstica pa kaže HTML, ki ga dejansko proizvede.
Ti HTML fragmenti niso vtipkani ročno. Vsak je resnični rezultat lastnega Markdown pretvornika te spletne strani, primerjav s tabelo z testnim naborom pri vsakem graditvi — tako da če bi se vrstica in orodje kadarkoli ne strinjata, bi graditev padla, namesto da bi vas stran zavajala.
Dialekt je CommonMark plus razširitve GitHub, ki so blizu univerzalne: tabele, seznami opravil in prečrtano besedilo. Opombe, seznami definicij in direktive so namerno odsotni, ker dokumentiranje sintakse, ki potem v pretvorniku eno klik stran ne naredi ničesar, je slabše kot jo izpustiti.
Poudarek in vstavljena koda
9Vstavljena sintaksa deluje v odstavkih, naslovih, postavkah seznama in celicah tabele.
| Sintaksa | Kaj naredi | Ustvarjeni HTML |
|---|---|---|
| *italic* | Kursiva | <p><em>italic</em></p> |
| _italic_ | Kursiva, alternativna oblikaIgnorirano znotraj besede, zato snake_case preživi. | <p><em>italic</em></p> |
| **bold** | Krepko | <p><strong>bold</strong></p> |
| __bold__ | Krepko, alternativna oblika | <p><strong>bold</strong></p> |
| ***both*** | Krepko in kursiva skupaj | <p><em><strong>both</strong></em></p> |
| ~~gone~~ | Prečrtano | <p><del>gone</del></p> |
| `code` | Vstavljena koda — nič v notranjosti ni interpretirano | <p><code>code</code></p> |
| ``a ` b`` | Vstavljena koda, ki vsebuje povratnicoUporabi več povratnic zunaj kot se pojavljajo znotraj. | <p><code>a ` b</code></p> |
| \*not italic\* | Dobesedna zvezdica namesto poudarka | <p>*not italic*</p> |
Naslovi
7Oblika haša je tista, ki jo je treba uporabiti; podčrtana oblika dosega le dve ravni.
| Sintaksa | Kaj naredi | Ustvarjeni HTML |
|---|---|---|
| # Heading | Naslov ravni 1 | <h1>Heading</h1> |
| ## Heading | Naslov ravni 2 | <h2>Heading</h2> |
| ### Heading | Naslov ravni 3 | <h3>Heading</h3> |
| ###### Heading | Naslov ravni 6 — najgloblja, ki obstaja | <h6>Heading</h6> |
| Heading ======= | Naslov ravni 1, podčrtana oblika | <h1>Heading</h1> |
| Heading ------- | Naslov ravni 2, podčrtana oblika | <h2>Heading</h2> |
| ## Heading ## | Zadnje haše so okras in so spuščeneŠtetje na desni se ignorira; samo levo nastavlja raven. | <h2>Heading</h2> |
Seznami
7Zamakni za dva presledka, da ugniezdis. Prazna vrstica med postavkami naredi vsako kot odstavek.
| Sintaksa | Kaj naredi | Ustvarjeni HTML |
|---|---|---|
| - one - two | Seznam s točkami | <ul> <li>one</li> <li>two</li> </ul> |
| * one * two | Seznam s točkami, alternativni marker | <ul> <li>one</li> <li>two</li> </ul> |
| 1. one 2. two | Oštevilčeni seznam | <ol> <li>one</li> <li>two</li> </ol> |
| 1. one 1. two | Tudi oštevilčeni seznam, preoštevilčeno ob upodobitviSamo prvo število se uporablja; ostali so lahko vsi 1. | <ol> <li>one</li> <li>two</li> </ol> |
| - one - nested | Ugniezdeni seznam — zamakni otroka za dva presledka | <ul> <li>one <ul> <li>nested</li> </ul></li> </ul> |
| - [ ] todo | Nezaznamenana postavka seznama opravil | <ul> <li><input type="checkbox" disabled /> todo</li> </ul> |
| - [x] done | Zaznamenana postavka seznama opravil | <ul> <li><input type="checkbox" checked disabled /> done</li> </ul> |
Povezave in slike
6| Sintaksa | Kaj naredi | Ustvarjeni HTML |
|---|---|---|
| [text](https://a.co) | Povezava | <p><a href="https://a.co">text</a></p> |
| [text](https://a.co "Tip") | Povezava z naslovom s podpovezano | <p><a href="https://a.co" title="Tip">text</a></p> |
| <https://a.co> | Goli URL spremenjen v povezavo | <p><a href="https://a.co">https://a.co</a></p> |
| [mail](mailto:a@b.co) | Povezava e-pošte | <p><a href="mailto:a@b.co">mail</a></p> |
|  | Slika, z besedilom nadomestka | <p><img src="cat.png" alt="alt" /></p> |
| [x](javascript:alert(1)) | Nevarna shema — povezava je spuščena, besedilo ostanejavascript:, data: in vbscript: URL-ji izgubijo svoj href. | <p>x</p> |
Blokavni elementi
9Vsak od teh se mora začeti na začetku vrstice.
| Sintaksa | Kaj naredi | Ustvarjeni HTML |
|---|---|---|
| > quoted | Navedek | <blockquote> <p>quoted</p> </blockquote> |
| > > deeper | Ugniezdeni navedek | <blockquote> <blockquote> <p>deeper</p> </blockquote> </blockquote> |
| ``` code ``` | Ograjeni kodni blok | <pre><code>code </code></pre> |
| ```js let a = 1; ``` | Ograjeni kodni blok z razredom jezika za poudarjanje | <pre><code class="language-js">let a = 1; </code></pre> |
| code | Kodni blok z štiri presledki zamikov | <pre><code>code </code></pre> |
| --- | Vodoravna črta | <hr /> |
| *** | Vodoravna črta, alternativna oblika | <hr /> |
| one two | Prelom vrstice znotraj odstavkaDva zadnja presledka. Nevidno v večini urejevalnikov, zato tako pogosto ne uspe. | <p>one<br /> two</p> |
| one two | Prazna vrstica ločuje odstavke | <p>one</p> <p>two</p> |
Tabele
4Vrstica ločilnika je tista, ki jo naredi tabelo. Poravnava je nastavljena z dvopičji v tej vrstici.
| Sintaksa | Kaj naredi | Ustvarjeni HTML |
|---|---|---|
| | a | b | | - | - | | 1 | 2 | | Tabela — naslov, vrstica ločilnika, nato vrstice telesa | |
| | :--- | | Poravnaj levo stolpec v vrstici ločilnika | |
| | :---: | | Poravnaj na sredino stolpec | |
| | ---: | | Poravnaj desno stolpec |