Standardni Markdown
Markdown je standard koji je razvio John Gruber. Glavni cilj Markdowna je omogućiti čitanje datoteke čak i u čistom tekstu. Ako želite pogledati uređivač samo za tekst, lako biste ga pročitali. Ovo je vrlo korisno za korisnike vima i slično. Napomena i imajte na umu da je ovo standard za promjenu tekstualnih datoteka. Ne zamjenjuje HTML. Umjesto toga, koristite ga za stvaranje HTML-a tamo gdje je to korisno. U slučaju GitHub-a, oni će formatirati datoteku Readme na web mjestu. Sve dok slijedite standard, možete biti sigurni da će izgledati dobro.
Budući da je GitHub dodao samo nekoliko proširenja, trebali biste započeti s Markdown varalicom i otići od tamo. Evo popisa najčešćih.
Smanjenje | Proširenja | Proizlaziti |
# (1 po razini) | Naslovi | |
* | Kurziv | |
** | Podebljano | |
> | Blok citat | |
1. (itd.) | Poredani popis | |
- | Neuređeni popis | |
'kodirati' | Vaš kod | |
"' | Md-lok | Pokretanje i završavanje bloka koda |
- | Vodoravno pravilo | |
[Opis] (https: // www.primjer.com) | Ime u kvadratnom obliku i URL u redovitim zagradama | |
![alt text] (slika.png) | Isto, veza do slike | |
[1] | Md-lok | Fusnota |
Popisi se mogu ugnijezditi uvlačenjem svih stavki koje želite ugniježditi.
Ostala proširenja redovnog Markdowna, gore su navedena proširenja koda. Usluge ih ne podržavaju uvijek.
Smanjenje | Proširenja | Proizlaziti |
### Naslov # custom-id | Md-lok | Naslov koji možete adresirati prema njegovom ID-u |
pojam: definicija | Md-lok | Popis pojmova s definicijama |
~ Pogrešan tekst ~ | Md-lok | Precrtani tekst |
- [x] Zadatak koji treba obaviti | Md-lok | Popis zadataka koji možete označiti |
Tablica je vrlo jednostavna, ali treba vam nekoliko redaka da je prikažete: Tablica:
| Ime | VRIJEDNOST || ----------- | ---------- |
| Prostirke | 100 |
GitHub proširenja.
GitHub je dodao nekoliko proširenja kako bi pojednostavnio rukovanje vezama do drugih ljudi i projekata. Neke od njih su ranije spomenute tablice. Ono koje će vam najviše pomoći je proširenje automatske veze. Povezu stvara sam kada je koristite na GitHubu.
Ostalo su tablice i stavke popisa zadataka. Oni su prikladni za praćenje vaših zadataka u projektima. Posljednje koje treba spomenuti je nedopušteno sirovo HTML proširenje. Uz pomoć ovog proširenja neke se oznake filtriraju prilikom prikazivanja za HTML. Te oznake mogu uzrokovati čudne efekte prilikom generiranja na GitHub.
Načini za istraživanje GitHub Markdowna
Ako vam se čini zbunjujućim, također možete otići na stranicu GitHub i upotrijebiti ugrađeni uređivač. Kada ga koristite, automatski će dovršiti neke funkcije. Ovo funkcionira samo za probleme, ali pomoću njega možete shvatiti neke stvari, emojiji se pojavljuju kao popis kada upišete dvotačku (:).
Na GitHubu također možete pronaći projekt koji ima izvrsnu README datoteku i klonirajte je na svoj lokalni pogon. Odatle datoteku možete istražiti pomoću bilo kojeg uređivača koji želite. Za velike urednike, Emacs i Vim, postoji podrška za umanjenje vrijednosti kroz proširenja.
Ako koristite vim, možete dodati proširenje za isticanje sintakse s GitHub-a, vim-markdown. Ovo proširenje pokazuje vam da ste ispravno izvršili kôd. Da biste lakše vidjeli kako izgleda kad završite, također možete dobiti proširenje za oznaku uživo. Pomoću toga možete pokrenuti web poslužitelj koji prikazuje rezultat uživo dok tipkate.
S Emacsom imate nestrpljivi način rada, prekid rada i pregled u stvarnom vremenu. Svi prikazuju vašu rezultirajuću stranicu u pregledniku dok tipkate. Prva zahtijeva manje knjižnica od potonje, ali za pokretanje treba dodatni isječak koda.
Zaključak
Iako je umanjenje male i namjerno jednostavna specifikacija, za početak može biti pomalo zbunjujuće. Najbolji način da naučite je da koristite varalicu i napišete svoj Markdown dokument. Možete ažurirati svoj README.md na GitHubu, a veliku podršku možete dobiti od ugrađenih funkcija urednika. Kao popratnu napomenu, GitHub također podržava emojije koje možete dodati u svoj dokument. Možete koristiti varalicu kako biste pronašli koji su to.
Preuzmite Markdown-CheatSheetHere