Phenquestions
Standartinis „Markdown“
„Markdown“ yra Johno Gruberio sukurtas standartas. Pagrindinis „Markdown“ tikslas yra leisti failą perskaityti net grynu tekstu. Jei norite ieškoti tik teksto redaktoriuje, turėtumėte lengvai jį perskaityti. Tai labai naudinga „vim“ ir panašių vartotojų vartotojams. Atkreipkite dėmesį ir atminkite, kad tai yra teksto failų keitimo standartas. Tai nepakeičia HTML. Vietoj to, jūs naudojate jį kurdami HTML, kur tai naudinga. „GitHub“ atveju jie formatuos „Readme“ failą svetainėje. Jei laikysitės standarto, galite būti tikri, kad jis atrodys gerai.
Kadangi „GitHub“ pridėjo tik kelis plėtinius, turėtumėte pradėti naudodami „Markdown“ cheatsheet ir eiti iš ten. Čia pateikiamas dažniausiai pasitaikančių sąrašas.
| Užsirašyk | Pratęsimai | Rezultatas |
| # (1 kiekvienam lygiui) | Antraštės | |
| * | Kursyvas | |
| ** | Drąsus | |
| > | Blokinė citata | |
| 1. (ir kt.) | Užsakytas sąrašas | |
| - | Nesutvarkytas sąrašas | |
| „kodas“ | Jūsų kodas | |
| „ | Md-ext | Pradėkite ir baigkite kodo bloką |
| - | Horizontali taisyklė | |
| [Aprašymas] (https: // www.pavyzdys.com) | Vardas kvadratu ir URL skliaustuose | |
| ![alternatyvus tekstas] (vaizdas.png) | Tas pats, nuoroda į vaizdą | |
| [1] | Md-ext | Išnaša |
Sąrašai gali būti įterpti įtraukdami visus elementus, kuriuos norite įdėti.
Kiti įprasto „Markdown“ plėtiniai, aukščiau turite kodų blokų plėtinius. Ne visada jas palaiko tarnybos.
| Užsirašyk | Pratęsimai | Rezultatas |
| ### Antraštė # custom-id | Md-ext | Antraštė, kurią galite adresuoti pagal savo ID |
| terminas: apibrėžimas | Md-ext | Sąvokų sąrašas su apibrėžimais |
| ~ Klaidus tekstas ~ | Md-ext | Perbrauktas tekstas |
| - [x] Užduotis | Md-ext | Užduočių sąrašas, kurį galite pažymėti |
Lentelė yra labai paprasta, tačiau norint ją parodyti reikia kelių eilučių:
| Pavadinimas | VERTĖ || ----------- | ---------- |
| Kilimėliai | 100 |
„GitHub“ plėtiniai.
„GitHub“ pridėjo keletą plėtinių, kad būtų paprasčiau tvarkyti nuorodas į kitus žmones ir projektus. Kai kurie iš jų yra anksčiau minėtos lentelės. Labiausiai jums padės automatinio susiejimo plėtinys. Tai sukuria nuorodą atskirai, kai ją naudojate „GitHub“.
Kiti yra lentelės ir užduočių sąrašo elementai. Tai yra patogu sekti savo užduotis projektuose. Paskutinis paminėtas yra neleidžiamas neapdorotas HTML plėtinys. Naudojant šį plėtinį, kai kurios žymos filtruojamos perteikiant HTML. Šios žymos gali sukelti keistų efektų, kai pateikiamos „GitHub“.
Būdai ištirti „GitHub Markdown“
Jei jums atrodo painu, taip pat galite pereiti į „GitHub“ puslapį ir naudoti įmontuotą redaktorių. Kai jį naudosite, kai kurios funkcijos bus automatiškai užbaigtos. Tai tinka tik problemoms spręsti, bet jūs galite naudoti ją išsiaiškinti kai kuriuos dalykus, jaustukai pasirodo kaip sąrašas, kai įvedate dvitaškį (:).
Taip pat „GitHub“ galite rasti puikios išvaizdos „README“ failą ir klonuoti jį į savo vietinį diską. Iš ten galite naršyti failą naudodami bet kurį norimą redaktorių. Didiesiems redaktoriams - „Emacs“ ir „Vim“ - palaikoma žymėjimas naudojant plėtinius.
Jei naudojate „vim“, galite įdėti sintaksės paryškinimo plėtinį iš „GitHub“, „vim-markdown“. Šis plėtinys rodo, kad kodą atlikote teisingai. Kad galėtumėte lengviau pamatyti, kaip tai atrodo, taip pat galite gauti tiesioginio ženklo plėtinį. Tai atlikę galite paleisti žiniatinklio serverį, rodantį rezultatą, kai vedate tekstą.
Naudodami „Emacs“ turite nekantrųjį režimą, tiesioginį režimą ir „Realtime“ peržiūrą. Jie visi rodo jūsų gautą puslapį naršyklėje, kol vedate tekstą. Pirmajam reikia mažiau bibliotekų nei pastarajam, tačiau norint paleisti, reikia papildomo kodo fragmento.
Išvada
Nors žymėjimas yra maža ir sąmoningai paprasta specifikacija, pradėti gali būti šiek tiek painu. Geriausias būdas išmokti yra apgauti lapą ir parašyti savo „Markdown“ dokumentą. Galite atnaujinti savo „README“.md „GitHub“, ir jūs galite gauti daug palaikymo iš redaktorių integruotų funkcijų. „GitHub“ taip pat palaiko jaustukus, kuriuos galite pridėti prie savo dokumento. Galite naudoti apgaulės lapą, kad sužinotumėte, kokie jie yra.
Atsisiųskite „Markdown-CheatSheet“ čia
