Phenquestions
Standarta Markdown
Markdown ir Džona Grūbera izstrādāts standarts. Galvenais mērķis ar Markdown ir padarīt failu iespējams lasīt pat tīrā tekstā. Ja vēlaties apskatīt tikai teksta redaktoru, jums to vajadzētu viegli izlasīt. Tas ir ļoti noderīgi vim un līdzīgu lietotāju lietotājiem. Ņemiet vērā un atcerieties, ka tas ir teksta failu maiņas standarts. Tas neaizstāj HTML. Tā vietā jūs to izmantojat, lai izveidotu HTML, kur tas ir noderīgi. GitHub gadījumā viņi vietnē formatēs Readme failu. Kamēr jūs ievērosiet standartu, varat būt drošs, ka tas izskatīsies labi.
Tā kā GitHub ir pievienojis tikai dažus paplašinājumus, jums vajadzētu sākt, izmantojot Markdown krāpniecības lapu un doties no turienes. Šeit ir saraksts ar visbiežāk sastopamajiem.
| Atlaide | Pagarinājumi | Rezultāts |
| # (1 katrā līmenī) | Virsraksti | |
| * | Kursīvs | |
| ** | Bold | |
| > | Blokāts | |
| 1. (utt.) | Pasūtīto saraksts | |
| - | Nekārtots saraksts | |
| 'kods' | Jūsu kods | |
| "" | Md-ext | Sāciet un beidziet kodu bloku |
| - | Horizontālais noteikums | |
| [Apraksts] (https: // www.piemērs.com) | Vārds kvadrātā un URL iekavās | |
| ![alt teksts] (attēls.png) | Tas pats, saite uz attēlu | |
| [1] | Md-ext | Zemsvītras piezīme |
Sarakstus var ligzdot, ievilkot visus vienumus, kurus vēlaties ligzdot.
Citi parastā Markdown paplašinājumi, iepriekš kods ir bloķējis paplašinājumus. Pakalpojumi tos ne vienmēr atbalsta.
| Atlaide | Pagarinājumi | Rezultāts |
| ### Virsraksts # custom-id | Md-ext | Virsraksts, kuru varat adresēt pēc tā ID |
| termins: definīcija | Md-ext | Terminu saraksts ar definīcijām |
| ~ Kļūdains teksts ~ | Md-ext | Teksts ar pārsvītrojumu |
| - [x] Uzdevums | Md-ext | Uzdevumu saraksts, kuru varat atzīmēt |
Tabula ir ļoti vienkārša, taču tās parādīšanai nepieciešamas vairākas rindas:
| Nosaukums | VĒRTĪBA || ----------- | ---------- |
| Mats | 100 |
GitHub paplašinājumi.
GitHub ir pievienojis dažus paplašinājumus, lai vienkāršotu saites ar citiem cilvēkiem un projektiem apstrādi. Dažas no tām ir iepriekš minētās tabulas. Visvairāk jums palīdzēs automātiskās saites paplašinājums. Izmantojot saiti GitHub, tā pati izveido saiti.
Citi ir tabulas un uzdevumu saraksta vienumi. Tie ir ērti, lai sekotu līdzi jūsu uzdevumiem projektos. Pēdējais, kas jāpiemin, ir neatļauts neapstrādāts HTML paplašinājums. Izmantojot šo paplašinājumu, renderējot HTML, daži tagi tiek filtrēti. Šie tagi var radīt dīvainus efektus, renderējot GitHub.
Veidi, kā izpētīt GitHub Markdown
Ja jums tas šķiet mulsinoši, varat arī doties uz GitHub lapu un izmantot iebūvēto redaktoru. Kad jūs to izmantojat, tas automātiski pabeigs dažas funkcijas. Tas darbojas tikai jautājumos, taču jūs varat to izmantot, lai noskaidrotu dažas lietas. Emojis parādās kā saraksts, rakstot kolu (:).
GitHub vietnē var atrast arī projektu, kuram ir lielisks README fails, un klonēt to vietējā diskā. No turienes jūs varat izpētīt failu, izmantojot jebkuru vēlamo redaktoru. Lielajiem redaktoriem - Emacs un Vim - tiek atbalstīts marķējums, izmantojot paplašinājumus.
Ja izmantojat vim, varat ievietot sintakses izcelšanas paplašinājumu no GitHub, vim-markdown. Šis paplašinājums parāda, ka kods ir izdarīts pareizi. Lai palīdzētu jums redzēt, kā tas izskatās, kad esat pabeidzis, varat arī iegūt tiešās atzīmes paplašinājumu. Izmantojot šo, jūs varat palaist tīmekļa serveri, parādot rezultātu tiešraidē, kamēr rakstāt.
Izmantojot Emacs, jums ir nepacietīgs režīms, tiešraides režīms un reāllaika priekšskatījums. Rakstīšanas laikā tie visi parāda jūsu iegūto lapu pārlūkprogrammā. Pirmajam ir nepieciešams mazāk bibliotēku nekā otrajam, taču tā darbībai nepieciešams papildu koda fragments.
Secinājums
Pat ja iezīmēšana ir maza un apzināti vienkārša specifikācija, sākt var būt nedaudz mulsinoši. Labākais veids, kā mācīties, ir izmantot krāpšanās lapu un uzrakstīt savu Markdown dokumentu. Varat atjaunināt README.md vietnē GitHub, un jūs varat saņemt lielu atbalstu no redaktoru iebūvētajām funkcijām. Kā blakus piezīmi, GitHub atbalsta arī emocijzīmes, kuras varat pievienot savam dokumentam. Jūs varat izmantot apkrāptu lapu, lai atrastu, kuras tās ir.
Lejupielādējiet Markdown-CheatSheet šeit
