Markdown je lehká a snadno použitelná syntaxe pro styling všech forem psaní na platformě GitHub.
Co se naučíte:
- Jak formátu Markdown je stylizovaný kolaborativní editaci snadné
- Jak Markdown se liší od tradičních formátování přístupy
- Jak používat Markdown formátování textu
- Jak využít GitHub je automatické Markdown vykreslování
- Jak použít GitHub je unikátní Markdown rozšíření
Co je Markdown?
Markdown je způsob, jak styl textu na webu., Ovládáte zobrazení dokumentu; formátování slov jako tučné nebo kurzíva, přidávání obrázků a vytváření seznamů je jen několik věcí, které můžeme dělat s Markdown. Většinou, Markdown je jen obyčejný text s několika non-abecední znaky hodil, jako #
nebo *
.,
můžete použít Markdown většině míst kolem GitHub:
- Gist
- Komentáře v Otázkách a Vytáhněte Žádosti
- Soubory
.md
nebo.markdown
rozšíření
Pro více informací, viz „Psaní na GitHub“ v GitHub Pomoc.
Příklady
- Text
- Seznamy
- Obrázky
- Záhlaví & Citace
- Kód
- Doplňky
Syntaxe průvodce
Zde je přehled syntaxe Markdown, které můžete používat kdekoliv na GitHub.com nebo ve své vlastní textové soubory.,3>Headers
# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag
Emphasis
*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_
Lists
Unordered
* Item 1* Item 2 * Item 2a * Item 2b
Ordered
1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b
Images
!(/images/logo.png)Format: !(url)
Links
http://github.com - automatic!(http://github.com)
Blockquotes
As Kanye West said:> We're living the future so> the present is our past.
Inline code
I think you should use an`<addr>` element here instead.
GitHub Flavored Markdown
GitHub.,com používá vlastní verze Markdown syntaxi, která poskytuje další sada užitečných funkcí, které usnadňují práci s obsahem na GitHub.com.
na Vědomí, že některé funkce na GitHub Ochucené Markdown jsou k dispozici pouze v popisy a komentáře, Otázky a Žádosti o stažení. Patří mezi ně @ zmínky, stejně jako odkazy na SHA-1 hash, problémy, a vytáhnout požadavky. Seznamy úloh jsou k dispozici také v komentářích Gist a v souborech Gist Markdown.,
zvýraznění Syntaxe
Tady je příklad toho, jak můžete použít zvýraznění syntaxe s GitHub Ochucené Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
můžete také jednoduše odsazení kódu čtyři mezery:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
Zde je příklad Python kód bez zvýrazňování syntaxe:
def foo(): if not bar: return True
Seznamy Úkolů
Pokud jste zahrnout seznam úkolů na první komentář, emise, dostanete praktický indikátor průběhu ve vaší otázce seznam. Funguje také v žádosti Pull!,parating každý sloupek s trubkou |
:
By se stal:
Záhlaví | Druhá Hlavičky |
---|---|
Obsah buňky 1 | Obsah buňky 2 |
Obsah první sloupec | Obsah druhého sloupce |
SHA odkazy
odkaz na commit je SHA-1 hash bude automaticky převeden na odkaz, který commit na GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
Problém odkazy v rámci úložiště
Jakékoli číslo, které odkazuje na Problém nebo Žádost Pull budou automaticky převedeny na odkaz.
#1mojombo#1mojombo/github-flavored-markdown#1
uživatelské Jméno @zmiňuje
Psaní @
symbol, následuje uživatelské jméno, oznámí tato osoba přijít a zobrazit komentáře. Tomu se říká „@zmínka“, protože zmiňujete jednotlivce. Můžete také @zmínit týmy v rámci organizace.,
Automatické propojení pro adresy Url
URL (jako je ), bude automaticky převede na klikací odkaz.
přeškrtnutí
jakékoli slovo zabalené dvěma Tildy (jako~~this~~
) se objeví přeškrtnuté.
Emoji
GitHub podporuje emoji!
Chcete-li zobrazit seznam všech obrázků, které podporujeme, podívejte se na Cheat Sheet Emoji.
aktualizováno leden 15, 2014