Phenquestions
Standardní Markdown
Markdown je standard vyvinutý Johnem Gruberem. Hlavním cílem Markdownu je umožnit čtení souboru i v čistém textu. Pokud se chcete podívat do textového editoru, měli byste si ho snadno přečíst. To je velmi užitečné pro uživatele vim a podobných. Nezapomeňte, že se jedná o standard pro změnu textových souborů. Nenahrazuje HTML. Místo toho jej použijete k vytvoření HTML tam, kde je to užitečné. V případě GitHub naformátují soubor Readme na webu. Pokud se budete řídit standardem, můžete si být jisti, že to bude vypadat dobře.
Vzhledem k tomu, že GitHub přidal jen několik rozšíření, měli byste začít pomocí cheatů Markdown a jít odtud. Zde je seznam nejběžnějších.
| Snížení | Rozšíření | Výsledek |
| # (1 za úroveň) | Nadpisy | |
| * | Kurzíva | |
| ** | tučně | |
| > | Blockquote | |
| 1. (atd.) | Objednaný seznam | |
| - | Neuspořádaný seznam | |
| 'kód' | Váš kód | |
| "" | MD-ext | Spuštění a ukončení bloku kódu |
| - | Horizontální pravidlo | |
| [Popis] (https: // www.příklad.com) | Jméno ve čtverci a URL v běžných závorkách | |
| ![alternativní text] (obrázek.png) | Totéž, odkaz na obrázek | |
| [1] | MD-ext | Poznámka pod čarou |
Seznamy lze vnořit odsazením všech položek, které chcete mít vnořené.
Jiná rozšíření k běžnému Markdownu, máte bloky blokující rozšíření výše. Služby nejsou vždy podporovány.
| Snížení | Rozšíření | Výsledek |
| ### Záhlaví # custom-id | MD-ext | Nadpis, který můžete oslovit podle jeho ID |
| termín: definice | MD-ext | Seznam pojmů s definicemi |
| ~ Chybný text ~ | MD-ext | Přeškrtnutý text |
| - [x] Úkol | MD-ext | Seznam úkolů, který můžete zaškrtnout |
Tabulka je velmi jednoduchá, ale pro její zobrazení potřebujete několik řádků: Tabulka:
| Jméno | HODNOTA || ----------- | ---------- |
| Rohože | 100 |
Rozšíření GitHub.
GitHub přidal několik rozšíření, která usnadňují zpracování odkazů na jiné lidi a projekty. Některé z nich jsou výše zmíněné tabulky. Ten, který vám nejvíce pomůže, je rozšíření automatického odkazu. Při použití na GitHubu vytvoří odkaz sám.
Jiné jsou tabulky a položky seznamu úkolů. Jsou vhodné pro sledování vašich úkolů v projektech. Poslední zmínkou je rozšíření Disallowed Raw HTML. S pomocí tohoto rozšíření jsou některé značky filtrovány při vykreslování pro HTML. Tyto značky mohou při vykreslování na GitHub způsobit podivné efekty.
Způsoby, jak prozkoumat GitHub Markdown
Pokud to považujete za matoucí, můžete také přejít na stránku GitHub a použít vestavěný editor. Když jej použijete, automaticky dokončí některé funkce. To funguje pouze pro problémy, ale můžete jej použít k vyřešení některých věcí, emojis vyjde jako seznam, když zadáte dvojtečku (:).
Na GitHubu také můžete najít projekt, který má skvěle vypadající soubor README a klonovat jej na místní disk. Odtud můžete soubor prozkoumat pomocí libovolného editoru, který si přejete. Pro velké editory, Emacs a Vim, existuje podpora pro markdown prostřednictvím rozšíření.
Pokud používáte vim, můžete přidat rozšíření zvýrazňující syntaxi z GitHubu, vim-markdown. Toto rozšíření ukazuje, že jste kód udělali správně. Abychom vám pomohli zjistit, jak to vypadá, až budete hotovi, můžete si také pořídit rozšíření živé známky. Díky tomu můžete mít spuštěný webový server, který při psaní zobrazuje výsledek živě.
S Emacsem máte k dispozici netrpělivý režim, živý režim dolů a náhled v reálném čase. Všechny vám během psaní zobrazí výslednou stránku v prohlížeči. První vyžaduje méně knihoven než druhá, ale ke spuštění potřebuje další fragment kódu.
Závěr
Přestože je markdown malá a záměrně jednoduchá specifikace, může být na začátek trochu matoucí. Nejlepší způsob, jak se to naučit, je podvádět a psát svůj dokument Markdown. Svůj soubor README můžete aktualizovat.md na GitHubu a můžete získat velkou podporu z vestavěných funkcí vašich editorů. Jako vedlejší poznámku GitHub také podporuje emodži, které můžete přidat do svého dokumentu. Pomocí podváděcího listu můžete zjistit, které z nich jsou.
Stáhněte si Markdown-CheatSheet zde
