Co je Markdown?
Markdown je jazyk značek, který nabízí štíhlý přístup k úpravám obsahu stíněním tvůrců obsahu před režií HTML. I když je HTML skvělé pro vykreslování obsahu přesně tak, jak byl zamýšlen, zabírá hodně místa a práce s ním může být i v malých dávkách nepraktická. Markdown nabízí skvělý kompromis mezi výkonem HTML pro popis obsahu a jednoduchostí prostého textu pro úpravy.
V této lekci probereme strukturu a syntaxi Markdownu. Probereme také funkce GitHub-Flavored Markdownu (GFM), což jsou rozšíření syntaxe, která umožňují integrovat funkce GitHubu do obsahu.
Poznámka:
Tato lekce vám poskytne představu, o čem Markdown je. Podrobnější přehled najdete v popisu syntaxe Markdownu a článcích specifikace GitHub-Flavored Markdown v této lekci souhrnu tohoto modulu.
Zvýraznění textu
Nejdůležitější součástí jakékoli komunikace na GitHubu je obvykle samotný text, jak ale ukážete, že některé části textu jsou důležitější než jiné?
Použití kurzívy v textu je stejně snadné jako obklopování cílového textu jedinými hvězdičkami (*) nebo jedním podtržítkem (_). Stačí zavřít důraz se stejným znakem, se kterým jste ho otevřeli. Mějte na paměti, jak kombinovat použití hvězdičky a podtržítek. Tady je několik příkladů:
This is *italic* text.
This is also _italic_ text.
Toto je text psaný kurzívou. Jedná se také o kurzívu .
Vytvořte tučný text pomocí dvou hvězdičk (**) nebo dvou podtržítek (__).
This is **bold** text.
This is also __bold__ text.
Toto je tučný text. Tento text je také tučný .
Různá zvýraznění můžete kombinovat.
_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
__This is bold and *italic* text__ using double underscores for bold and single asterisks for italic.
Jedná se o kurzívu a tučný text , který používá jedno podtržítko pro kurzívu a dvojité hvězdičky pro tučné písmo. Tento text je tučný a kurzíva s dvojitým podtržítkem pro tučné písmo a jedno hvězdičky pro kurzívu.
Chcete-li použít literál hvězdičku, před ním řídicí znak; v GFM je to zpětné lomítko (\). Výsledkem tohoto příkladu jsou podtržítka a hvězdičky zobrazené ve výstupu.
\_This is all \*\*plain\*\* text\_.
_This je všechny text_ **plain**.
Deklarace nadpisů
HTML poskytuje nadpisy obsahu, jako <h1> je značka. Markdown to podporuje prostřednictvím symbolu #. Stačí použít jeden # pro každou úroveň nadpisu od 1 do 6.
###### This is H6 text
Toto je text H6.
Odkaz na obrázky a weby
Odkazy na obrázky a weby používají podobnou syntaxi.
[Link to Microsoft Training](/training)
Vytváření seznamů
Můžete definovat uspořádané nebo neuspořádané seznamy. Můžete také definovat vnořené položky pomocí odsazení.
- Seřazené seznamy začínají čísly.
- Neuspořádané seznamy můžou používat hvězdičky nebo pomlčky (
-).
Tady je Markdown pro seřazený seznam:
1. First
1. Second
1. Third
Výsledek:
- První
- Second
- Třetí
Tady je Markdown pro neuspořádaný seznam:
- First
- Nested
- Second
- Third
- Prvních
- Vnořený
- Second
- Třetí
Vytváření tabulek
Tabulky můžete vytvořit pomocí kombinace kanálů (|) pro konce sloupců a pomlčky (-) k označení předchozího řádku jako záhlaví.
First|Second
-|-
1|2
3|4
První Second 1 2 3 4
Text uvozovek
Blokové citace můžete vytvořit pomocí znaku větší než (>).
> This is quoted text.
Toto je text v uvozovkách.
Vyplnění mezer vloženým kódem HTML
Pokud se setkáte se scénářem HTML, který Markdown nepodporuje, můžete použít vložený kód HTML.
Here is a<br />line break
Tady je
konec řádku
Práce s kódem
Markdown poskytuje výchozí chování pro práci s vloženými bloky kódu oddělenými zpětným znakem ('). Při dekorování textu tímto znakem se vykreslí jako kód.
This is `code`.
Toto je
code.
Pokud máte segment kódu, který obsahuje více řádků, můžete před a po vytvoření ohraničeného bloku kódu použít tři backticks (''').
```markdown
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1; var second = 2; var sum = first + second;
GFM rozšiřuje tuto podporu o zvýrazňování syntaxe pro oblíbené jazyky. Stačí zadat jazyk jako součást první sekvence čárek.
```javascript
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1; var second = 2; var sum = first + second;
Problémy s křížovým propojením a žádosti o přijetí změn
GFM podporuje různé formáty krátkého kódu, které usnadňují propojení s problémy a žádostmi o přijetí změn. Nejjednodušším způsobem, jak to udělat, je použít formát #ID, jako je například #3602. GitHub automaticky upraví delší odkazy na tento formát, pokud je vložíte. Existují také další konvence, které můžete sledovat, například pokud pracujete s jinými nástroji nebo chcete zadat jiné projekty nebo větve.
| Typ odkazu | Nezpracovaný odkaz | Krátký odkaz |
|---|---|---|
| Adresa URL problému nebo žádosti o přijetí změn | https://github.com/desktop/desktop/pull/3602 |
#3602 |
# a číslo problému nebo žádosti o přijetí změn |
#3602 | #3602 |
GH- a číslo problému nebo žádosti o přijetí změn |
GH-3602 | GH-3602 |
Username/Repository# a číslo problému nebo žádosti o přijetí změn |
desktop/desktop#3602 | desktop/desktop#3602 |
Další informace najdete v článku o automaticky propojených odkazech a adresách URL v souhrnné lekci tohoto modulu.
Propojení konkrétních potvrzení
K potvrzení můžete připojit vložením jeho ID nebo jednoduše pomocí jeho zabezpečeného hashovacího algoritmu (SHA).
| Typ odkazu | Nezpracovaný odkaz | Krátký odkaz |
|---|---|---|
| Adresa URL zápisu | https://github.com/desktop/desktop/commit/ | |
| 8304e9c271a5e5ab4fda797304cd7bcca7158c87 | 8304e9c | |
| SHA | 8304e9c271a5e5ab4fda797304cd7bcca7158c87 | 8304e9c |
| User@SHA | desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | desktop@8304e9c |
| Uživatelské jméno/Repository@SHA | desktop/desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | desktop/desktop@8304e9c |
Zmínka o uživatelích a týmech
Zadání symbolu @ následovaného uživatelským jménem GitHubu odešle této osobě oznámení o komentáři. Tomu se říká "@mention", protože zmíníte jednotlivce.
@mention můžete použít také pro týmy v organizaci.
@githubteacher
Sledování seznamů úkolů
Seznamy úkolů můžete vytvářet v rámci problémů nebo žádostí o přijetí změn pomocí následující syntaxe. Tyto seznamy mohou být při použití v textu problému nebo žádosti o přijetí změn užitečné ke sledování průběhu.
- [x] First task
- [x] Second task
- [ ] Third task
Příkazy lomítka
Příkazy slash vám můžou ušetřit čas tím, že omezí psaní potřebné k vytvoření složitého Markdownu.
Příkazy lomítka můžete použít v libovolném poli popisu nebo komentáře v problémech, žádostech o přijetí změn nebo diskuzích, kde je tento příkaz lomítka podporovaný.
| Příkaz | Popis |
|---|---|
/code |
Vloží blok kódu Markdownu. Zvolíte jazyk. |
/details |
Vloží sbalitelnou oblast podrobností. Zvolíte název a obsah. |
/saved-replies |
Vloží uloženou odpověď. Můžete si vybrat z uložených odpovědí pro váš uživatelský účet. Pokud přidáte %cursor% do uložené odpovědi, příkaz lomítko umístí kurzor do daného umístění. |
/table |
Vloží tabulku Markdownu. Zvolíte počet sloupců a řádků. |
/tasklist |
Vloží seznam úkolů. Tento příkaz lomítko funguje jenom v popisu problému. |
/template |
Zobrazí všechny šablony v úložišti. Zvolíte šablonu, kterou chcete vložit. Tento příkaz lomítko funguje pro šablony problémů a šablonu žádosti o přijetí změn. |