Indlela yokusebenzisa iMarkdown ngokushesha ku-GitHub naku-Reddit

Informatec Digital » Izinsiza » Indlela yokusebenzisa iMarkdown ngokushesha ku-GitHub naku-Reddit

Uma ubhala njalo ku-GitHub noma uchitha isikhathi esiningi ku-Reddit, ubhala kahle Ukuphawula Kungenye yezinto ezikongela amahora futhi zenze impilo yakho ibe lula. Lulimi olulula kakhulu olukuvumela ukuthi uhlele umbhalo ocacile ngokushesha, ngaphandle kokubhekana namamenyu noma izinkinobho, ngezimpawu ezimbalwa ezibekwe ezindaweni ezifanele.

Ku-GitHub uzokuthola yonke indawo: kumafayela README.md kusuka ezindaweni zokugcina, izinkinga, izicelo zokudonsa, izingxoxo, ngisho nephrofayela yakho. I-Reddit, yona, isebenzisa uhlobo olubizwa ngokuthi i-Snoomark (i-Reddit-style Markdown) oluthatha ingxenye enkulu ye-syntax ye-GitHub, olunezici ezithile ezihlukile kanye nemikhawulo ethile. Ake sibone, isinyathelo ngesinyathelo kanye nezibonelo eziningi, Indlela yokusebenzisa iMarkdown ngokushesha ku-GitHub naku-Reddit futhi ngaphandle kokushiya lutho olubalulekile.

Iyini iMarkdown futhi kungani iwusizo kangaka ku-GitHub naku-Reddit?

I-Markdown yi-a Ulimi lwemakhaphu olulula Yakhelwe ukwenza umbhalo ocacile ube lula ukuwufunda nokuwubhala, kuyilapho futhi ivumela ukuguqulwa okulula kube yi-HTML. Empeleni, lokhu kusho ukuthi ungabhala umbhalo ojwayelekile bese wengeza izinhlamvu ezikhethekile ukuze udale izihloko, uhlu, amathebula, izingcaphuno, ikhodi efomethiwe, izixhumanisi, noma izithombe.

Ku-GitHub, ukusetshenziswa okusetshenzisiwe yi-GitHub Flavored Markdown (GFM), eyandisa i-syntax yakudala ngamathebula, uhlu lwezinto okufanele zenziwe, ukugqamisa ikhodi ethuthukisiwe, ukwesekwa kombala, izexwayiso, kanye namanye amathegi e-HTML avunyelwe. Konke lokhu kwenziwa ngokuzenzakalelayo kumafayela e-.md kanye nasemasimini okuphawula epulatifomu.

I-Reddit isebenzisa iprosesa yayo ebizwa ngokuthi i-Snoomark, okususelwa ku-GFM. Ihlanganyela okuningi kokuziphatha okuyisisekelo (okugqamile, okuluhlane, izihloko, uhlu, izingcaphuno, ikhodi esemgqeni noma yebhulokhi, izixhumanisi, njll.), kodwa inayo izici ezibalulekileIsibonelo, ukwesekwa kwesithombe kunqunyelwe kakhulu kuye ngomongo futhi kunezela izakhi zalo njengezipoli.

Ubuhle bakho konke lokhu ukuthi, nge-syntax eyodwa, ungabhala imibhalo ebukeka kahle ku-GitHub naku-Reddit, uvumelanise imininingwane embalwa kuphela lapho ipulatifomu ngayinye isebenza ngendlela ehlukile. Funda imithetho eyisisekelo Ikuvumela ukuthi uhambe ngokukhululeka kuzo zombili ngaphandle kokufunda kabusha noma yini kusukela ekuqaleni.

Izihloko kanye nesakhiwo sokuqukethwe

Enye yezinto zokuqala ozoyisebenzisa yi- izihlokoKokubili ku-GitHub kanye ne-Reddit, zisetshenziselwa ukuhlela umbhalo ube yizigaba nezigatshana.

Ku-Markdown, isihloko sidalwa ngokulandela umbhalo onezimpawu ze-hash eyodwa kuya kweziyisithupha: esisodwa sesihloko sezinga 1, ezimbili zezinga 2, njalonjalo kuze kufike ezingeni 6. Isibonelo, kufayela le-GitHub README.md ungase ube nokuthile okufana nalokhu: # Isihloko esiyinhloko, ## Ingxenye, ### Isigaba Esingaphansi, Njll

Uma i-GitHub ithola izihloko ezimbili noma ngaphezulu kufayela, ikhiqiza ngokuzenzakalelayo i- ithebula lokuqukethwe Kufinyeleleka kusuka kusithonjana esithi "Uhlaka" phezulu kwefayela. Isihloko ngasinye sivela njengesixhumanisi esikuyisa ngqo kuleso sigaba, okuyinto enhle kakhulu kumadokhumenti amade.

Ngaphezu kwalokho, isihloko ngasinye siba yi-anchor yangaphakathi ongayixhumanisa ne-snippet ye-URL ngokusekelwe kumbhalo wesihloko. Ukuze ikhiqize leso snippet, i-GitHub isebenzisa imithetho eqondile kakhulu: iguqula izinhlamvu zibe izinhlamvu ezincane, ifaka ama-hyphen esikhundleni sezikhala, isusa izimpawu zokubhala nokufometha izinhlamvu (ezifana no-italics), inciphisa izikhala ezengeziwe, futhi, uma umphumela ufana nesinye isihloko sangaphambilini, engeza isijobelelo sezinombolo (-1, -2, njll.) ukuze kube yinto ehlukile.

Lokhu kukuvumela ukuthi wenze izinto ezifana nokubeka isigaba ## Isigaba Sesampula bese uyixhumanisa kusuka kwelinye iphuzu kudokhumenti ngesixhumanisi esinjengalesi: (#isigaba-sesampula)noma ngisho nokuxhumanisa nezigaba ezinezinhlamvu ezikhethekile esihlokweni, njengoba i-GitHub ikhiqiza isiqephu esilandela leyo mithetho futhi isenza sitholakale ngephethini efanayo.

Ukugcizelela, umbhalo ogqanyisiwe, kanye nezingcaphuno

I-Markdown ikuvumela ukuthi ugqamise umbhalo usebenzisa izindlela ezahlukahlukene ukugcizelelaOkugqamile, omalukeke, okudwetshwe ngentambo, okubhalwe nge-subscript, okubhalwe nge-superscript, noma okudwetshwe ngentambo. Ku-GitHub, ithebula lesitayela elijwayelekile lingabukeka kanje, yize silifingqe lapha ngamagama ahlukene:

Ukufaka umbhalo ngesibindiUmbhalo ogqamile ufakwe kuma-asterisk amabili noma ama-double underscore; kuma-italic, kusetshenziswa ama-asterisk angawodwa noma ama-underscore; ukuze kudwetshwe into ethile, kubekwa i-double tilde (ama-tilde amabili) kuzo zombili izinhlangothi zombhalo. Okugqamile okunama-netic kanye nama-italic angahlanganiswa, ama-asterisk amathathu angasetshenziswa ukufaka kokubili engxenyeni yonke yombhalo, noma amathegi e-HTML afana ne-<br> angasetshenziswa. _{y ^{kokubhaliselwe kanye nokubhalwe ngaphezulu, kanye ukuze kugcizelelwe.}}

I-GitHub ikuvumela futhi ukuthi udale izingcaphuno zesitayela se-blockquote Ngokubeka uphawu olukhulu kune-(>) ekuqaleni komugqa, umbhalo ocashuniwe uboniswa ngebha eqondile ngakwesobunxele nangombala ompunga, okwenza ubonakale ngokucacile. Imigqa eminingi ingafakwa ngaphakathi kwebhulokhi efanayo yesilinganiso, futhi izingcaphuno zingafakwa ngisho nangokufaka ezinye izimpawu > ekuqaleni.

Uhlobo oluthuthukisiwe lokucaphuna olutholakala ku-GitHub kuphela yi- izexwayiso noma izixwayisoZisekelwe ku-syntax efanayo ye-blockquote, kodwa umugqa wokuqala uhlanganisa uphawu olukhethekile lokubonisa uhlobo lwesexwayiso. Isibonelo, ungacacisa i-`<alert>` ukuze uthole ulwazi oluwusizo, i-`<helpful tips>` ukuze uthole iseluleko esiwusizo, i-`<key data>` yedatha eyinhloko, i-`<urgent notices>` yezixwayiso eziphuthumayo, kanye ne-`<alert>` yezixwayiso zezingozi noma imiphumela emibi. I-GitHub ibonisa uhlobo ngalunye ngombala ohlukile kanye nesithonjana, okusiza ukugqamisa ulwazi olubalulekile kumadokhumenti.

I-Reddit iphinde isekele izingcaphuno ezilula ezinesimboli esifanayo >, yize ingenayo isistimu yokuxwayisa ecebile ye-GitHub. Noma kunjalo, isalokhu iyindlela ewusizo kakhulu yokwenza ukuphendula othile ngokucaphuna ingxenye yomyalezo wakhe ngaphandle kokukuphinda ngokuphelele.

Ukugqamisa ikhodi, amabhlogo, nemibala

Kokubili i-GitHub ne-Reddit zikuvumela ukuthi ugqamise izingcezu zekhodi ngaphakathi kombhalo usebenzisa ama-backtick. Ngekhodi esemgqeni, ufaka igama noma umyalo nge-backtick eyodwa ohlangothini ngalunye. Lokhu kulungele ukugqamisa, isibonelo, i- isib isimo ngaphakathi komusho, okwenza kucace ukuthi kungumyalo.

Uma ufuna ibhulokhi yekhodi ezimele, iMarkdown isebenzisa ama-backtick amathathu: ubhala umugqa one-backtick ezintathu, bese ubhala ikhodi emigqeni ehlukile, bese uvala ngamanye ama-backtick amathathu. Ku-GitHub, uma ucacisa nolimi ngemuva nje kwe-backtick yokuqala, kuyasebenza... ukugqamisa kwe-syntax ngemibala kanye nefomethi ethile kulolo limi.

I-GitHub iphinde inikeze isici esithile sokugqamisa amanani ombala ngaphakathi kwama-backtick. Uma ubhala umbala ngefomethi ye-hexadecimal, i-RGB, noma i-HSL phakathi kwama-backtick, ipulatifomu ifaka inkomba yombala encane eduze kombhalo. Isibonelo, uma ingemuva kwimodi yokukhanya lingu-#ffffff futhi kwimodi emnyama lingu-#000000, ukugqamisa lawa makhodi kukuvumela ukuthi ubone ngokushesha ukuthi yiliphi.

Ngokuphathelene nokuboniswa kwekhodi kanye nethebula, i-GitHub ikuvumela ukuthi unike amandla ifonti yesikhala esisodwa esihleliwe kuzo zonke izinkambu zokuphawula ukuze wenze ukusebenza ngombhalo wezobuchwepheshe kube lula kakhulu. Uma uhlela izingcezu eziningi zekhodi kusiphequluli sakho noma kubahleli abafana no- I-Visual Studio CodeUkunika amandla le nketho kwenza ukuqondanisa nokufunda kube lula. kuvumelana kakhulu.

I-Reddit iphinde isekele amabhlogo ekhodi anama-backtick, kokubili angaphakathi kanye nama-block, yize ukusetshenziswa kwawo lapho kugxile kakhulu ezingcezwini ezincane noma i-pseudocode kunasezincwadini ezinde ezifana nezendawo yokugcina izinto.

Izixhumanisi, ama-anchor, kanye nokuzulazula kwangaphakathi

Ukudala izixhumanisi ku-Markdown kulula kakhulu: ufaka umbhalo ozoboniswa kumsebenzisi ngama-brackets asikwele kanye ne-URL kuma-brackets. Lokhu kusebenza kokubili ku-GitHub kanye ne-Reddit, futhi kungathuthukiswa ngezinqamuleli zekhibhodi ku-GitHub (isibonelo, ukusebenzisa izinhlanganisela zezihluthulelo ukuguqula ngokushesha umbhalo okhethiwe ube yisixhumanisi).

I-GitHub ingeza ezinye izici ezengeziwe ezihlobene nokuzulazula. Okokuqala, ivumela isixhumanisi ngqo ezihlokweni kusetshenziswa imithetho yokukhiqiza izingcezu okuxoxwe ngazo ngaphambili. Ngaphezu kwalokho, isekela izixhumanisi ezihlobene ngaphakathi kwendawo yokugcina izinto ngokwayo, okubalulekile kumadokhumenti obuchwepheshe.

Isixhumanisi esihlobene yilesi esibalwa kusetshenziswa ifayela lamanje njengereferensi. Isibonelo, uma i-README yakho isempandeni yephrojekthi futhi ufuna ukuxhumanisa nefayela i-docs/CONTRIBUTING.md, umane ubhale isixhumanisi ngendlela i-docs/CONTRIBUTING.md. I-GitHub iphatha ukuhumusha lesi sixhumanisi esihlobene ngendlela efanele kunoma yiliphi igatsha okulo, ivimbele ukuthi siphuke lapho ushintsha amagatsha noma uhlanganisa indawo yokugcina.

Isincomo ukuthi uhlale usebenzisa izindlela ezihambisanayo Ukuze uzulazule phakathi kwamafayela ngaphakathi kwendawo yokugcina efanayo, ngoba izixhumanisi eziphelele zingase ziyeke ukusebenza kuma-clones noma amafoloko, i-GitHub ivumela ukusetshenziswa kwama-opharetha ajwayelekile njenge-./ noma i-../ kanye nezindlela eziqala ngo-/ maqondana nomsuka wephrojekthi.

Uma ufuna ukudala amaphuzu okunamathisela ngokwezifiso ngaphakathi kwedokhumenti ngale kwezihloko, ungasebenzisa amathegi e-HTML anesici esithi `igama`. Lokhu kukuvumela ukuthi ubeke iphuzu eliqondiwe phakathi kwesigaba noma eduze kombhalo ongenaso isihloko sawo, bese uxhumanisa kuwo usebenzisa i-syntax efanayo neyezihloko ezikhiqizwe ngokuzenzakalelayo.

Izithombe ku-GitHub: I-Markdown, i-HTML, kanye nezindlela ezihlobene

Ku-GitHub, izithombe ngokuvamile zifakwa kusetshenziswa i-syntax efanayo nezixhumanisi, kodwa zandulelwa uphawu lokubabaza. Umbhalo ohlukile (alt) ucacisiwe ngaphakathi kwabakaki abayisikwele, futhi i-URL noma indlela eya esithombeni ifakwa ngaphakathi kwabakaki. Lo mbhalo ohlukile ubalulekile ku- ukufinyelelekangoba yilokho abafundi besikrini abazokufunda nokuthi yini ezoboniswa uma isithombe singalayishi.

Izithombe zingavela kumafayela angaphakathi kwesitoreji ngokwaso noma kuma-URL angaphandle. I-GitHub ivumela amaphethini amaningi ezindlela ezihlobene zokulayisha izithombe ezivela emagatsheni ahlukene, kwezinye izindawo zokugcina, noma ngisho nezinkinga namazwana, kusetshenziswa izijobelelo ezifana nokuthi ?okuluhlaza=okuyiqiniso ukuphoqa ukulanda ifayela ngqo uma kudingeka.

Ngaphezu kwe-syntax ejwayelekile ye-Markdown, i-GitHub isekela ukusetshenziswa kwesici se-HTML Le nto iwusizo kakhulu ekushajeni izithombe ezisabelayo Lokhu kuyashintsha ngokuya ngezintandokazi zetimu zomsebenzisi (ukukhanya noma ubumnyama). Usebenzisa umbuzo wemidiya othi `prefers-color-scheme`, ungachaza imithombo yezithombe ehlukene yemodi ngayinye, kanye nesithombe esizenzakalelayo seziphequluli ezingasisekeli lesi sici.

Iphethini evamile ihilela ukufaka ngaphakathi izakhi eziningana ngezimpawu zayo zemidiya kanye ne-srcset, futhi ekugcineni Besebenzisa isici se-alt kanye ne-URL ejwayelekile, abasebenzisi abakwimodi emnyama babona isithombe esilungisiwe, kuyilapho labo abakwimodi yokukhanya bethola esehlukile, ngaphandle kokukopisha okuqukethwe ku-README.

I-GitHub iphinde isekele amazwana e-HTML kumafayela e-Markdown, okuvumela ukuthi wengeze izikhumbuzi ezingabonakali kumfundi, isibonelo ukumkhumbuza ukuthi abuyekeze isigaba sesithombe noma engeze izibonelo ezintsha kamuva.

Amathebula, izingxenye ezigoqwayo, kanye nokuhlukaniswa kokuqukethwe

Enye yezinguquko eziwusizo kakhulu ku-GitHub Flavored Markdown ukusekela kwayo amatafulaUngahlela idatha ibe yimigqa namakholomu usebenzisa imigoqo eqondile ukuze uhlukanise amaseli kanye nomugqa onamadeshi ukuze umake inhloko. Ungaphinda uhlele amakholomu ngakwesokudla, kwesobunxele, noma phakathi nendawo usebenzisa ikholoni emgqeni wokuhlukanisa.

Amathebula awusizo kakhulu ekwethuleni uhlu lwezilimi zokuhlela, izinhlaka ezisetshenzisiwe, imisebenzi ehleliwe, ukuqhathanisa izici, noma olunye ulwazi oluzuza esakhiweni se-matrix. I-GitHub yenza la mathebula abe nesitayela esihlanzekile nesifundekayo.

Ukuze ugcine ifayela elide le-README lihlelekile, ungasebenzisa ithegi ye-HTML ukudala izigaba ezigoqekayo. Lezi zigaba zibonisa isifinyezo ngaphakathi kwelebula futhi uvumele umsebenzisi ukuthi andise noma anciphise okuqukethwe okwengeziwe njengoba kudingeka. Kuvamile ukufaka amathebula noma amabhlogo olwazi lwesibili ngaphakathi ukugwema ukukhungathekisa iso.

Uma ufuna isigaba sibonakale sandisiwe ngokuzenzakalelayo, mane nje ungeze isici esivulekile ku Le ndlela iwusizo kakhulu ekuhlukaniseni amazinga, uhlu olude, noma okuqukethwe okungabalulekile ekufundeni kokuqala kodwa okulula ukukuthola kalula.

Elinye ithuluzi elilula lokuhlela ulwazi umthetho ovundlile. Udalwa ngokubhala amadeshi amathathu noma ngaphezulu emgqeni futhi usebenzela ukudweba umugqa ohlukanisayo phakathi kwezigaba, okukuvumela ukuthi uhlukanise ngokucacile, isibonelo, isigaba esichazayo esigabeni sezinkomba noma amanothi engeziwe.

Le mithetho ingahlanganiswa nezingcaphuno zokuphela kwedokhumenti ukuze kugqanyiswe imishwana ekhuthazayo, izikhumbuzo, noma imiyalezo ebalulekile. Isibonelo esijwayelekile kungaba ukubeka isisho esikhuthazayo ekugcineni kwephrofayela yakho ethi README, esifomethwe ngesisho esivimbayo ngemuva komugqa wokuhlukanisa.

Amazwana afihliwe kanye nokulawula ifomethi

I-GitHub ikuvumela ukuthi wethule Amazwana e-HTML ngaphakathi kweMarkdown kusetshenziswa i-syntax Noma yini oyifaka kulowo mazwana ngeke iboniswe kokuqukethwe okuhunyushiwe, kodwa izobonakala kukhodi yomthombo, ngakho-ke ilungele amanothi angaphakathi noma okufanele kwenziwe.

Isibonelo, kuphrofayela ethi README ungangeza amazwana asho okuthile okufana nokuthi udinga ukwandisa isigaba esithi "Mayelana nami" kamuva noma ukuthi udinga ukubuyekeza ithebula lobuchwepheshe obuphelelwe yisikhathi, ngaphandle kokuthi noma ubani ovakashela iphrofayela akubone ngqo.

Omunye umsebenzi owusizo yilowo we izinhlamvu zokuphunyuka okuvame ukuhunyushwa ngokuthi i-Markdown. Uma udinga ukubonisa ama-asterisk, izimpawu ze-hash, noma ezinye izimpawu ngokoqobo ngaphandle kokuthi zifomethwe, mane nje ulandelele ngayinye nge-backslash. Lokhu kukuvumela, isibonelo, ukuthi ubhale izinkulumo ezifaka izimpawu zohlu ngaphandle kokuziguqula zibe uhlu lwangempela.

Uma ubuka ifayela le-markup ku-GitHub, unenketho yokushintsha phakathi kokubuka okuhunyushiwe kanye nekhodi yomthombo ngenkinobho phezulu (noma uyivule kubahleli abafana AbakakiUkukhubaza ukuhumusha kwe-Markdown kukuvumela ukuthi ufinyelele izici ezijwayelekile zokubuka ikhodi ezifana imigqa ethile yesixhumanisiLokhu kuwusizo kakhulu uma ufuna ukukhomba ingxenye eqondile ye-README noma yiliphi ifayela le-.md.

Okokugcina, khumbula ukuthi i-GitHub isingatha ukuhlukana kwemigqa ngendlela ehlukile kumazwana (izinkinga, ama-PR, njll.) kanye nakumafayela e-.md. Kumazwana, ukuhlukana kwemigqa kuyahlonishwa ngqo, kuyilapho kumafayela e-Markdown udinga ukwengeza izikhala ezimbili ekugcineni komugqa, i-backslash, noma i-period. ukuphoqa ukugxuma ngaphakathi kwesigaba esifanayo.

Uhlu, uhlu oluhlanganisiwe, kanye nohlu lwezinto okufanele zenziwe

Uhlu lungenye yezinto ezisetshenziswa kakhulu ku-Markdown, kokubili ku-GitHub kanye ne-Reddit. Ungakha uhlu okungahlelekile ngokubeka uphawu lwe-hyphen, i-asterisk, noma uphawu lwe-plus ngaphambi kwento ngayinye yohlu. Wonke lawa maki abhalwe ngendlela efanayo namaphuzu ezinhlamvu.

Ukukhiqiza uhlu iyaleUmugqa ngamunye ufakwe inombolo enenombolo elandelwa ungqimba nesikhala. Nakuba ukuhleleka kwezinombolo kungadingeki kube okuphelele (i-GitHub ivame ukuyibala kabusha), kungumqondo omuhle ukugcina izinombolo ezihambisanayo ukuze ikhodi yomthombo ifundeke.

Uhlu oluhlanganisiwe ludalwa ngokumane ungeze ukujiya ezintweni ezingezansi kwazo. Ku-monospaced editors like Umbhalo ophansiMane nje uvumelanise omaka bohlu olufakwe ngaphakathi ngokubonakalayo ngaphansi kohlamvu lokuqala lombhalo ku-element yomzali. Ezimweni ezifana nomhleli wokuphawula we-GitHub, lapho ifonti ingenasikhala esisodwa, bala inani lezinhlamvu ngaphambi kombhalo bese usebenzisa lelo nani lezikhala ukuze u-indentation.

Ungakha futhi amazinga amaningi okwakha izidleke, inqobo nje uma ugcina ukuhambisana kwenani lezikhala. Kuhlu oluyinkimbinkimbi kakhulu, lolu hlelo ludinga ukuzijwayeza kancane, kodwa uma usulutholile, luyashesha kakhulu ukulusebenzisa.

I-GitHub iphinde inikeze uhlu lwezinto okufanele zenziweLokhu kuwusizo kakhulu ezinkingeni, izicelo zokudonsa, kanye namadokhumenti. Kudalwa ngokwandulela i-hyphen, isikhala, kanye nama-brackets amabili anesikhala noma u-"x" ngaphakathi: emisebenzini elindile kanye nemisebenzi eqediwe. Lezi zinhlu zenziwe ngamabhokisi okuhlola angahlolwa noma angahlolwa kusuka ku-interface.

Uma umbhalo wento yohlu lwezinto okufanele zenziwe uqala ngama-partheses, kumele uphunyuke nge-backslash ukuze ugweme ukudideka ku-parser. Kuyinto encane, kodwa ibalulekile lapho ubhala izincazelo eziqala ngokuthile okufana nokuthi "(Ongakukhetha)" noma okufanayo.

Ukukhulunywa ngakho, izinkomba, kanye nama-emoji ku-GitHub

Enye yezinzuzo zokubhala ku-Markdown ku-GitHub ukukwazi ukusebenzisa izikhombisi Imiyalezo eqondile kubasebenzisi kanye namaqembu asepulatifomu. Mane nje uthayiphe u-@ kulandelwe igama lomsebenzisi noma igama leqembu, bese i-GitHub izothumela isaziso kuleyo akhawunti, idonsele ukunaka kwabo engxoxweni.

Uma uthayipha uphawu lwe-@, i-GitHub ibonisa uhlu lwabasebenzisi namaqembu ahlobene nendawo yokugcina noma intambo, futhi ungahlunga lolu hlu njengoba uthayipha. Sebenzisa okhiye bemicibisholo bese ucindezela u-Enter noma u-Tab ukuze wamukele iziphakamiso. Kumaqembu, sebenzisa ifomethi ethi @organization/team-name, futhi wonke amalungu eqembu azobhalisela intambo.

Ngaphezu kokukhulunywa ngakho, i-GitHub iyasiza izinkinga zokubhekisela kanye nezicelo zokudonsa Mane nje uthayiphe u-# ulandelwe inombolo noma ingxenye yesihloko. Uhlu lwemiphumela ephakanyisiwe luzovela, ongayiqedela ngendlela efanayo naleyo eshiwo ngayo. Lokhu kusheshisa kakhulu ukuzulazula phakathi kwezingxoxo ezihlobene.

Uma indawo yakho yokugcina inezinkomba ezixhunywe ngokuzenzakalela ezilungiselelwe, amanothi athile angaphandle (njenge-JIRA noma ama-ID ethikithi le-Zendesk) nawo angaguqulwa ngokuzenzakalelayo abe izixhumanisi ezimfushane. Lokhu kulungiselelwa kudinga amalungelo okuphatha, kodwa uma sekuvunyelwe, kuvumela ukwabelana ngedatha yesistimu yonke ngomzamo omncane.

Ekugcineni, i-GitHub isekela ama-emoji ngekhodi: thayipha ikholoni, kulandelwe igama le-emoji, bese uphetha ngenye ikholoni. Njengoba uqala ukuthayipha, kuvela uhlu lweziphakamiso, ongazamukela nge-Tab noma i-Enter. Ukufaka ama-emoji kumazwana akho kusiza ukuwanikeza ukuthinta komuntu, inqobo nje uma ungawasebenzisi ngokweqile kumadokhumenti asemthethweni.

Imibhalo yaphansi nokuqukethwe okuthuthukisiwe

I-GitHub nayo iyasekela Imibhalo yaphansi Usebenzisa i-syntax esekelwe ku-bracket kanye nesihlonzi esinohlamvu oluhlanganisiwe. Endaweni lapho ufuna khona ireferensi, ufaka into efana ne-, bese ekugcineni kwedokhumenti uchaza umbhalo walelo nothi ngethegi efanayo, kulandelwe yikholoni kanye nokuqukethwe.

Imibhalo yaphansi ingahlanganisa imigqa eminingi, futhi ukuze kuphoqwe ukuhlukana kwemigqa ngaphakathi kwemibhalo yaphansi, kusetshenziswa izikhala ezimbili ekugcineni komugqa, njengasemzimbeni oyinhloko we-Markdown. Lapho kuboniswa, i-GitHub ibonisa umbhalo ongenhla embhalweni kanye nohlu lwemibhalo yaphansi ekugcineni, enezixhumanisi zangemuva zokuhamba phakathi kwezinkomba kanye nemibhalo yaphansi.

Esinye isici esithuthukisiwe esinikezwa yiGitHub... izexwayiso Lezi sezixoxiwe kakade (QAPHELA, ICEBISO, KUBALULEKILE, ISEXWAYISO, kanye NESIXWAYISO). Kunconywa ukuzisebenzisa kuphela uma kudingeka ngempela futhi ugweme ukuhlanganisa eziningi kakhulu ukuze uvimbele ukukhungathekisa umfundi. Azikwazi ukufukanyelwa kwezinye izinto eziyinkimbinkimbi, ngakho-ke ukuhlela ngokucophelela indawo yazo kubalulekile.

Okokugcina, ungacela i-GitHub ukuthi ifihle okwesikhashana izingxenye ze-Markdown ezihunyushwe ngokuzisonga ngamazwana e-HTML, noma ukunganaki ukucutshungulwa kwezinhlamvu ezithile nge-backslashes. Lokhu kuwusizo ikakhulukazi uma ubhala phansi I-syntax kaMarkdown uqobo Futhi udinga ukukhombisa izibonelo njengoba zinjalo, ngaphandle kokuchazwa.

I-Markdown ku-Reddit: Imodi ye-Snoomark neyokuhlela

I-Reddit iyipulatifomu yokuxoxisana lapho cishe noma yisiphi isihloko samukelekile, sihlelwe ngama-subreddits. Ngokuphathelene nokufometha, inikeza abahleli ababili: oyedwa wombhalo ocebile obonakala kakhulu, kanti omunye wombhalo ocacile osekelwe ku-Markdown. Uma ufuna ukusebenza ngokushesha futhi ube nokulawula okuhle komphumela, kuzodingeka usebenzise inketho ye-Markdown.

Ngokuzenzakalelayo, i-Reddit ivame ukusebenzisa umhleli wombhalo ocebile, ngakho-ke ukuze ushintshele kumodi yokumaka kufanele uchofoze inketho Imodi yokubeka phansi ngaphakathi kwebhokisi lombhalo leposi noma ukuphawula. Ukusuka lapho, ungasebenzisa i-syntax ye-Snoomark ngqo.

Uma ukhetha ukuthi umhleli we-Markdown uhlale elayisha, kufanele uye kuzilungiselelo zomsebenzisi, ufake isigaba sezilungiselelo zokuphakelayo, bese usebenzisa inketho Okuzenzakalelayo ku-markdownNgale ndlela, njalo uma uqala ukubhala okuthunyelwe noma ukuphawula, umhleli we-Markdown uzovula ngokuzenzakalelayo ngaphandle kokuthi ushintshe ngesandla.

I-Reddit isekela izici eziningi eziyisisekelo nezithuthukisiwe ze-Markdown: izihloko, ezigqamile nezingama-italic, uhlu, izingcaphuno, amabhlogo ekhodi, izixhumanisi, kanye nezinye zezinto zayo ezengeziwe njenge-spoilers. Kodwa-ke, inamaphutha amakhulu uma kuqhathaniswa ne-GitHub, ikakhulukazi ku- ukuphatha izithombeokuncike kakhulu kumongo kanye nohlobo lomhleli.

I-Syntax isekelwa yi-Reddit kanye nama-spoiler

Uhlobo lwe-Snoomark olusetshenziswa yi-Reddit luhlanganisa izinto eziningi ezifanayo ne-GitHub, ngakho-ke uma usuvele unekhono ku-Markdown ezindaweni zokugcina, ukudlulisela lolo lwazi endaweni ye-Reddit kulula kakhulu. Ungasebenzisa izihloko ukuhlela okuthunyelwe okude, uhlu olunezinombolo noma olunezinhlamvu, izingcaphuno zokuphendula abanye abasebenzisi, kanye namabhulokhi ekhodi uma ufuna ukubonisa imiyalo noma izingcezu zobuchwepheshe.

Omunye wemibono ephawulekayo yindlela iReddit ephatha ngayo izithombeNakuba ezimweni eziningi izithombe zilayishwa nge-interface yesithombe hhayi ngokuqondile nge-syntax ye-Markdown, injini ecubungula okuqukethwe kombhalo iseyi-Snoomark, ngakho-ke ukufometha okuzungeze lezo zithombe kusekelwe ku-Markdown.

Ngakolunye uhlangothi, iReddit iyanezela izakhi ezengeziwe ezingeyona ingxenye yencazelo ejwayelekile, njengezipoyila. Lokhu kukuvumela ukuthi ufihle umbhalo ngemuva kwesendlalelo umsebenzisi angasiveza ngokuchofoza okukodwa. Ngobuchwepheshe, lapho i-Reddit icubungula isipoyila, isiguqula sibe yinhlanganisela ye-HTML, amakilasi e-CSS, kanye ne-JavaScript ethile yesikhulumi.

Ukumelwa kwe-HTML okubangelwa yi-spoiler kufaka phakathi abaphathi abalawula ukuthi kufanele babonise noma bafihle nini okuqukethwe, futhi yize ngokwethiyori into efanayo ingabhalwa nge-HTML ecacile, ku-Reddit incike ekusetshenzisweni kwayo kwangaphakathi. Into ebalulekile kuwe njengomsebenzisi ukuthi, lapho ubhala, udinga kuphela ukusebenzisa i-syntax ethile ye-spoiler enikezwe umhleli, futhi USnoomark uphethe ukuhumusha esakhiweni esifanele.

Ngamafuphi, i-Snoomark izuza ifa lokuziphatha okuningi okuvela ku-GitHub Flavored Markdown, kodwa ihloselwe izidingo zomphakathi wengxoxo kunokuba iqondiswe kumadokhumenti ephrojekthi. Noma kunjalo, umongo uhlala ufana: umbhalo ocacile onezimpawu ezilula eziguqulwa zibe okuqukethwe okuhlelekile nokufundekayo.

Ukuqonda kahle i-syntax ye-Markdown ku-GitHub kanye ne-Reddit kwenza ukubhala amadokhumenti obuchwepheshe, ukuvula izinkinga ezichazwe kahle, ukushiya imibono ecacile mayelana nezicelo zokudonsa, kanye nokuhlanganyela ezingxoxweni ze-Reddit kube ngcono kakhulu. Ngemithetho embalwa ebalulekile—izihloko, ukugcizelela, uhlu, izingcaphuno, amabhlogo ekhodi, izixhumanisi, izithombe, namaqhinga athile afana namathebula, imininingwane egoqekayo, izexwayiso, imibhalo yaphansi, kanye neziphangi—ungasuka ekubhaleni umbhalo ocacile uye ekudaleni. okuqukethwe okuhlanzekile, okuskenwayo, nokwezobuchwepheshe ngaphandle kokuthinta inkinobho yegundane eyodwa.