Preskočiť na obsah

Markdown ťahák

Markdown je sada dohôd, ako písať formátovaný text v obyčajnom súbore, a jeho čaro je v tom, že zdroj zostáva čitateľný aj vtedy, keď ho nič nevykreslí. Syntax nižšie je zoradená podľa toho, čo chcete dosiahnuť, a každý riadok ukazuje HTML, ktoré z nej naozaj vznikne.

Tie HTML úryvky nie sú napísané ručne. Každý je skutočný výstup konvertora na tejto stránke a testy ich pri každom builde porovnávajú s tabuľkou — keby si riadok a nástroj prestali odpovedať, build padne namiesto toho, aby vás stránka zavádzala.

Dialekt je CommonMark plus tie rozšírenia GitHubu, ktoré sú dnes bežné: tabuľky, zaškrtávacie zoznamy a preškrtnutie. Poznámky pod čiarou a definičné zoznamy tu zámerne nie sú — dokumentovať syntax, ktorá potom v nástroji o jedno kliknutie vedľa nič neurobí, je horšie než ju vynechať.

Zvýraznenie a inline kód

9

Inline syntax funguje rovnako v odsekoch, nadpisoch, položkách zoznamu aj v bunkách tabuľky.

SyntaxČo robíVzniknuté HTML
*italic*Kurzíva<p><em>italic</em></p>
_italic_Kurzíva, alternatívna podobaVnútri slova sa ignoruje, takže snake_case prežije.<p><em>italic</em></p>
**bold**Tučné<p><strong>bold</strong></p>
__bold__Tučné, alternatívna podoba<p><strong>bold</strong></p>
***both***Tučné a kurzíva naraz<p><em><strong>both</strong></em></p>
~~gone~~Preškrtnuté<p><del>gone</del></p>
`code`Inline kód — nič vnútri sa neinterpretuje<p><code>code</code></p>
``a ` b``Inline kód obsahujúci spätný apostrofZvonku použite viac apostrofov než je vnútri.<p><code>a ` b</code></p>
\*not italic\*Doslovná hviezdička namiesto zvýraznenia<p>*not italic*</p>

Nadpisy

7

Používajte podobu s mriežkami; podčiarknutá siaha len na dve úrovne.

SyntaxČo robíVzniknuté HTML
# HeadingNadpis 1. úrovne<h1>Heading</h1>
## HeadingNadpis 2. úrovne<h2>Heading</h2>
### HeadingNadpis 3. úrovne<h3>Heading</h3>
###### HeadingNadpis 6. úrovne — najhlbší, aký existuje<h6>Heading</h6>
Heading =======Nadpis 1. úrovne, podčiarknutá podoba<h1>Heading</h1>
Heading -------Nadpis 2. úrovne, podčiarknutá podoba<h2>Heading</h2>
## Heading ##Mriežky na konci sú ozdoba a zahodia saIch počet vpravo sa ignoruje; úroveň určuje len počet vľavo.<h2>Heading</h2>

Zoznamy

7

Vnorenie sa robí odsadením o dve medzery. Prázdny riadok medzi položkami z každej urobí odsek.

SyntaxČo robíVzniknuté HTML
- one - twoZoznam s odrážkami<ul> <li>one</li> <li>two</li> </ul>
* one * twoZoznam s odrážkami, alternatívna značka<ul> <li>one</li> <li>two</li> </ul>
1. one 2. twoČíslovaný zoznam<ol> <li>one</li> <li>two</li> </ol>
1. one 1. twoTiež číslovaný zoznam, prečísluje sa pri vykresleníPoužije sa len prvé číslo; ostatné môžu byť všetky 1.<ol> <li>one</li> <li>two</li> </ol>
- one - nestedVnorený zoznam — potomka odsaďte o dve medzery<ul> <li>one <ul> <li>nested</li> </ul></li> </ul>
- [ ] todoNezaškrtnutá položka zoznamu úloh<ul> <li><input type="checkbox" disabled /> todo</li> </ul>
- [x] doneZaškrtnutá položka zoznamu úloh<ul> <li><input type="checkbox" checked disabled /> done</li> </ul>
6
SyntaxČo robíVzniknuté HTML
[text](https://a.co)Odkaz<p><a href="https://a.co">text</a></p>
[text](https://a.co "Tip")Odkaz s bublinovým popisom<p><a href="https://a.co" title="Tip">text</a></p>
<https://a.co>Samotná URL zmenená na odkaz<p><a href="https://a.co">https://a.co</a></p>
[mail](mailto:a@b.co)Odkaz na e-mail<p><a href="mailto:a@b.co">mail</a></p>
![alt](cat.png)Obrázok s alternatívnym textom<p><img src="cat.png" alt="alt" /></p>
[x](javascript:alert(1))Nebezpečná schéma — odkaz sa zahodí, text zostaneURL javascript:, data: a vbscript: prídu o href.<p>x</p>

Blokové prvky

9

Každý z nich musí začínať na začiatku riadku.

SyntaxČo robíVzniknuté HTML
> quotedCitovaný blok<blockquote> <p>quoted</p> </blockquote>
> > deeperVnorený citovaný blok<blockquote> <blockquote> <p>deeper</p> </blockquote> </blockquote>
``` code ```Blok kódu ohradený apostrofmi<pre><code>code </code></pre>
```js let a = 1; ```Blok kódu s triedou jazyka pre zvýrazňovanie<pre><code class="language-js">let a = 1; </code></pre>
codeBlok kódu odsadením o štyri medzery<pre><code>code </code></pre>
---Vodorovná linka<hr />
***Vodorovná linka, alternatívna podoba<hr />
one twoZlom riadku vnútri odsekuDve medzery na konci. Vo väčšine editorov neviditeľné, preto to tak často nevyjde.<p>one<br /> two</p>
one twoPrázdny riadok oddeľuje odseky<p>one</p> <p>two</p>

Tabuľky

4

Tabuľku robí tabuľkou oddeľovací riadok. Zarovnanie určujú dvojbodky v ňom.

SyntaxČo robíVzniknuté HTML
| a | b | | - | - | | 1 | 2 |Tabuľka — hlavička, oddeľovací riadok, potom telo
| :--- |Zarovnanie stĺpca vľavo, v oddeľovacom riadku
| :---: |Zarovnanie stĺpca na stred
| ---: |Zarovnanie stĺpca vpravo

Časté otázky

Aký je rozdiel medzi * a _ pri zvýraznení?
Pri bežnom použití žiadny — oboje dá kurzívu a zdvojené oboje dá tučné. Rozdiel sa ukáže vnútri slova: snake_case_name zostane nedotknuté, pretože podčiarkovníky medzi znakmi slova sa za zvýraznenie nepovažujú, kým hviezdičky by ho rozbili. Preto je v technickom písaní bezpečnejším zvykom hviezdička.
Ako zapíšem zlom riadku bez nového odseku?
Ukončite riadok dvoma medzerami, z čoho vznikne <br />. Prázdny riadok naopak začne nový odsek. Pravidlo dvoch medzier je vo väčšine editorov neviditeľné a je najčastejším dôvodom, prečo sa zlom riadku v Markdowne neobjaví.
Ako zobrazím doslovnú hviezdičku alebo podčiarkovník?
Dajte pred ňu opačnú lomku: \*bez kurzívy\*. Vnútri spätných apostrofov netreba escapovať nič, čo je zvyčajne lepšia odpoveď, ak je ten text kód.
Potrebujú tabuľky v Markdowne vonkajšie zvislé čiary?
Nie — úvodná a koncová zvislá čiara sú voliteľné a zarovnávať stĺpce v zdroji tiež netreba. Povinný je oddeľovací riadok pomlčiek pod hlavičkou; bez neho je z bloku odsek so zvislými čiarami.
Nahráva sa niekam to, čo vložím do konvertora?
Nie. Každý nástroj na tejto stránke beží vo vašom prehliadači a táto stránka nemá vôbec žiadne skripty — je to statická tabuľka. Nič, čo napíšete, sa nikam neposiela a niet ani servera, ktorý by to prijal.