Kā ātri izmantot Markdown pakalpojumā GitHub un Reddit

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

Ja regulāri rakstāt vietnē GitHub vai pavadāt daudz laika vietnē Reddit, apgūstot Markdown Tā ir viena no tām lietām, kas ietaupa jūsu laiku un atvieglo 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 vietnē to atradīsiet visur: failos README.md no krātuvēm, problēmām, pieprasījumiem, diskusijām un pat jūsu profila. Reddit savukārt 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 noteiktiem ierobežojumiem. Apskatīsim soli pa solim un ar daudziem piemēriem, Kā ātri izmantot Markdown pakalpojumā GitHub un Reddit un neizlaižot neko svarīgu.

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

Markdown ir a vieglā iezīmēšanas valoda Izstrādāts, lai vienkāršu 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 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) ieviešana, 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 atveidots automātiski .md failos un platformas komentāru laukos.

Reddit izmanto savu procesoru 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 funkcijasPiemēram, attēlu atbalsts ir ierobežotāks atkarībā no konteksta un pievieno savus elementus, piemēram, spoilerus.

Visa šī skaistums slēpjas faktā, 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. Uzziniet pamatnoteikumus Tas ļauj brīvi pārvietoties abos, neapgūstot neko no jauna.

Virsraksti un satura struktūra

Viena no pirmajām lietām, ko izmantosiet, ir virsrakstiGan GitHub, gan Reddit platformās tās tiek izmantotas, lai strukturētu 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ētu būt kaut kas līdzīgs šim: # Galvenais nosaukums, ## Sadaļa, ### Apakšnodaļa, Uc

Kad GitHub failā atrod divas vai vairākas galvenes, tas automātiski ģenerē satura rādītājs Piekļūstams 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, pievienot skaitlisku sufiksu (-1, -2 utt.), lai padarītu to unikālu.

Tas ļauj veikt tādas darbības kā sadaļas ievietošana ## Parauga sadaļa un pēc tam izveidojiet saiti uz to no citas dokumenta vietas, izmantojot šādu saiti: (#parauga-sadaļa)vai pat saistīt ar sadaļām, kuru nosaukumā ir īpašas rakstzīmes, 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žādas metodes uzsvarsTreknraksts, slīpraksts, pārsvītrojums, apakšraksts, augšraksts vai pasvītrojums. Vietnē GitHub tipiska stilu tabula izskatītos apmēram šādi, lai gan mēs to šeit esam apkopojuši ar citiem vārdiem:

Lai ievietotu tekstu treknrakstāTreknraksta teksts ir ietverts dubultās zvaigznītēs vai dubultās pasvītrojumos; slīprakstam tiek izmantotas vienas zvaigznītes vai pasvītrojumi; lai kaut ko pārsvītrotu, teksta abās pusēs tiek ievietota dubultā tilde (divas tildes). Ligzdoto treknrakstu un slīprakstu var arī apvienot, trīs zvaigznītes var izmantot, lai abus lietotu visai teksta daļai, vai arī var izmantot HTML tagus, piemēram, <br>. _{y ^{apakšindeksiem un augšindeksiem, un pasvītrošanai.}}

GitHub arī ļauj jums izveidot citātu blokcitātu stilā Novietojot simbolu "lielāks par" (>) rindas sākumā, citētais teksts tiek parādīts ar vertikālu joslu kreisajā pusē un pelēkā krāsā, tādējādi to skaidri izceļot. Vienā citātu blokā var iekļaut vairākas rindas, un citātus var pat ligzdot, sākumā pievienojot vairāk > simbolu.

Uzlabota citēšanas forma, kas pastāv tikai vietnē GitHub, ir brīdinājumi vai brīdinājumiTie ir balstīti uz to pašu citātu bloku 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ājums>` noderīgai informācijai, `<noderīgi padomi>` praktiskiem padomiem, `<galvenie dati>` galvenajiem datiem, `<steidzami paziņojumi>` steidzamiem brīdinājumiem un `<brīdinājums>` 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 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 brīdināšanas sistēmas. Pat neskatoties uz to, tas joprojām ir ļoti noderīgs veids, kā atbildot 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 atzīmes. Iekļautā kodā vārds vai komanda tiek ietverta ar vienu atzīmi katrā pusē. Tas ir ideāli piemērots, piemēram, lai izceltu git statuss teikuma ietvaros, skaidri norādot, ka tā ir pavēle.

Ja vēlaties atsevišķu koda bloku, Markdown izmanto trīs atpakaļskaitļus: jūs rakstāt rindu ar trim atpakaļskaitļiem, tad 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 pirmā atpakaļskaitļa, tas tiek piemērots... sintakses izcelšana ar šai valodai raksturīgām krāsām un formātu.

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

Attiecībā uz koda un tabulu vizualizāciju GitHub ļauj iespējot fiksētu monospace fontu visos komentāru laukos, lai darbs ar tehnisko tekstu būtu ērtāks. Ja pārlūkprogrammā vai redaktoros, piemēram, rediģējat daudz koda fragmentu, Visual Studio kodsIespējojot šo opciju, tiek atvieglota izlīdzināšana un lasīšana. daudz saskaņotāk.

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 funkcijas, kas saistītas ar navigāciju. Pirmkārt, tas ļauj tieši saite uz virsrakstiem izmantojot iepriekš apspriestos fragmentu ģenerēšanas noteikumus. Turklāt tas atbalsta relatīvās saites pašā repozitorijā, kas ir ļoti svarīgi tehniskajā dokumentācijā.

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.

Ieteikums ir vienmēr lietot relatīvie ceļi Lai pārvietotos starp failiem vienā repozitorijā, GitHub ļauj izmantot standarta operatorus, piemēram, ./ vai ../, un ceļus, kas sākas ar / attiecībā pret projekta sakni, jo absolūtās saites var pārstāt darboties klonos vai atzarojumos.

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, lai pieejamībajo tieši to nolasīs ekrāna lasītāji un tas tiks parādīts, ja attēls netiks ielādēts.

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, ?neapstrādāts=patiess lai nepieciešamības gadījumā piespiestu faila tiešu lejupielādi.

Papildus standarta Markdown sintaksei GitHub atbalsta HTML elementa izmantošanu Šis priekšmets ir īpaši noderīgs uzlādēšanai atsaucīgi attēli Tie mainās atkarībā no lietotāja tēmas preferencēm (gaišs vai tumšs). Izmantojot multivides vaicājumu `prefers-color-scheme`, katram režīmam var definēt dažādus attēlu avotus 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ā atbalsts galdiDatus var sakārtot rindās un kolonnās, izmantojot vertikālas joslas, lai atdalītu šūnas, un pārtrauktu līniju, lai atzīmētu galveni. Varat arī izlīdzināt kolonnas 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 sakārtotu garu README failu, varat izmantot HTML tagu. lai izveidotu sakļaujamas sadaļas. Šajās sadaļās etiķetē tiek parādīts kopsavilkums un ļauj lietotājam izplesties vai sarauties papildu saturs pēc nepieciešamības. Parasti ir iekļaut tabulas vai sekundārās informācijas blokus. lai nepārslogotu aci.

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 jums ieviest HTML komentāri Markdown ietvaros, izmantojot sintaksi Nekas, ko ievietosiet šajā komentārā, netiks parādīts atveidotajā saturā, bet tas būs redzams pirmkodā, tāpēc tas ir ideāli piemērots 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 tā, ka evakuācijas rakstzīmes kas parasti tiktu interpretēts 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 saraksta simbolus, nepārvēršot tos par faktiskiem sarakstiem.

Skatot iezīmēšanas failu vietnē GitHub, varat pārslēgties starp atveidoto skatu un pirmkodu, izmantojot pogu augšpusē (vai atvērt to redaktoros, piemēram, IekavasAtspējojot Markdown interpretāciju, varat piekļūt tipiskām koda skata funkcijām, piemēram, saitei specifiskas līnijasTas ir ļoti noderīgi, ja vēlaties norādīt uz precīzu README vai jebkura .md faila daļ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. Sarakstus var izveidot. nesakārtots ievietojot defisi, zvaigznīti vai pluszīmi pirms katra saraksta elementa. Visas šīs atzīmes tiek atveidotas līdzīgi kā aizzīmju punkti.

Lai ģenerētu sarakstus pasūtītsKatra rinda ir numurēta ar ciparu, kam seko punkts un atstarpe. Lai gan ciparu secībai nav jābūt perfektai (GitHub parasti to pārrēķina), ieteicams saglabāt konsekventu numerāciju, lai pirmkods būtu lasāms.

Ligzdotus sarakstus izveido, vienkārši pievienojot atkāpi zem tiem esošajiem elementiem. Vienrindas redaktoros, piemēram, Sublime TekstaVienkārši vizuāli izlīdziniet ligzdoto sarakstu marķierus zem teksta pirmās rakstzīmes vecākelementā. Tādos kontekstos kā GitHub komentāru redaktors, kur fonts nav vienrindas, saskaitiet rakstzīmju skaitu pirms teksta un izmantojiet šo atstarpju skaitu 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ī darāmo darbu sarakstiTie ir ļoti noderīgi problēmu, pieprasījumu un dokumentācijas gadījumā. Tie tiek izveidoti, pirms defises, atstarpes un divām kvadrātiekavām ievietojot atstarpi vai "x": nepabeigtiem uzdevumiem un pabeigtiem uzdevumiem. Šie saraksti tiek atveidoti ar izvēles rūtiņām, kuras var atzīmēt vai noņemt no saskarnes.

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 izmantot piemin Sūtiet ziņojumus lietotājiem un komandām platformā. Vienkārši ierakstiet @, kam seko lietotājvārds vai komandas nosaukums, un GitHub nosūtīs paziņojumu uz šo kontu, pievēršot viņu 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 atsauces problēmas un pieprasījuma pieprasījumi Vienkārši ierakstiet #, kam seko skaitlis vai daļa no nosaukuma. Parādīsies ieteikto rezultātu saraksts, kuru varat 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 iekavu sintaksi un identifikatoru ar starpliktu rakstzīmi. Vietā, kur vēlaties atsauci, ievietojiet kaut ko līdzīgu , un dokumenta beigās definējiet šīs 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 uzlabota funkcija, ko piedāvā GitHub, ir... brīdinājumi Tie jau ir apspriesti (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 elementu apvienošanas, lai nepārslogotu lasītāju. Tos nevar ievietot 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ās Markdown sadaļas, ietinot tās HTML komentāros, vai ignorēt noteiktu rakstzīmju apstrādi ar atpakaļvērstajām slīpsvītrām. Tas ir īpaši noderīgi, dokumentējot. Markdown paša sintakse Un jums 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, jums jānoklikšķina uz opcijas Markdown režīms ieraksta vai komentāra teksta lodziņā. Tur varat tieši izmantot Snoomark sintaksi.

Ja vēlaties, lai Markdown redaktors vienmēr tiktu ielādēts, jums vajadzētu doties uz lietotāja iestatījumiem, ievadīt sadaļu Plūsmas iestatījumi un aktivizēt opciju. Noklusējuma vērtība — MarkdownTādā veidā katru reizi, kad sākat rakstīt ierakstu vai komentāru, Markdown redaktors tiks atvērts automātiski, un jums tas nebūs jāmaina manuāli.

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 ekstras, piemēram, spoilerus. Tomēr tam ir ievērojami trūkumi salīdzinājumā ar GitHub, īpaši attēlu pārvaldībakas diezgan lielā mērā ir atkarīgs 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 veids, kā Reddit apstrādā tēlainībaLai 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 ir balstīts uz Markdown.

Savukārt Reddit piebilst papildu elementi kas nav standarta specifikācijas sastāvdaļa, piemēram, spoileri. Tie ļauj paslēpt tekstu 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 ir jāizmanto tikai redaktora nodrošinātā specifiskā spoilera sintakse, un Par tā tulkošanu ir atbildīgs Snoomark. atbilstošajai struktūrai.

Ī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 vienkārša teksta rakstīšanas uz satura veidošanu. tīrs, skenējams un profesionāls saturs nepieskaroties nevienai peles pogai.