Phenquestions
Tavallinen Markdown
Markdown on John Gruberin kehittämä standardi. Markdownin päätavoitteena on, että tiedosto voidaan lukea myös puhtaana tekstinä. Jos haluat katsoa vain tekstieditorissa, sinun pitäisi olla helppo lukea sitä. Tämä on erittäin hyödyllistä käyttäjille VIM ja vastaavia. Huomaa ja muista, että tämä on standardi tekstitiedostojen vaihtamiselle. Se ei korvaa HTML-koodia. Sen sijaan luot sen avulla HTML-koodia missä se on hyödyllistä. GitHubin tapauksessa he alustavat Readme-tiedoston sivustolla. Niin kauan kuin noudatat standardia, voit olla varma, että se näyttää hyvältä.
Koska GitHub on lisännyt vain muutaman laajennuksen, sinun on aloitettava käyttämällä Markdown-huijauslehteä ja siirtymällä sieltä. Tässä on luettelo yleisimmistä.
| Markdown | Laajennukset | Tulos |
| # (1 per taso) | Otsikot | |
| * | Kursiivi | |
| ** | Lihavoitu | |
| > | Lohkolainaus | |
| 1. (jne.) | Tilattu luettelo | |
| - | Järjestämätön luettelo | |
| 'koodi' | Koodisi | |
| ” | Md-ext | Aloita ja lopeta koodilohko |
| - | Vaakasuora sääntö | |
| [Kuvaus] (https: // www.esimerkki.com) | Nimi neliössä ja URL sulkeissa | |
| ![alt teksti] (kuva.png) | Sama linkki kuvaan | |
| [1] | Md-ext | Alaviite |
Luettelot voidaan sisäkkäin sisentämällä kaikki kohteet, jotka haluat sijoittaa.
Muut tavallisen Markdown-laajennuksen koodikoodilohkot ovat yllä. Palvelut eivät aina tue niitä.
| Markdown | Laajennukset | Tulos |
| ### Otsikko # custom-id | Md-ext | Otsikko, johon voit kohdistaa tunnuksen |
| termi: määritelmä | Md-ext | Luettelo termeistä ja määritelmistä |
| ~ Virheellinen teksti ~ | Md-ext | Yliviivattu teksti |
| - [x] Tehtävä | Md-ext | Tehtäväluettelo, jonka voit valita |
Taulukko on hyvin yksinkertainen, mutta sen näyttämiseen tarvitaan useita rivejä:
| Nimi | ARVO || ----------- | ---------- |
| Matot | 100 |
GitHub-laajennukset.
GitHub on lisännyt muutaman laajennuksen helpottamaan linkkejä muihin ihmisiin ja projekteihin. Jotkut näistä ovat aiemmin mainittuja taulukoita. Se, joka auttaa sinua eniten, on automaattisen linkityksen laajennus. Se luo linkin itsestään, kun käytät sitä GitHubissa.
Toiset ovat taulukoita ja Tehtäväluettelokohteita. Nämä ovat käteviä seuraamaan tehtäviäsi projekteissa. Viimeinen mainittava on Disallowed Raw HTML -laajennus. Tämän laajennuksen avulla jotkut tunnisteet suodatetaan HTML-mallinnuksessa. Nämä tunnisteet voivat aiheuttaa outoja vaikutuksia, kun ne hahmonnetaan GitHubille.
Tapoja tutustua GitHub Markdowniin
Jos löydät sen hämmentäväksi, voit myös siirtyä GitHub-sivulle ja käyttää sisäänrakennettua editoria. Kun käytät sitä, se suorittaa joitain toimintoja automaattisesti. Tämä toimii vain asioissa, mutta voit käyttää sitä joidenkin asioiden selvittämiseen, emojit tulevat esiin luettelona, kun kirjoitat kaksoispistettä (:).
Löydät myös GitHubista projektin, jolla on upean näköinen README-tiedosto, ja kloonaa se paikalliseen asemaan. Sieltä voit tutkia tiedostoa millä tahansa haluamallasi editorilla. Suurille toimittajille, Emacsille ja Vimille, on tuki merkinnälle laajennusten kautta.
Jos käytät vim-ohjelmaa, voit laittaa syntaksikorostuksen laajennuksen GitHubista, vim-markdown. Tämä laajennus osoittaa, että olet tehnyt koodin oikein. Voit myös saada live-merkkilaajennuksen, jotta näet, miltä se näyttää, kun se on valmis. Tämän avulla sinulla voi olla verkkopalvelin käynnissä, ja tulos näkyy suorana kirjoittaessasi.
Emacsilla sinulla on kärsimätön tila, live-tilassa-tila ja reaaliaikainen esikatselu. Ne kaikki näyttävät tuloksena olevan sivusi selaimessa kirjoittaessasi. Ensimmäinen vaatii vähemmän kirjastoja kuin jälkimmäinen, mutta sen suorittamiseen tarvitaan ylimääräinen koodinpätkä.
Johtopäätös
Vaikka markdown on pieni ja tarkoituksella yksinkertainen eritelmä, aloittaminen voi olla hieman hämmentävää. Paras tapa oppia on käyttää huijausarkkia ja kirjoittaa Markdown-asiakirja. Voit päivittää README-tiedostosi.md GitHubissa, ja voit saada paljon tukea toimittajien sisäänrakennetuista toiminnoista. Sivuhuomautuksena GitHub tukee myös emojeja, jotka voit lisätä asiakirjaan. Voit käyttää huijausarkkia löytääksesi ne.
Lataa Markdown-CheatSheet Here
