Phenquestions
Štandardné Markdown
Markdown je štandard vyvinutý Johnom Gruberom. Hlavným cieľom programu Markdown je umožniť čítanie súboru aj v čistom texte. Ak sa chcete pozrieť do textového editora, mali by ste si ho ľahko prečítať. To je veľmi užitočné pre používateľov vim a podobne. Nezabudnite, že toto je štandard pre zmenu textových súborov. Nenahrádza HTML. Namiesto toho ho použijete na vytvorenie HTML tam, kde je to užitočné. V prípade GitHub naformátujú súbor Readme na webe. Pokiaľ budete postupovať podľa normy, môžete si byť istí, že bude vyzerať dobre.
Pretože GitHub pridal iba niekoľko rozšírení, mali by ste začať tým, že použijete cheatsheet Markdown a budete pokračovať odtiaľ. Tu je zoznam najbežnejších.
| Markdown | Prípony | Výsledok |
| # (1 na úroveň) | Nadpisy | |
| * | Kurzíva | |
| ** | Odvážne | |
| > | Blockquote | |
| 1. (atď.) | Objednaný zoznam | |
| - | Neusporiadaný zoznam | |
| 'kód' | Váš kódex | |
| „ | Md-ext | Spustenie a ukončenie bloku kódu |
| - | Horizontálne pravidlo | |
| [Popis] (https: // www.príklad.com) | Názov v štvorci a URL v bežných zátvorkách | |
| ![alternatívny text] (obrázok.png) | To isté, odkaz na obrázok | |
| [1] | Md-ext | Poznámka pod čiarou |
Zoznamy je možné vnoriť tak, že odsadíte všetky položky, ktoré chcete mať vnorené.
Ďalšie rozšírenia k bežnému Markdownu, máte blokovanie rozšírení kódu vyššie. Nie vždy sú službami podporované.
| Markdown | Prípony | Výsledok |
| ### Nadpis # custom-id | Md-ext | Nadpis, ktorý môžete osloviť podľa jeho ID |
| pojem: definícia | Md-ext | Zoznam pojmov s definíciami |
| ~ Chybný text ~ | Md-ext | Preškrtnutý text |
| - [x] Úloha | Md-ext | Môžete označiť zoznam úloh |
Tabuľka je veľmi jednoduchá, ale na jej zobrazenie potrebujete niekoľko riadkov: Tabuľka:
| Meno | HODNOTA || ----------- | ---------- |
| Rohože | 100 |
Rozšírenia GitHub.
GitHub pridal niekoľko rozšírení, ktoré uľahčujú prácu s odkazmi na ďalších ľudí a projekty. Niektoré z nich sú už spomenuté tabuľky. Najviac vám pomôže rozšírenie o automatické prepojenie. Keď ho použijete na GitHub, vytvorí si odkaz sám.
Ostatné sú tabuľky a položky zoznamu úloh. Sú vhodné na sledovanie vašich úloh v projektoch. Ako posledná spomenieme rozšírenie Disallowed Raw HTML. Pomocou tohto rozšírenia sú niektoré značky filtrované pri vykresľovaní pre HTML. Tieto značky môžu pri vykresľovaní na GitHub spôsobiť zvláštne efekty.
Spôsoby, ako preskúmať GitHub Markdown
Ak sa vám to zdá neprehľadné, môžete tiež prejsť na stránku GitHub a použiť vstavaný editor. Keď ho použijete, automaticky dokončí niektoré funkcie. Funguje to iba pri problémoch, ale môžete ho použiť na zistenie niektorých vecí. Emojis sa zobrazí ako zoznam, keď napíšete dvojbodku (:).
Na GitHube tiež môžete nájsť projekt, ktorý má skvelo vyzerajúci súbor README a naklonovať ho na svoj miestny disk. Odtiaľ môžete súbor prehliadať pomocou ľubovoľného editora, ktorý si želáte. Pre veľkých editorov, Emacs a Vim, existuje podpora pre markdown prostredníctvom rozšírení.
Ak používate vim, môžete doň vložiť príponu zvýrazňujúcu syntaxu z GitHubu, vim-markdown. Toto rozšírenie ukazuje, že ste kód vykonali správne. Aby ste videli, ako to po dokončení vyzerá, môžete si tiež zaobstarať rozšírenie pre živé známky. Vďaka tomu môžete mať webový server spustený a pri zadávaní bude výsledok živý.
S Emacsom máte k dispozícii netrpezlivý režim, živý režim down-down a náhľad v reálnom čase. Všetky zobrazujú vašu výslednú stránku v prehliadači počas zadávania textu. Prvá vyžaduje menej knižníc ako druhá, ale na spustenie je potrebný ďalší útržok kódu.
Záver
Aj keď je markdown malá a zámerne jednoduchá špecifikácia, na začiatok môže byť trochu mätúce. Najlepším spôsobom, ako sa to naučiť, je použiť cheat sheet a napísať svoj dokument Markdown. Svoj súbor README môžete aktualizovať.md na GitHub a získate veľkú podporu zo vstavaných funkcií editorov. GitHub tiež podporuje emodži, ktoré môžete pridať do svojho dokumentu. Pomocou podvodníka môžete zistiť, ktoré z nich sú.
Stiahnite si Markdown-CheatSheet tu
