Přehled syntaxe GitHub Markdownu
Zjistěte, co je Markdown, a projděte si hlavní syntaxi podle GitHub Flavored Markdown pro hostování blogu na GitHub Pages.
Pro využití GitHub Pages je potřeba znát syntaxi markdownu. Text byl napsán s odkazem na oficiální dokumentaci GitHubu: Mastering Markdown a Basic writing and formatting syntax.
1. Co je Markdown
Markdown (markdown) je lehký značkovací jazyk založený na prostém textu. Používá se k psaní formátovaných dokumentů v obyčejném textu a oproti běžným značkovacím jazykům se vyznačuje jednoduchou a stručnou syntaxí. Protože jej lze snadno převést do formátovaných dokumentů, jako jsou HTML či RTF (Rich Text Format), často se používá v souborech README distribuovaných spolu s aplikačním softwarem nebo v online příspěvcích.
John Gruber v roce 12004 holocénního kalendáře vytvořil jazyk Markdown prostřednictvím zásadní spolupráce s Aaronem Swartzem na jeho syntaxi; cílem je, aby lidé mohli psát ve snadno čitelném a snadno zapisovatelném formátu prostého textu, který je možné volitelně převést do strukturálně validního XHTML (nebo HTML).
2. Syntaxe Markdownu
Markdown nemá pevně daný standard, takže se detailní syntaxe může podle použití mírně lišit. Zde shrnutá syntaxe vychází z GitHub Flavored Markdown.
2.1. Zalomení řádku, oddělení odstavců
V Markdownu se jedno stisknutí Enteru nebere jako zalomení řádku.
1
2
3
První věta.
Druhá věta.
Třetí věta.
První věta. Druhá věta. Třetí věta.
Zalomení řádku se použije, pokud zadáte alespoň dvě mezery za sebou.
1
2
3
První věta.
Druhá věta.
Třetí věta.
První věta.
Druhá věta.
Třetí věta.
Odstavce se oddělují prázdným řádkem (dvakrát Enter).
1
2
3
Jeden odstavec.
Jiný odstavec.
Jeden odstavec.
Jiný odstavec.
2.2. Nadpisy (Headers)
Existuje celkem 6 úrovní.
1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
Protože by tag H1 měl být v zásadě na jedné stránce jen jednou, při psaní postů nebo dokumentů jej obvykle není potřeba zadávat ručně.
2.3. Zvýraznění
1
2
3
4
5
6
7
8
9
10
11
*This text is italicized*
_This is italicized too_
**This is bold text**
__This is bold text too__
~~This was mistaken text~~
_You **can** combine them_
***All this text is important***
This text is italicized
This is italicized too
This is bold text
This is bold text too
This was mistaken text
You can combine them
All this text is important
2.4. Citace textu
Používá se >.
1
2
3
> This is a first blockquote.
>> This is a second blockquote.
>>> This is a third blockquote.
This is a first blockquote.
This is a second blockquote.
This is a third blockquote.
2.5. Citace kódu
Používá se ``` nebo ~~~.
1
2
3
4
5
```
git status
git add
git commit
```
1
2
3
git status
git add
git commit
Můžete také určit programovací jazyk a zapnout zvýraznění syntaxe.
1
2
3
4
5
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
1
2
3
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
2.6. Odkazy
1
2
[GitHub Pages](https://pages.github.com/)
<https://pages.github.com/>
GitHub Pages
https://pages.github.com/
Lze použít i relativní odkazy, které ukazují na jiné soubory v rámci repozitáře. Způsob použití je stejný jako v terminálu.
1
[README](../README.md)
2.7. Nečíslovaný seznam
Použijte - nebo *.
1
2
3
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
2.8. Číslovaný seznam
Použijte čísla.
1
2
3
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
2.9. Vnořený seznam
1
2
3
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
2.10. Seznam úkolů
Chcete-li vytvořit seznam úkolů, přidejte před každou položku [ ]. Pro označení dokončené položky použijte [x].
1
2
3
- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request
- Finish my changes
- Push my commits to GitHub
- Open a pull request
2.11. Vložení obrázku
1
2
3
4
Způsob: {(volitelné)další volby}
{: .align-center}
{: width="50%" height="50%"}
2.12. Vytvoření tabulky
Tabulku lze vytvořit pomocí | a -. Aby se tabulka zobrazila správně, je potřeba nechat před ní jeden prázdný řádek. Alespoň 3 znaky - jsou nutné pro správné rozpoznání.
1
2
3
4
5
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |