Phenquestions
Tavahindlus
Markdown on John Gruberi välja töötatud standard. Markdowni peamine eesmärk on võimaldada failil lugeda ka puhta tekstina. Kui soovite vaadata ainult tekstiredaktorisse, peaksite seda lugema lihtsalt. See on vim-i jms kasutajate jaoks väga kasulik. Pange tähele ja pidage meeles, et see on tekstifailide muutmise standard. See ei asenda HTML-i. Selle asemel kasutate seda HTML-i loomiseks seal, kus see on kasulik. GitHubi puhul vormindavad nad saidil Readme-faili. Niikaua kui järgite standardit, võite olla kindel, et see näeb hea välja.
Kuna GitHub on lisanud vaid mõned laiendused, peaksite kõigepealt kasutama Markdowni cheatsheet ja sealt minema. Siin on nimekiri kõige tavalisematest.
| Märgistamine | Laiendused | Tulemus |
| # (1 taseme kohta) | Pealkirjad | |
| * | Kursiiv | |
| ** | Julge | |
| > | Blokeeri pakkumine | |
| 1. (jne.) | Tellitud loend | |
| - | Tellimata loend | |
| "kood" | Teie kood | |
| "" | Md-ext | Koodiploki alustamine ja lõpetamine |
| - | Horisontaalne reegel | |
| [Kirjeldus] (https: // www.näide.com) | Ruudukujuline nimi ja tavalistes sulgudes URL | |
| ![alt tekst] (pilt.png) | Sama, link pildile | |
| [1] | Md-ext | Joonealune märkus |
Loendeid saab pesastada, kui taandate kõik üksused, mille soovite pesastada.
Muud tavalise Markdowni laiendused, teil on ülal koodiblokeeringud. Teenused ei toeta neid alati.
| Märgistamine | Laiendused | Tulemus |
| ### Pealkiri # custom-id | Md-ext | Pealkiri, mille saate aadressiga identifitseerida |
| mõiste: määratlus | Md-ext | Mõistete loetelu koos definitsioonidega |
| ~ Ekslik tekst ~ | Md-ext | Läbikriipsutatud tekst |
| - [x] Ülesanne teha | Md-ext | Ülesannete loend, mille saate märkida |
Tabel on väga lihtne, kuid selle kuvamiseks vajate mitu rida:
| Nimi | VÄÄRTUS| ----------- | ---------- |
| Mats | 100 |
GitHubi laiendused.
GitHub on lisanud mõned laiendused, et muuta teiste inimeste ja projektidega linkide haldamine lihtsamaks. Mõned neist on varem mainitud tabelid. Kõige rohkem aitab teid automaatse lingi laiendus. See loob lingi iseseisvalt, kui kasutate seda GitHubis.
Teised on tabelid ja ülesandeloendi üksused. Need on mugavad projektides oma ülesannete jälgimiseks. Viimasena tuleb mainida HTML-i laiendust Keelatud Raw. Selle laienduse abil filtreeritakse HTML-i renderdamisel mõned sildid. Need sildid võivad GitHubi renderdamisel põhjustada kummalisi efekte.
GitHub Markdowni uurimise viisid
Kui leiate, et see on segane, võite minna ka GitHubi lehele ja kasutada sisseehitatud redaktorit. Kui te seda kasutate, täidab see mõned funktsioonid automaatselt. See töötab ainult probleemide puhul, kuid saate seda kasutada mõne asja selgitamiseks, emoji ilmub loendina, kui sisestate kooloni (:).
GitHubist leiate ka projekti, millel on suurepärase välimusega README-fail, ja kloonige see oma kohalikule kettale. Sealt saate faili uurida mis tahes soovitud redaktoriga. Suurte toimetajate, Emacsi ja Vimi jaoks on laienduste kaudu märgistamise tugi.
Kui kasutate VIM-i, saate GitHubist sisestada süntaksit esile tõstva laiendi, vim-markdown. See laiendus näitab teile, et olete koodi õigesti teinud. Kui soovite vaadata, kuidas see valmis saab, saate ka reaalajas märgi laienduse. Selle abil saate lasta töötada veebiserveril, näidates tulemust otse kirjutamise ajal.
Emacsiga on teil kärsitu režiim, otserežiim ja reaalajas eelvaade. Kõigil kuvatakse sisestamise ajal teie tulemuseks olevat lehte brauseris. Esimene nõuab vähem teeke kui viimane, kuid vajab käivitamiseks täiendavat koodilõiku.
Järeldus
Ehkki markdown on väike ja tahtlikult lihtne spetsifikatsioon, võib sellega alustamine veidi segadust tekitada. Parim viis õppida on kasutada petulehte ja kirjutada oma Markdowni dokument. Saate oma README-i uuendada.md GitHubis ja saate oma redaktorite sisseehitatud funktsioonidest palju tuge. Vahemärkusena toetab GitHub ka emotikone, mille saate oma dokumendile lisada. Petulehe abil saate teada, millised need on.
Laadige alla Markdown-CheatSheet siit
