Phenquestions
Markdown standard
Markdown este un standard dezvoltat de John Gruber. Scopul principal cu Markdown este de a face ca fișierul să poată fi citit chiar și în text pur. Dacă doriți să căutați într-un editor numai pentru text, ar trebui să aveți un timp ușor de citit. Acest lucru este foarte util pentru utilizatorii de vim și similare. Rețineți și amintiți-vă că acesta este un standard pentru schimbarea fișierelor text. Nu înlocuiește HTML. În schimb, îl utilizați pentru a crea HTML acolo unde este util. În cazul GitHub, acestea vor formata fișierul Readme de pe site. Atâta timp cât respectați standardul, puteți avea certitudinea că va arăta bine.
Deoarece GitHub a adăugat doar câteva extensii, ar trebui să începeți prin a folosi o foaie de cheats Markdown și să mergeți de acolo. Iată o listă cu cele mai frecvente.
| Markdown | Extensii | Rezultat |
| # (1 pe nivel) | Titluri | |
| * | Cursiv | |
| ** | Îndrăzneţ | |
| > | Blockquote | |
| 1. (etc.) | Lista ordonata | |
| - | Lista neordonata | |
| 'cod' | Codul tau | |
| „' | Md-ext | Porniți și terminați un bloc de cod |
| - | Regula orizontală | |
| [Descriere] (https: // www.exemplu.com) | Un nume în pătrat și URL între paranteze obișnuite | |
| ![text alternativ] (imagine.png) | La fel, link către o imagine | |
| [1] | Md-ext | O notă de subsol |
Listele pot fi imbricate prin indentarea oricăror elemente pe care doriți să le fiți imbricate.
Alte extensii la Markdown obișnuit, aveți extensiile de blocuri de cod de mai sus. Nu sunt întotdeauna susținute de servicii.
| Markdown | Extensii | Rezultat |
| ### Antet custom-id | Md-ext | Un titlu pe care îl puteți adresa după ID-ul acestuia |
| termen: definiție | Md-ext | O listă de termeni cu definiții |
| ~ Text greșit ~ | Md-ext | Text bătut |
| - [x] Sarcină de făcut | Md-ext | O listă de activități pe care o puteți bifa |
Tabelul este foarte simplu, dar aveți nevoie de mai multe rânduri pentru a-l afișa: Tabel:
| Nume | VALOR || ----------- | ---------- |
| Mats | 100 |
Extensii GitHub.
GitHub a adăugat câteva extensii pentru a facilita gestionarea legăturilor către alte persoane și proiecte. Unele dintre acestea sunt tabelele menționate anterior. Cea care vă va ajuta cel mai mult este extensia de auto-link. Creează un link de unul singur atunci când îl folosești pe GitHub.
Altele sunt tabele și articole din lista de activități. Acestea sunt convenabile pentru a vă urmări sarcinile în proiecte. Ultima de menționat este extensia HTML interzisă Raw. Cu ajutorul acestei extensii, unele etichete sunt filtrate la redarea pentru HTML. Aceste etichete pot provoca efecte ciudate atunci când sunt redate pe GitHub.
Modalități de a explora GitHub Markdown
Dacă vi se pare confuz, puteți accesa și pagina GitHub și puteți utiliza editorul încorporat. Când îl utilizați, acesta va completa automat unele funcții. Acest lucru funcționează doar pentru probleme, dar îl puteți folosi pentru a afla câteva lucruri, emoji-urile apar ca o listă atunci când tastați două puncte (:).
Puteți găsi, de asemenea, un proiect pe GitHub care are un fișier README excelent și îl clonați pe unitatea dvs. locală. De acolo, puteți explora fișierul folosind orice editor doriți. Pentru editorii mari, Emacs și Vim, există suport pentru reducere prin extensii.
Dacă utilizați vim, puteți pune o extensie de evidențiere a sintaxei din GitHub, vim-markdown. Această extensie vă arată că ați făcut corect codul. Pentru a vă ajuta să vedeți cum arată atunci când ați terminat, puteți obține, de asemenea, extensia de marcaj live. Cu aceasta, puteți avea un server web care rulează, afișând rezultatul în timp ce tastați.
Cu Emacs, aveți modul de nerăbdare, modul în direct și previzualizarea în timp real. Toate afișează pagina rezultată într-un browser în timp ce tastați. Prima necesită mai puține biblioteci decât cea din urmă, dar are nevoie de un fragment de cod suplimentar pentru a rula.
Concluzie
Chiar dacă reducerea este o specificație mică și deliberat simplă, poate fi puțin confuz să începi. Cel mai bun mod de a învăța este să folosiți o foaie de înșelăciune și să scrieți documentul dvs. Markdown. Puteți actualiza README.md pe GitHub și puteți obține o mulțime de asistență din funcțiile încorporate ale editorilor. Ca o notă laterală, GitHub acceptă, de asemenea, emojis pe care le puteți adăuga la document. Puteți utiliza foaia de trișare pentru a găsi care sunt acestea.
Descărcați Markdown-CheatSheetHere
