Standardni Markdown
Markdown je standard, ki ga je razvil John Gruber. Glavni cilj Markdowna je omogočiti branje datoteke tudi v čistem besedilu. Če želite pogledati v urejevalnik besedil, ga lahko preprosto preberete. To je zelo koristno za uporabnike vim in podobnega. Upoštevajte in ne pozabite, da je to standard za spreminjanje besedilnih datotek. Ne nadomešča HTML-ja. Namesto tega ga uporabljate za ustvarjanje HTML-ja, kjer je to koristno. V primeru GitHub-a bodo datoteko Readme formatirali na spletnem mestu. Dokler upoštevate standard, ste prepričani, da bo videti dobro.
Ker je GitHub dodal le nekaj razširitev, najprej začnite z uporabo varalnice Markdown in pojdite od tam. Tu je seznam najpogostejših.
Markdown | Razširitve | Rezultat |
# (1 na raven) | Naslovi | |
* | Ležeče | |
** | Krepko | |
> | Blok citat | |
1. (itd.) | Urejeni seznam | |
- | Neurejen seznam | |
'Koda' | Vaša koda | |
"' | Md-ext | Začetek in konec bloka kode |
- | Vodoravno pravilo | |
[Opis] (https: // www.primer.com) | Ime v oglatih oklepajih in URL v običajnih oklepajih | |
![alt text] (slika.png) | Enako, povezava do slike | |
[1] | Md-ext | Opomba |
Seznami se lahko ugnezdijo z zamikom poljubnih elementov, ki jih želite ugnezditi.
Druge razširitve običajnega Markdowna imajo zgoraj razširitve kode. Storitve jih ne podpirajo vedno.
Markdown | Razširitve | Rezultat |
### Naslov # custom-id | Md-ext | Naslov, ki ga lahko naslovite z njegovo ID |
izraz: opredelitev | Md-ext | Seznam izrazov z definicijami |
~ Napačno besedilo ~ | Md-ext | Prečrtano besedilo |
- [x] Naloga, ki jo je treba opraviti | Md-ext | Seznam opravil, ki ga lahko označite |
Tabela je zelo preprosta, vendar za prikaz potrebujete več vrstic: Tabela:
| Ime | VREDNOST || ----------- | ---------- |
| Predpražniki | 100 |
Razširitve GitHub.
GitHub je dodal nekaj razširitev za lažje upravljanje povezav do drugih ljudi in projektov. Nekatere od teh so prej omenjene tabele. Najbolj vam bo pomagala razširitev samodejne povezave. Povezavo ustvari sam, ko jo uporabite na GitHubu.
Drugi so tabele in elementi seznama opravil. Ti so priročni za spremljanje vaših nalog v projektih. Zadnja, ki jo omenim, je razširitev Ne dovoljeni neobdelani HTML. S pomočjo te razširitve se nekatere oznake filtrirajo pri upodabljanju za HTML. Te oznake lahko povzročijo nenavadne učinke pri upodabljanju v GitHub.
Načini za raziskovanje GitHub Markdown
Če se vam zdi zmedeno, lahko obiščete tudi stran GitHub in uporabite vgrajeni urejevalnik. Ko jo uporabite, bo nekatere funkcije samodejno dokončal. To deluje samo pri težavah, vendar lahko z njim ugotovite nekatere stvari, emojiji se prikažejo kot seznam, ko vtipkate dvopičje (:).
Na GitHubu lahko najdete tudi projekt, ki ima čudovito datoteko README in jo klonirate na svoj lokalni pogon. Od tam lahko datoteko raziščete s poljubnim urejevalnikom. Za velike urednike, Emacs in Vim, je na voljo podpora za označevanje z razširitvami.
Če uporabljate vim, lahko v GitHub vstavite razširitev za poudarjanje sintakse, vim-markdown. Ta razširitev vam pokaže, da ste pravilno naredili kodo. Če si želite ogledati, kako izgleda, ko končate, lahko dobite tudi razširitev oznake v živo. S tem lahko zaženete spletni strežnik, ki prikazuje rezultate v živo med tipkanjem.
Z Emacsom imate nestrpni način, nedejavni način in predogled v realnem času. Vsi med prikazom prikažejo vašo nastalo stran v brskalniku. Prva zahteva manj knjižnic kot druga, a za zagon potrebuje dodaten delček kode.
Zaključek
Čeprav je zmanjšanje vrednosti majhna in namerno preprosta specifikacija, je lahko za začetek nekoliko zmedeno. Najboljši način za učenje je, da uporabite goljufivo listo in napišete svoj Markdown dokument. Svoj README lahko posodobite.md na GitHubu in lahko dobite veliko podpore z vgrajenimi funkcijami urejevalnikov. Kot stransko opombo GitHub podpira tudi emojije, ki jih lahko dodate v svoj dokument. Z goljufijami lahko ugotovite, kateri so.
Prenesite Markdown-CheatSheetHere