Kā ātri izmantot Markdown pakalpojumā GitHub un Reddit

Informatec Digital » Resursi » Kā ātri izmantot Markdown pakalpojumā GitHub un Reddit

Ja bieži rakstāt vietnē GitHub vai pavadāt daudz laika vietnē Reddit, Markdown apgūšana ir viena no tām lietām, kas ietaupa jūsu stundas un atvieglo jūsu dzīvi. Tā ir ļoti viegla iezīmēšanas valoda, kas ļauj ātri formatēt vienkāršu tekstu, neapgrūtinot sevi ar izvēlnēm vai pogām, tikai ar dažiem simboliem, kas novietoti pareizajās vietās.

GitHub platformā to var atrast visur: repozitorija README.md failos , problēmās, pieprasījumos, diskusijās un pat jūsu profilā. Savukārt Reddit izmanto variantu ar nosaukumu Snoomark (Reddit stila Markdown), kas pārmanto lielu daļu GitHub sintakses, ar dažām unikālām funkcijām un ierobežojumiem. Apskatīsim soli pa solim un ar daudziem piemēriem, kā ātri un nepalaidot garām neko svarīgu, izmantot Markdown platformās GitHub un Reddit .

Kas ir Markdown un kāpēc tas ir tik noderīgs GitHub un Reddit platformās?

Markdown ir viegla iezīmēšanas valoda, kas izstrādāta, lai vienkāršo tekstu būtu viegli lasīt un rakstīt, vienlaikus nodrošinot arī ērtu konvertēšanu uz HTML. Praksē tas nozīmē, ka varat rakstīt parastu tekstu un pievienot dažas speciālās rakstzīmes, lai izveidotu virsrakstus, sarakstus, tabulas, citātus, formatētu kodu, saites vai attēlus.

GitHub platformā tiek izmantota GitHub Flavored Markdown (GFM) implementācija, kas paplašina klasisko sintaksi ar tabulām, uzdevumu sarakstiem, uzlabotu koda izcelšanu, krāsu atbalstu, brīdinājumiem un dažiem atļautiem HTML tagiem. Tas viss tiek automātiski atveidots .md failos un platformas komentāru laukos.

Reddit izmanto savu redaktoru ar nosaukumu Snoomark, kas ir GFM atvasinājums. Tam ir liela daļa pamatfunkciju (treknraksts, slīpraksts, virsraksti, saraksti, citāti, iekļauts vai bloķēts kods, saites utt.), taču tam ir svarīgas īpatnības : piemēram, attēlu atbalsts ir ierobežotāks atkarībā no konteksta, un tas pievieno savus elementus, piemēram, spoilerus.

Visa šī skaistums slēpjas apstāklī, ka ar vienu sintaksi var rakstīt tekstus, kas labi izskatās gan GitHub, gan Reddit platformās, pielāgojot tikai dažas detaļas, kur katra platforma darbojas atšķirīgi. Pamatnoteikumu apgūšana ļauj viegli orientēties abos platformās, neapgūstot neko no jauna.

Virsraksti un satura struktūra

Viena no pirmajām lietām, ko izmantosiet, ir virsraksti gan GitHub, gan Reddit platformās. Tie palīdz strukturēt tekstu sadaļās un apakšsadaļās.

Markdown programmā virsraksts tiek izveidots, pirms teksta pievienojot vienu līdz sešus jaucējzīmes simbolus: vienu 1. līmeņa virsrakstam, divus 2. līmenim un tā tālāk līdz 6. līmenim. Piemēram, GitHub README.md failā var būt kaut kas līdzīgs šim: # Galvenais virsraksts , ## Sadaļa , ### Apakšsadaļa utt.

Kad GitHub failā atrod divus vai vairākus virsrakstus, tas automātiski ģenerē satura rādītāju , kas ir pieejams no ikonas “Struktūra” faila augšdaļā. Katrs virsraksts tiek parādīts kā saite, kas jūs ved tieši uz šo sadaļu, kas ir lieliski piemērots gariem dokumentiem.

Turklāt katrs virsraksts kļūst par iekšēju enkuru, uz kuru var izveidot saiti ar URL fragmentu, pamatojoties uz virsraksta tekstu. Lai ģenerētu šo fragmentu, GitHub piemēro ļoti specifiskus noteikumus: tas konvertē burtus uz mazajiem burtiem, aizstāj atstarpes ar defisēm, noņem pieturzīmes un formatējuma rakstzīmes (piemēram, slīprakstu), apgriež liekās atstarpes un, ja rezultāts atbilst citam iepriekšējam virsrakstam, pievieno skaitlisku sufiksu (-1, -2 utt.), lai padarītu to unikālu.

Tas ļauj veikt tādas darbības kā ievietot ## parauga sadaļu un pēc tam izveidot saiti uz to no cita dokumenta punkta, izmantojot saiti, piemēram, (#parauga-sadaļa) , vai pat izveidot saiti uz sadaļām ar īpašām rakstzīmēm nosaukumā, jo GitHub ģenerē fragmentu, ievērojot šos noteikumus, un padara to pieejamu ar to pašu modeli.

Uzsvars, iezīmēts teksts un citāti

Markdown ļauj izcelt tekstu, izmantojot dažādus uzsvara veidus : treknrakstu, slīprakstu, pārsvītrojumu, apakšrakstu, augšrakstu vai pasvītrojumu. Vietnē GitHub tipiskā stilu tabula izskatītos apmēram šādi, lai gan mēs to šeit esam apkopojuši citādi:

Lai tekstu padarītu treknrakstu , ieskaujiet to ar divām zvaigznītēm vai divām pasvītrojumiem; slīprakstam izmantojiet vienu zvaigznīti vai pasvītrojumu; pārsvītrojumam izmantojiet dubultu tildi (divas tildes) abās teksta pusēs. Varat arī apvienot ligzdotu treknrakstu un slīprakstu, izmantot trīs zvaigznītes, lai abus lietotu visai teksta daļai, vai izmantot HTML tagus, piemēram, `<b>` _{apakšrakstiem ^{un augšrakstiem un `<i>` pasvītrojumiem.}}

GitHub ļauj arī izveidot citātu blokus, rindas sākumā ievietojot simbolu "lielāks par" (>). Citētais teksts tiek parādīts ar vertikālu joslu kreisajā pusē pelēkā krāsā, padarot to skaidri redzamu. Vienā citātu blokā var būt vairākas rindas un pat var ligzdot citātus, sākumā pievienojot vairāk simbolu ">".

Uzlabota citēšanas forma, kas raksturīga tikai GitHub, ir brīdinājums jeb brīdinājums . Tajā tiek izmantota tā pati blokcitātu sintaksi, bet pirmajā rindā ir iekļauts īpašs marķieris, kas norāda brīdinājuma veidu. Piemēram, varat norādīt `brīdinājumu` noderīgai informācijai, `noderīgiem padomiem`, `svarīgiem datiem`, `steidzamiem brīdinājumiem` un `brīdinājumiem par riskiem vai negatīvām sekām`. GitHub katru veidu attēlo ar atšķirīgu krāsu un ikonu, palīdzot izcelt kritisku informāciju jūsu dokumentācijā.

Reddit atbalsta arī vienkāršas citātus ar to pašu > simbolu, lai gan tam trūkst GitHub bagātīgās ping sistēmas. Pat neskatoties uz to, tas joprojām ir ļoti noderīgs veids, kā atbildēt kādam, citējot daļu no viņa ziņojuma, to pilnībā neatkārtojot.

Koda izcelšana, bloki un krāsas

Gan GitHub, gan Reddit ļauj izcelt koda fragmentus tekstā, izmantojot atpakaļatzīmes. Iekļautā kodā vārds vai komanda tiek ietverta ar vienu atpakaļatzīmi katrā pusē. Tas ir ideāli piemērots, piemēram, lai teikumā izceltu ` git status` , skaidri norādot, ka tā ir komanda.

Ja vēlaties atsevišķu koda bloku, Markdown izmanto trīs atpakaļskaitļus: jūs rakstāt rindu ar trim atpakaļskaitļiem, pēc tam kodu atsevišķās rindās un noslēdzat ar vēl trim atpakaļskaitļiem. GitHub, ja jūs norādāt arī valodu tūlīt pēc pirmajiem atpakaļskaitļiem, tiek lietota sintakses izcelšana ar šai valodai specifiskām krāsām un formatējumu.

GitHub piedāvā arī īpašu funkciju krāsu vērtību izcelšanai atpakaļskaitļos. Ja starp atpakaļskaitļiem ierakstāt krāsu heksadecimālā, RGB vai HSL formātā, platforma blakus tekstam iekļauj nelielu krāsas indikatoru. Piemēram, ja fona krāsa gaišajā režīmā ir #ffffff un tumšajā režīmā ir #000000, šo kodu izcelšana ļauj ātri redzēt, kurš ir kurš.

Attiecībā uz koda un tabulu attēlošanu GitHub ļauj iespējot fiksētu monospace fontu visos komentāru laukos, tādējādi atvieglojot darbu ar tehnisku tekstu. Ja pārlūkprogrammā vai redaktoros, piemēram, Visual Studio Code , rediģējat daudz koda fragmentu, šīs opcijas iespējošana padara izlīdzināšanu un lasāmību daudz konsekventāku.

Reddit atbalsta arī koda blokus ar atpakaļejošām atzīmēm (backtick), gan iekļautiem, gan blokveida, lai gan to izmantošana tur vairāk koncentrējas uz nelieliem fragmentiem vai pseidokodu, nevis uz garu dokumentāciju, piemēram, repozitorijā.

Saites, enkuri un iekšējā navigācija

Saišu izveide programmā Markdown ir ļoti vienkārša: lietotājam rādāmais teksts tiek ievietots kvadrātiekavās, bet URL — iekavās. Tas darbojas gan pakalpojumā GitHub, gan Reddit, un to var uzlabot ar īsinājumtaustiņiem pakalpojumā GitHub (piemēram, izmantojot taustiņu kombinācijas, lai ātri pārvērstu atlasīto tekstu par saiti).

GitHub pievieno dažas papildu ar navigāciju saistītas funkcijas. Pirmkārt, tas ļauj tieši saistīt virsrakstus, izmantojot iepriekš apspriestos fragmentu ģenerēšanas noteikumus. Otrkārt, tas atbalsta relatīvās saites pašā repozitorijā, kas ir ļoti svarīgi tehniskajai dokumentācijai.

Relatīva saite ir tāda, kas tiek aprēķināta, izmantojot pašreizējo failu kā atsauci. Piemēram, ja jūsu README fails atrodas projekta saknes direktorijā un vēlaties izveidot saiti uz failu docs/CONTRIBUTING.md, vienkārši ierakstiet saiti ar ceļu docs/CONTRIBUTING.md. GitHub pareizi tulko šo relatīvo saiti jebkurā atvērtajā atzarā, novēršot tās pārtraukšanu, pārslēdzot atzarus vai klonējot repozitoriju.

Ieteicams vienmēr izmantot relatīvos ceļus , pārvietojoties starp failiem vienā repozitorijā, jo absolūtās saites klonos vai forkos var pārstāt darboties. GitHub ļauj izmantot standarta operatorus, piemēram, ./ vai ../, un ceļus, kas sākas ar / attiecībā pret projekta sakni.

Ja vēlaties dokumentā izveidot pielāgotus enkurpunktus ārpus virsrakstiem, varat izmantot HTML tagus ar atribūtu `name`. Tas ļauj ievietot mērķa punktu rindkopas vidū vai blakus tekstam, kuram nav sava virsraksta, un izveidot saiti uz to, izmantojot to pašu sintaksi kā automātiski ģenerētiem virsrakstiem.

Attēli vietnē GitHub: Markdown, HTML un relatīvie ceļi

GitHub platformā attēli parasti tiek iegulti, izmantojot to pašu sintaksi kā saites, bet pirms tiem ir izsaukuma zīme. Alternatīvais teksts (alt) ir norādīts kvadrātiekavās, un attēla URL vai ceļš ir ievietots iekavās. Šis alternatīvais teksts ir svarīgs pieejamības nodrošināšanai , jo to nolasīs ekrāna lasītāji un kas tiks parādīts, ja attēlu neizdosies ielādēt.

Attēli var nākt no failiem pašā repozitorijā vai no ārējiem URL. GitHub ļauj izmantot vairākus relatīvos ceļa modeļus attēlu augšupielādei no dažādām filiālēm, citiem repozitorijiem vai pat problēmām un komentāriem, izmantojot sufiksus, piemēram , ?raw=true, lai nepieciešamības gadījumā piespiestu tiešu faila lejupielādi.

Papildus standarta Markdown sintaksei GitHub atbalsta HTML elementa `<picture>` izmantošanu. Šis elements ir īpaši noderīgs atsaucīgu attēlu ielādei , kas mainās atkarībā no lietotāja tēmas preferencēm (gaišs vai tumšs). Izmantojot multivides vaicājumu `prefers-color-scheme`, varat definēt dažādus attēlu avotus katram režīmam un noklusējuma attēlu pārlūkprogrammām, kas neatbalsta šo funkciju.

Tipisks modelis ietver iekļaušanu iekšpusē vairāki elementi ar tā multivides un srcset atribūtiem un visbeidzot a Izmantojot alt atribūtu un vispārīgu URL, lietotāji tumšajā režīmā redz pielāgotu attēlu, savukārt tie, kas atrodas gaišajā režīmā, saņem citu attēlu, bez nepieciešamības dublēt saturu README failā.

GitHub atbalsta arī HTML komentārus Markdown failos, ļaujot pievienot lasītājam neredzamus atgādinājumus, piemēram, lai atgādinātu viņam atjaunināt attēlu sadaļu vai vēlāk pievienot jaunus piemērus.

Galdi, izvelkamās sadaļas un satura atdalīšana

Viens no visnoderīgākajiem GitHub Flavored Markdown uzlabojumiem ir tā tabulu atbalsts . Datus var sakārtot rindās un kolonnās, izmantojot vertikālas joslas šūnu atdalīšanai un domuzīmju rindu galvenes atzīmēšanai. Kolonnas var arī izlīdzināt pa labi, pa kreisi vai centrā, izmantojot kolu atdalītājrindā.

Tabulas ir ļoti noderīgas, lai attēlotu programmēšanas valodu sarakstus, izmantotos ietvarus, plānotos uzdevumus, funkciju salīdzinājumus vai jebkuru citu informāciju, kas gūst labumu no matricas struktūras. GitHub atveido šīs tabulas tīrā un lasāmā stilā.

Lai garu README failu sakārtotu, varat izmantot HTML tagu `<details>`, lai izveidotu sakļaujamas sadaļas. Šajās sadaļās tagā `<summary>` tiek parādīts kopsavilkums, un lietotājs var pēc nepieciešamības izvērst vai sakļaut papildu saturu . Ir ierasta prakse tagā `<details>` iekļaut tabulas vai sekundāras informācijas blokus, lai pirmajā acu uzmetienā tas nepārspīlētu lietotājam.

Ja vēlaties, lai sadaļa pēc noklusējuma tiktu parādīta izvērsta, vienkārši pievienojiet atribūtu “open” (atvērt). Šī metode ir ļoti praktiska, lai grupētu reitingus, garus sarakstus vai saturu, kas nav nepieciešams pirmajai lasīšanai, bet ir ērti pieejams.

Vēl viens vienkāršs informācijas organizēšanas rīks ir horizontālā līnija. To izveido, uzrakstot trīs vai vairāk svītriņas uz līnijas, un tā kalpo, lai novilktu atdalīšanas līniju starp sadaļām, ļaujot skaidri atdalīt, piemēram, aprakstošo sadaļu no atsauču vai papildu piezīmju sadaļas.

Šos noteikumus var apvienot ar dokumenta beigu citātiem, lai izceltu iedvesmojošas frāzes, atgādinājumus vai galvenos vēstījumus. Tipisks piemērs būtu motivējoša citāta ievietošana jūsu profila README faila beigās, formatējot to ar bloka citātu aiz atdalītājrindas.

Slēptie komentāri un formāta kontrole

GitHub ļauj ievietot HTML komentārus Markdown ietvaros, izmantojot sintaksi <!-- comment -->. Nekas, ko ievietosiet šajā komentārā, netiks parādīts atveidotajā saturā, bet tas būs redzams pirmkodā, padarot to par ideālu risinājumu iekšējām piezīmēm vai uzdevumiem.

Piemēram, profila README failā varat pievienot komentāru, piemēram, ka vēlāk ir jāpaplašina sadaļa “Par mani” vai jāpārskata novecojušu tehnoloģiju tabula, nevienam profila apmeklētājam to tieši neredzot.

Vēl viena noderīga funkcija ir atsoļa rakstzīmes , kas parasti tiktu interpretētas kā Markdown. Ja zvaigznītes, restītes simboli vai citi simboli ir jāattēlo burtiski, tos neformatējot, vienkārši pirms katra no tiem ievietojiet atpakaļvērsto slīpsvītru. Tas ļauj, piemēram, rakstīt izteiksmes, kas ietver sarakstu simbolus, nepārvēršot tos par faktiskajiem sarakstiem.

Skatot iezīmēšanas failu pakalpojumā GitHub, varat pārslēgties starp atveidoto skatu un pirmkodu, izmantojot pogu augšpusē (vai atvērt to redaktoros, piemēram, Brackets ). Markdown interpretācijas atspējošana ļauj piekļūt tipiskām koda skata funkcijām, piemēram, noteiktu rindu saistīšanai , kas ir ļoti noderīgi, ja vēlaties iezīmēt precīzu README vai jebkura .md faila sadaļu.

Visbeidzot, atcerieties, ka GitHub atšķirīgi apstrādā rindiņu pārtraukumus komentāros (problēmās, PR utt.) un .md failos. Komentāros rindiņu pārtraukumi tiek ņemti vērā tieši, savukārt Markdown failos rindas beigās jāpievieno divas atstarpes, atpakaļvērstā slīpsvītra vai punkts. lai piespiestu lēcienu vienas rindkopas ietvaros.

Saraksti, ligzdoti saraksti un uzdevumu saraksti

Saraksti ir viens no visbiežāk izmantotajiem elementiem Markdown platformā gan GitHub, gan Reddit. Nekārtotus sarakstus var izveidot , katra saraksta elementa priekšā ievietojot defisi, zvaigznīti vai pluszīmi. Visi šie marķieri tiek atveidoti līdzīgi kā aizzīmju punkti.

Lai ģenerētu sakārtotus sarakstus , katra rinda jānumurē ar skaitli, kam seko punkts un atstarpe. Lai gan skaitļu secībai nav jābūt perfektai (GitHub parasti to pārrēķina), ieteicams saglabāt konsekventu numerāciju, lai avota kods būtu lasāms.

Ligzdoti saraksti tiek izveidoti, vienkārši atkāpjot zem tiem esošos vienumus. Vienrindas redaktoros, piemēram, Sublime Text , jums tikai vizuāli jāizlīdzina ligzdoto sarakstu marķieri zem teksta pirmās rakstzīmes vecākvienumā. Tādos kontekstos kā GitHub komentāru redaktors, kur fonts nav vienrindas, jums jāskaita, cik rakstzīmju ir pirms teksta, un jāizmanto šis atstarpju skaits atkāpei.

Varat arī veidot vairākus ligzdošanas līmeņus, ja vien saglabājat konsekvenci atstarpju skaitā. Ļoti sarežģītiem sarakstiem šī sistēma prasa nelielu praksi, bet, tiklīdz to apgūstat, to var ļoti ātri ieviest.

GitHub piedāvā arī uzdevumu sarakstus , kas ir ļoti noderīgi problēmu, pieprasījumu un dokumentācijas gadījumā. Tie tiek izveidoti, saraksta priekšā liekot defisi, atstarpi un divas kvadrātiekavas ar atstarpi vai "x" iekšpusē: vienu nepabeigtiem uzdevumiem un otru pabeigtiem uzdevumiem. Šie saraksti tiek atveidoti ar izvēles rūtiņām, kuras var atzīmēt vai noņemt atzīmi saskarnē.

Ja uzdevumu saraksta elementa teksts sākas ar iekavām, tas ir jāatdala ar atpakaļvērsto slīpsvītru, lai izvairītos no neskaidrībām parsētājā. Tā ir neliela detaļa, bet svarīga, rakstot aprakstus, kas sākas ar, piemēram, "(pēc izvēles)" vai līdzīgu.

Pieminējumi, atsauces un emocijzīmes vietnē GitHub

Viena no Markdown rakstīšanas priekšrocībām GitHub platformā ir iespēja tieši pieminēt lietotājus un komandas platformā. Jums vienkārši jāievada @ simbols, kam seko lietotājvārds vai komandas nosaukums, un GitHub nosūtīs paziņojumu uz šo kontu, pievēršot tā uzmanību sarunai.

Ievadot simbolu @, GitHub parāda ar repozitoriju vai pavedienu saistīto lietotāju un komandu sarakstu, un jūs varat filtrēt šo sarakstu rakstīšanas laikā. Izmantojiet bulttaustiņus un nospiediet taustiņu Enter vai Tab, lai apstiprinātu ieteikumus. Komandām izmantojiet formātu @organizācija/komandas-nosaukums, un visi komandas dalībnieki tiks abonēti pavedienam.

Papildus pieminējumiem GitHub atvieglo problēmu atsaukšanos un pieprasījumu izvilkšanu, vienkārši ierakstot #, kam seko skaitlis vai daļa no nosaukuma. Tiek parādīts ieteikto rezultātu saraksts, ko var aizpildīt tāpat kā pieminējumus. Tas ievērojami paātrina navigāciju starp saistītām sarunām.

Ja jūsu repozitorijam ir konfigurētas pielāgotas automātiski saistītas atsauces, noteiktas ārējās notācijas (piemēram, JIRA vai Zendesk biļešu ID) var arī automātiski konvertēt īsās saitēs. Šim iestatījumam ir nepieciešamas administratora privilēģijas, taču, tiklīdz tas ir iespējots, tas ļauj koplietot datus starp sistēmām ar minimālu piepūli.

Visbeidzot, GitHub atbalsta emocijzīmes, izmantojot kodu: ierakstiet kolu, kam seko emocijzīmes nosaukums un beidziet ar vēl vienu kolu. Sākot rakstīt, parādās ieteikumu saraksts, ko varat pieņemt ar taustiņu Tab vai Enter. Emociju iekļaušana komentāros palīdz piešķirt tiem cilvēcīgāku pieskārienu, ja vien tās netiek pārmērīgi izmantotas formālā dokumentācijā.

Zemsvītras piezīmes un papildu saturs

GitHub atbalsta arī zemsvītras piezīmes , izmantojot uz iekavām balstītu sintaksi un identifikatoru ar kursorzīmi. Vietā, kur vēlaties atsauci, ievietojiet kaut ko līdzīgu `<zemsvītras piezīme>`, un dokumenta beigās definējiet šīs zemsvītras piezīmes tekstu ar to pašu tagu, kam seko kols un saturs.

Zemsvītras piezīmes var aizņemt vairākas rindas, un, lai piespiestu rindiņu pārtraukumus zemsvītras piezīmē, rindas beigās tiek izmantotas dubultas atstarpes, tāpat kā Markdown pamattekstā. Renderējot, GitHub tekstā parāda augšrakstu un beigās zemsvītras piezīmju sarakstu ar atpakaļsaitēm, lai pārvietotos starp atsaucēm un zemsvītras piezīmēm.

Vēl viena GitHub piedāvātā uzlabotā funkcija ir iepriekš minētie brīdinājumi (PIEZĪME, PADOMS, SVARĪGI, BRĪDINĀJUMS un UZMANĪBU). Ieteicams tos izmantot tikai tad, ja tas ir patiešām nepieciešams, un izvairīties no pārāk daudzu brīdinājumu apvienošanas, lai nepārslogotu lasītāju. Tos nevar ligzdot citos sarežģītos elementos, tāpēc ir svarīgi rūpīgi plānot to izvietojumu.

Visbeidzot, varat lūgt GitHub īslaicīgi paslēpt atveidotā Markdown sadaļas, ietinot tās HTML komentāros, vai ignorēt noteiktu rakstzīmju apstrādi, izmantojot atpakaļvērstās slīpsvītras. Tas ir īpaši noderīgi, ja dokumentējat pašu Markdown sintaksi un ir jāparāda piemēri tādi, kādi tie ir, bez interpretācijas.

Markdown vietnē Reddit: Snoomark un rediģēšanas režīms

Reddit ir diskusiju platforma, kurā ir laipni gaidīta gandrīz jebkura tēma, kas ir sakārtota apakšredditos. Formatēšanas ziņā tā piedāvā divus redaktorus: vienu vizuālākam bagātinātam tekstam un otru vienkāršam tekstam, kura pamatā ir Markdown. Ja vēlaties strādāt ātri un precīzi kontrolēt rezultātu, ieteicams izmantot Markdown opciju.

Pēc noklusējuma Reddit parasti aktivizē bagātinātā teksta redaktoru, tāpēc, lai pārslēgtos uz iezīmēšanas režīmu , ieraksta vai komentāra teksta lodziņā ir jānoklikšķina uz opcijas Markdown režīms . No turienes varat tieši izmantot Snoomark sintaksi.

Ja vēlaties, lai Markdown redaktors tiktu ielādēts vienmēr, dodieties uz lietotāja iestatījumiem, atveriet sadaļu “Plūsmas iestatījumi” un iespējojiet opciju “Noklusējuma iestatījums — Markdown” . Tādā veidā Markdown redaktors tiks atvērts automātiski katru reizi, kad sāksiet rakstīt ierakstu vai komentāru, un jums tas nebūs manuāli jāmaina.

Reddit atbalsta lielāko daļu Markdown pamata un uzlaboto funkciju: virsrakstus, treknrakstu un slīprakstu, sarakstus, citātus, koda blokus, saites un dažas no savām papildu funkcijām, piemēram, spoilerus. Tomēr tam ir ievērojami trūkumi salīdzinājumā ar GitHub, īpaši attēlu apstrādē , kas ir ļoti atkarīga no konteksta un redaktora veida.

Reddit atbalstīta sintakse un spoileri

Reddit izmantotajā Snoomark variantā ir daudz kopīgu elementu ar GitHub, tāpēc, ja jūs jau labi pārzināt Markdown repozitorijiem, šo zināšanu pārnešana uz Reddit vidi ir diezgan vienkārša. Varat izmantot virsrakstus, lai strukturētu garus ierakstus, numurētus vai aizzīmju sarakstus, citātus, lai atbildētu citiem lietotājiem, un koda blokus, ja vēlaties parādīt komandas vai tehniskus fragmentus.

Viena no ievērojamākajām atšķirībām ir tas, kā Reddit apstrādā attēlus . Lai gan daudzos gadījumos attēli tiek augšupielādēti, izmantojot grafisko saskarni, nevis tieši ar Markdown sintaksi, dzinējs, kas apstrādā teksta saturu, joprojām ir Snoomark, tāpēc formatējums ap šiem attēliem patiešām ir balstīts uz Markdown.

Savukārt Reddit pievieno papildu funkcijas, kas nav iekļautas standarta specifikācijā, piemēram, spoilerus. Tie ļauj tekstu paslēpt aiz slāņa, ko lietotājs var atklāt ar klikšķi. Tehniski, kad Reddit apstrādā spoileri, tas to pārveido HTML, CSS klašu un platformai specifiska JavaScript kombinācijā.

Iegūtajā spoilera HTML attēlojumā ir iekļauti apstrādātāji, kas kontrolē, kad saturs ir jārāda vai jāslēpj, un, lai gan teorētiski kaut ko līdzīgu varētu uzrakstīt ar vienkāršu HTML, Reddit tas ir atkarīgs no tā iekšējās ieviešanas. Svarīgi ir tas, ka jums kā lietotājam rakstot, jums ir jāizmanto tikai redaktora nodrošinātā konkrētā spoilera sintakse, un Snoomark rūpējas par tā tulkošanu atbilstošā struktūrā.

Īsāk sakot, Snoomark pārmanto daudzas GitHub Flavored Markdown darbības principus, taču tie ir vairāk pielāgoti diskusiju kopienas vajadzībām, nevis projekta dokumentācijai. Tomēr būtība paliek nemainīga: vienkāršs teksts ar vienkāršiem simboliem, kas pārveidoti strukturētā un lasāmā saturā.

Markdown sintakses apgūšana GitHub un Reddit platformās padara tehniskās dokumentācijas rakstīšanu, labi izskaidrotu problēmu atvēršanu, skaidru komentāru atstāšanu par pieprasījumiem un dalību Reddit diskusijās daudz efektīvāku. Ievērojot dažus galvenos noteikumus — virsrakstus, uzsvarus, sarakstus, citātus, koda blokus, saites, attēlus un īpašus trikus, piemēram, tabulas, sakļaujamas detaļas, brīdinājumus, zemsvītras piezīmes un spoilerus —, jūs varat pāriet no vienkrāsainu ziņojumu rakstīšanas uz tīra, viegli lasāma un profesionāla satura izveidi , neklikšķinot ne uz vienu peles pogu.