Kaip greitai naudoti „Markdown“ „GitHub“ ir „Reddit“ platformose

Informatec Digital » Ištekliai » Kaip greitai naudoti „Markdown“ „GitHub“ ir „Reddit“ platformose

Jei reguliariai rašote „GitHub“ platformoje arba daug laiko praleidžiate „Reddit“, įvaldydami Akcijos kainos Tai vienas iš tų dalykų, kuris sutaupo jums valandas ir palengvina gyvenimą. Tai labai lengva žymėjimo kalba, leidžianti greitai formatuoti paprastą tekstą, nesivarginant su meniu ar mygtukais, tereikia įterpti kelis simbolius tinkamose vietose.

„GitHub“ rasite visur: failuose README.md iš saugyklų, problemų, užklausų dėl išsiuntimo, diskusijų ir net jūsų profilio. „Reddit“ savo ruožtu naudoja variantą, vadinamą „Snoomark“ (Reddit stiliaus „Markdown“), kuris paveldi didelę dalį „GitHub“ sintaksės, su kai kuriomis unikaliomis savybėmis ir tam tikrais apribojimais. Pažiūrėkime žingsnis po žingsnio ir pateikdami daug pavyzdžių, Kaip greitai naudoti „Markdown“ „GitHub“ ir „Reddit“ platformose ir nepraleidžiant nieko svarbaus.

Kas yra „Markdown“ ir kodėl jis toks naudingas „GitHub“ ir „Reddit“?

Markdown yra a lengva žymėjimo kalba Sukurta taip, kad paprastą tekstą būtų lengva skaityti ir rašyti, taip pat būtų galima lengvai konvertuoti jį į HTML. Praktiškai tai reiškia, kad galite rašyti įprastą tekstą ir pridėti specialiųjų simbolių, kad sukurtumėte antraštes, sąrašus, lenteles, citatas, formatuotą kodą, nuorodas ar vaizdus.

„GitHub“ naudojama „GitHub Flavored Markdown“ (GFM) implementacija, kuri praplečia klasikinę sintaksę lentelėmis, darbų sąrašais, išplėstiniu kodo paryškinimu, spalvų palaikymu, įspėjimais ir kai kuriomis leistinomis HTML žymėmis. Visa tai pateikiama automatiškai .md failuose ir platformos komentarų laukuose.

„Reddit“ naudoja savo procesorių, vadinamą „Snoomark“, kuris yra GFM darinys. Jis turi daug bendro su pagrindiniu veikimu (paryškintas, kursyvas, antraštės, sąrašai, citatos, eilutės arba bloko kodas, nuorodos ir kt.), tačiau turi svarbios savybėsPavyzdžiui, vaizdų palaikymas yra labiau ribotas priklausomai nuo konteksto ir prideda savo elementus, pvz., spoilerius.

Viso to grožis yra tas, kad naudojant vieną sintaksę galima rašyti tekstus, kurie gerai atrodo tiek „GitHub“, tiek „Reddit“, pritaikant tik keletą detalių ten, kur kiekviena platforma veikia skirtingai. Išmokite pagrindinių taisyklių Tai leidžia laisvai judėti abiejose srityse, nereikia nieko mokytis iš naujo nuo nulio.

Antraštės ir turinio struktūra

Vienas pirmųjų dalykų, kuriuos naudosite, yra antraštėsTiek „GitHub“, tiek „Reddit“ platformose jie naudojami tekstui suskirstyti į skyrius ir poskyrius.

„Markdown“ kalboje antraštė sukuriama prieš tekstą įrašant nuo vieno iki šešių maišos simbolių: vieną – 1 lygio antraštei, du – 2 lygiui ir taip toliau iki 6 lygio. Pavyzdžiui, „GitHub README.md“ faile galite rasti kažką panašaus į: # Pagrindinis pavadinimas, ## Skyrius, ### PoskyrisIr tt

Kai „GitHub“ faile randa dvi ar daugiau antraščių, jis automatiškai sugeneruoja turinio lentelė Pasiekiama per piktogramą „Struktūra“ failo viršuje. Kiekviena antraštė rodoma kaip nuoroda, nukreipianti tiesiai į tą skyrių, o tai puikiai tinka ilgiems dokumentams.

Be to, kiekviena antraštė tampa vidiniu inkaru, į kurį galite pateikti nuorodą URL fragmentu, pagrįstu pavadinimo tekstu. Norėdamas sugeneruoti tą fragmentą, „GitHub“ taiko labai konkrečias taisykles: raides konvertuoja į mažąsias, tarpus pakeičia brūkšneliais, pašalina skyrybos ženklus ir formatavimo simbolius (pvz., kursyvą), apkerpa nereikalingus tarpus ir, jei rezultatas atitinka kitą ankstesnę antraštę, pridėti skaitinę priesagą (-1, -2 ir kt.), kad jis būtų unikalus.

Tai leidžia atlikti tokius veiksmus kaip sekcijos išdėstymas ## Pavyzdinė dalis ir tada į jį įterpti nuorodą iš kitos dokumento vietos, pavyzdžiui, tokią: (#pavyzdinė-sekcija)arba netgi susieti su skyriais, kurių pavadinime yra specialiųjų simbolių, nes „GitHub“ generuoja ištrauką pagal šias taisykles ir padaro ją prieinamą pagal tą patį modelį.

Akcentai, paryškintas tekstas ir citatos

„Markdown“ leidžia paryškinti tekstą įvairiais būdais pabrėžimasParyškintas, kursyvas, perbrauktas, apatinis, viršutinis arba pabrauktas. „GitHub“ platformoje tipinė stilių lentelė atrodytų maždaug taip, nors mes ją čia apibendrinome kitais žodžiais:

Norėdami įdėti tekstą drąsusParyškintas tekstas pateikiamas dvigubomis žvaigždutėmis arba dvigubais pabraukimais; kursyvui naudojamos vienos žvaigždutės arba pabraukimai; norint ką nors perbraukti, abiejose teksto pusėse rašoma dviguba tildė (dvi tildės). Taip pat galima derinti įdėtuosius paryškintuosius ir kursyvus, tris žvaigždutes galima naudoti, kad abu būtų taikomi visai teksto daliai, arba galima naudoti HTML žymes, pvz., <br>. _{y ^{apatiniams ir viršutiniams indeksams ir pabraukimams.}}

„GitHub“ taip pat leidžia kurti citatų blokų stiliaus Įtraukus didesnį nei simbolį (>) eilutės pradžioje, cituojamas tekstas rodomas su vertikalia pilka juosta kairėje, todėl jis aiškiai išsiskiria. Tame pačiame citatos bloke gali būti kelios eilutės, o kabutes netgi galima įterpti į vieną, pradžioje pridedant daugiau > simbolių.

Išplėstinė citavimo forma, egzistuojanti tik „GitHub“, yra įspėjimai arba įspėjimaiJie pagrįsti ta pačia citatų blokų sintakse, tačiau pirmoje eilutėje yra specialus žymeklis, nurodantis įspėjimo tipą. Pavyzdžiui, galite nurodyti „<įspėjimas>“ naudingai informacijai, „<naudingi patarimai>“ praktiniams patarimams, „<svarbiausi duomenys>“ pagrindiniams duomenims, „<skubūs pranešimai>“ skubiems įspėjimams ir „<įspėjimas>“ įspėjimams apie riziką ar neigiamas pasekmes. „GitHub“ kiekvieną tipą rodo skirtinga spalva ir piktograma, taip padėdamas dokumentacijoje paryškinti svarbią informaciją.

„Reddit“ taip pat palaiko paprastas kabutes su tuo pačiu simboliu >, nors jai trūksta „GitHub“ turtingos įspėjimų sistemos. Nepaisant to, tai išlieka labai naudingu būdu atsakymas kam nors cituojant ištrauką iš jo žinutės visiškai jo nekartojant.

Kodo paryškinimas, blokai ir spalvos

Ir „GitHub“, ir „Reddit“ leidžia paryškinti kodo fragmentus tekste naudojant grįžtamuosius ženklus. Įterptajame kode žodį arba komandą apsupate po vieną grįžtamąjį ženklą iš abiejų pusių. Tai idealiai tinka paryškinti, pavyzdžiui, git statusas sakinyje, aiškiai nurodant, kad tai yra įsakymas.

Kai reikia atskiro kodo bloko, „Markdown“ naudoja tris atgalines žymes: parašote eilutę su trimis atgalinėmis žymėmis, tada kodą atskirose eilutėse ir užbaigiate dar trimis atgalinėmis žymėmis. „GitHub“, jei iškart po pirmojo atgalinės žymės nurodote ir kalbą, ji taikoma... sintaksės paryškinimas su tai kalbai būdingomis spalvomis ir formatu.

„GitHub“ taip pat siūlo specialią funkciją paryškinimui spalvų vertės atgalinių žymeklių viduje. Jei tarp atgalinių žymeklių įvedate spalvą šešioliktainiu, RGB arba HSL formatu, platforma šalia teksto įtraukia nedidelį spalvos indikatorių. Pavyzdžiui, jei fono spalva šviesiu režimu yra #ffffff, o tamsiu režimu – #000000, paryškinus šiuos kodus, galite greitai pamatyti, kuri yra kuri.

Kalbant apie kodo ir lentelių vizualizaciją, „GitHub“ leidžia įjungti fiksuotą vienodo tarpo šriftą visuose komentarų laukuose, kad būtų patogiau dirbti su techniniu tekstu. Jei naršyklėje arba redaktoriuose, pvz., redaguojate daug kodo fragmentų Visual Studio Code Įjungus šią parinktį, tekstas lengviau lygiuojamas ir skaitomas. daug nuoseklesnis.

„Reddit“ taip pat palaiko kodo blokus su atgalinėmis žymėmis, tiek eilutėje, tiek bloke, nors jų naudojimas ten labiau orientuotas į mažus fragmentus ar pseudokodą, o ne į ilgą dokumentaciją, pavyzdžiui, saugyklos dokumentaciją.

Nuorodos, inkarai ir vidinė navigacija

Nuorodų kūrimas „Markdown“ programoje yra labai paprastas: vartotojui rodomas tekstas pateikiamas laužtiniuose skliaustuose, o URL – skliaustuose. Tai veikia tiek „GitHub“, tiek „Reddit“ platformose ir gali būti patobulinta naudojant „GitHub“ sparčiuosius klavišus (pavyzdžiui, naudojant klavišų derinius, norint greitai konvertuoti pažymėtą tekstą į nuorodą).

„GitHub“ prideda keletą papildomų funkcijų, susijusių su navigacija. Visų pirma, ji leidžia tiesiogiai susieti su antraštėmis naudojant anksčiau aptartas fragmentų generavimo taisykles. Be to, jis palaiko santykines nuorodas pačioje saugykloje, o tai yra labai svarbu techninėje dokumentacijoje.

Santykinė nuoroda yra tokia, kuri apskaičiuojama naudojant dabartinį failą kaip nuorodą. Pavyzdžiui, jei jūsų README yra projekto šakniniame kataloge ir norite susieti su failu docs/CONTRIBUTING.md, tiesiog parašykite nuorodą su keliu docs/CONTRIBUTING.md. „GitHub“ teisingai išverčia šią santykinę nuorodą bet kurioje jūsų atidarytoje šakoje, neleisdama jai nutrūkti keičiant šakas arba klonuojant saugyklą.

Rekomenduojama visada naudoti santykiniai keliai Norint naršyti tarp failų toje pačioje saugykloje, „GitHub“ leidžia naudoti standartinius operatorius, tokius kaip ./ arba ../, ir kelius, prasidedančius /, palyginti su projekto šaknimi, nes absoliučios nuorodos gali nustoti veikti klonuose ar atšakose.

Jei dokumente norite kurti pasirinktinius tvirtinimo taškus, be antraščių, galite naudoti HTML žymes su atributu „name“. Tai leidžia įterpti tikslinį tašką pastraipos viduryje arba šalia teksto, kuris neturi savo pavadinimo, ir susieti su juo naudojant tą pačią sintaksę kaip ir automatiškai generuojamoms antraštėms.

Vaizdai „GitHub“ platformoje: „Markdown“, HTML ir santykiniai keliai

„GitHub“ sistemoje vaizdai paprastai įterpiami naudojant tą pačią sintaksę kaip ir nuorodos, tačiau prieš juos dedamas šauktukas. Alternatyvus tekstas (alt) nurodomas laužtiniuose skliaustuose, o URL arba kelias į vaizdą – skliaustuose. Šis alternatyvus tekstas yra svarbus prieinamumasnes būtent tai perskaitys ekrano skaitytuvai ir kas bus rodoma, jei vaizdas neįsikels.

Vaizdai gali būti gaunami iš pačios saugyklos failų arba iš išorinių URL adresų. „GitHub“ leidžia naudoti kelis santykinius kelio šablonus vaizdams įkelti iš skirtingų šakų, kitų saugyklų ar net problemų ir komentarų, naudojant tokias priesagas kaip ?raw=true priverstinai atsisiųsti failą, kai to reikia.

Be standartinės „Markdown“ sintaksės, „GitHub“ palaiko HTML elemento naudojimą Šis daiktas ypač naudingas įkrovimui reaguojantys vaizdai Jie keičiasi atsižvelgiant į vartotojo temos nuostatas (šviesi arba tamsi). Naudodami medijos užklausą „prefers-color-scheme“, galite apibrėžti skirtingus vaizdo šaltinius kiekvienam režimui ir numatytąjį vaizdą naršyklėms, kurios nepalaiko šios funkcijos.

Tipinis modelis apima įtraukimą viduje keli elementai su savo „media“ ir „srcset“ atributais ir galiausiai a Naudodami „alt“ atributą ir bendrinį URL, vartotojai tamsiuoju režimu mato pritaikytą vaizdą, o šviesiuoju režimu – kitokį, nereikalaujant dubliuoti turinio README faile.

„GitHub“ taip pat palaiko HTML komentarus „Markdown“ failuose, leisdama jums pridėti nematomus priminimus skaitytojui, pavyzdžiui, priminti jam atnaujinti vaizdo skyrių arba vėliau pridėti naujų pavyzdžių.

Stalai, išlankstomos dalys ir turinio atskyrimas

Vienas naudingiausių „GitHub Flavored Markdown“ patobulinimų yra jo palaikymas lentosDuomenis galite suskirstyti į eilutes ir stulpelius, naudodami vertikalius brūkšnius langeliams atskirti ir punktyrinę liniją antraštei pažymėti. Taip pat galite sulygiuoti stulpelius dešinėje, kairėje arba centre, naudodami dvitaškį skiriamojoje eilutėje.

Lentelės yra labai naudingos pateikiant programavimo kalbų sąrašus, naudojamas sistemas, planuojamas užduotis, funkcijų palyginimus ar bet kokią kitą informaciją, kuriai naudinga matricinė struktūra. „GitHub“ šias lenteles pateikia švariu ir įskaitomu stiliumi.

Norėdami tvarkingai tvarkyti ilgą README failą, galite naudoti HTML žymę sukurti sulankstomas sekcijas. Šios sekcijos rodo santrauką etiketėje ir leisti vartotojui išsiplėsti arba susitraukti papildomas turinys pagal poreikį. Įprasta įterpti lenteles arba antrinės informacijos blokus kad neapkrautų akių.

Jei norite, kad sekcija pagal numatytuosius nustatymus būtų rodoma išplėsta, tiesiog pridėkite atributą „open“ Šis metodas yra labai praktiškas grupuojant reitingus, ilgus sąrašus arba turinį, kuris nėra būtinas pirmajam skaitymui, bet yra patogus, kad būtų prieinamas.

Dar vienas paprastas informacijos tvarkymo įrankis yra horizontalioji linija. Ji sukuriama parašant tris ar daugiau brūkšnių vienoje linijoje ir skirta nubrėžti skiriamąją liniją tarp skyrių, leidžiančią aiškiai atskirti, pavyzdžiui, aprašomąją dalį nuo nuorodų ar papildomų pastabų skyriaus.

Šias taisykles galima derinti su dokumento pabaigos citatomis, siekiant pabrėžti įkvepiančias frazes, priminimus ar pagrindines žinutes. Tipiškas pavyzdys būtų motyvuojančios citatos pateikimas profilio README pabaigoje, suformatuojant ją blokine citata po skiriamosios eilutės.

Paslėpti komentarai ir formato valdymas

„GitHub“ leidžia jums pristatyti HTML komentarai „Markdown“ sistemoje naudojant sintaksę Viskas, ką įvesite į tą komentarą, nebus rodoma pateiktame turinyje, bet bus matoma šaltinio kode, todėl tai idealiai tinka vidinėms pastaboms ar užduotims.

Pavyzdžiui, profilio README faile galite pridėti komentarą, pavyzdžiui, kad vėliau reikės išplėsti skyrių „Apie mane“ arba peržiūrėti pasenusių technologijų lentelę, niekam tiesiogiai nematant profilio lankytojų.

Dar viena naudinga funkcija yra ta, kad pabėgimo simboliai kuris paprastai būtų interpretuojamas kaip „Markdown“. Jei reikia žvaigždutes, grotažymės simbolius ar kitus simbolius rodyti tiesiogine prasme, jų nesuformatuojant, tiesiog prieš kiekvieną iš jų parašykite atgalinį brūkšnelį. Tai leidžia, pavyzdžiui, rašyti išraiškas, kuriose yra sąrašo simboliai, nekonvertuojant jų į tikrus sąrašus.

Kai peržiūrite žymėjimo failą „GitHub“, galite perjungti atvaizduotą rodinį ir šaltinio kodą naudodami mygtuką viršuje (arba atidaryti jį redaktoriuose, pvz., KilposIšjungus „Markdown“ interpretaciją, galite pasiekti įprastas kodo peržiūros funkcijas, pvz. konkrečios nuorodos eilutėsTai labai naudinga, kai norite nurodyti tikslią README arba bet kurio .md failo dalį.

Galiausiai atminkite, kad „GitHub“ skirtingai tvarko eilučių skirtukus komentaruose (problemose, PR ir kt.) ir .md failuose. Komentaruose eilučių skirtukai taikomi tiesiogiai, o „Markdown“ failuose eilutės pabaigoje reikia pridėti du tarpus, atgalinį brūkšnelį arba tašką. priverstinai peršokti toje pačioje pastraipoje.

Sąrašai, įdėtiniai sąrašai ir darbų sąrašai

Sąrašai yra vienas iš dažniausiai naudojamų „Markdown“ elementų, tiek „GitHub“, tiek „Reddit“. Galite kurti sąrašus netvarkingas prieš kiekvieną sąrašo elementą įrašant brūkšnelį, žvaigždutę arba pliuso ženklą. Visi šie ženklai pateikiami panašiai kaip ženkleliai.

Sąrašų generavimas užsakytaKiekviena eilutė numeruojama skaičiumi, po kurio seka taškas ir tarpas. Nors skaičių tvarka nebūtinai turi būti tobula („GitHub“ paprastai ją perskaičiuoja), patartina išlaikyti nuoseklią numeraciją, kad šaltinio kodas būtų skaitomas.

Įterptieji sąrašai sukuriami tiesiog pridedant įtrauką po jais esantiems elementams. Vienodo tarpo redaktoriuose, pvz., Sublime TekstasTiesiog vizualiai sulygiuokite įdėtuosius sąrašo žymeklius po pirmuoju teksto simboliu pagrindiniame elemente. Tokiuose kontekstuose kaip „GitHub“ komentarų redaktorius, kur šriftas nėra vienodo tarpo, suskaičiuokite simbolių skaičių prieš tekstą ir naudokite tą tarpų skaičių įtraukai.

Taip pat galite kurti kelis įdėjimo lygius, jei išlaikysite nuoseklų tarpų skaičių. Labai sudėtingiems sąrašams ši sistema reikalauja šiek tiek praktikos, bet įgudus ją pritaikyti labai greitai.

„GitHub“ taip pat siūlo darbų sąrašaiJie labai naudingi problemoms, užklausoms dėl išsiuntimo ir dokumentacijai. Jie sukuriami prieš brūkšnelį, tarpą ir porą laužtinių skliaustų įrašant tarpą arba „x“ viduje: laukiančioms užduotims ir užbaigtoms užduotims. Šie sąrašai pateikiami su žymimaisiais langeliais, kuriuos galima pažymėti arba panaikinti sąsajoje.

Jei darbų sąrašo elemento tekstas prasideda skliausteliuose, jis turi būti atskirtas atgaliniu brūkšniu, kad būtų išvengta painiavos analizatoriuje. Tai maža detalė, bet svarbi rašant aprašymus, kurie prasideda, pvz., „(Nebūtina)“ ar panašiai.

Paminėjimai, nuorodos ir jaustukai „GitHub“ platformoje

Vienas iš „Markdown“ rašymo „GitHub“ platformoje privalumų yra galimybė naudoti pamini Tiesiogiai siųskite žinutes platformos naudotojams ir komandoms. Tiesiog įveskite @, po kurio parašykite naudotojo vardą arba komandos pavadinimą, ir „GitHub“ išsiųs pranešimą į tą paskyrą, atkreipdama jų dėmesį į pokalbį.

Įvedus simbolį @, „GitHub“ rodo su saugykla arba gija susijusių vartotojų ir komandų sąrašą, kurį galite filtruoti rašydami. Norėdami priimti pasiūlymus, naudokite rodyklių klavišus ir paspauskite „Enter“ arba „Tab“. Komandoms naudokite formatą @organizacija/komandos-pavadinimas ir visi komandos nariai bus užsiprenumeravę giją.

Be paminėjimų, „GitHub“ palengvina nuorodų problemos ir užklausos dėl ištraukimo Tiesiog įveskite #, po kurio parašykite skaičių arba pavadinimo dalį. Atsiras siūlomų rezultatų sąrašas, kurį galite užpildyti taip pat, kaip ir paminėjimus. Tai labai pagreitina naršymą tarp susijusių pokalbių.

Jei jūsų saugykloje sukonfigūruotos pasirinktinės automatiškai susietos nuorodos, tam tikri išoriniai žymėjimai (pvz., JIRA arba „Zendesk“ bilietų ID) taip pat gali būti automatiškai konvertuojami į trumpąsias nuorodas. Šiam nustatymui reikalingos administratoriaus teisės, tačiau įjungus jį, galima minimaliomis pastangomis bendrinti duomenis tarp sistemų.

Galiausiai, „GitHub“ palaiko jaustukus per kodą: įveskite dvitaškį, po jo – jaustuko pavadinimą ir užbaikite dar vienu dvitaškiu. Pradėjus rašyti, rodomas pasiūlymų sąrašas, kurį galite priimti paspausdami Tab arba Enter. Jaustukų įtraukimas į komentarus suteikia jiems žmogiškesnį atspalvį, jei tik jų nepersistengiate naudodami oficialioje dokumentacijoje.

Išnašos ir išplėstinis turinys

„GitHub“ taip pat palaiko Išnašos Naudojama skliausteliais pagrįsta sintaksė ir identifikatorius su įterptu simboliu. Toje vietoje, kur norite nuorodos, įterpiate kažką panašaus į , o dokumento pabaigoje apibrėžiate tos pastabos tekstą ta pačia žyme, po to dedamas dvitaškis ir turinys.

Išnašos gali apimti kelias eilutes, o norint priverstinai pertraukti eilutes išnašoje, eilutės pabaigoje naudojami dvigubi tarpai, kaip ir pagrindinėje „Markdown“ teksto dalyje. Atvaizduojant „GitHub“ rodo viršutinį indeksą tekste ir išnašų sąrašą gale su atgalinėmis nuorodomis, skirtomis naršyti tarp nuorodų ir išnašų.

Dar viena pažangi „GitHub“ siūloma funkcija yra... įspėjimai Jie jau buvo aptarti (PASTABA, PATARIMAS, SVARBU, ĮSPĖJIMAS ir ATSARGIAI). Patartina juos naudoti tik tada, kai tai tikrai būtina, ir vengti per daug jų sujungti, kad neperkrautumėte skaitytojo. Jų negalima įterpti į kitus sudėtingus elementus, todėl labai svarbu atidžiai suplanuoti jų išdėstymą.

Galiausiai galite nurodyti „GitHub“ laikinai paslėpti atvaizduotos „Markdown“ dalys, jas apvyniojant HTML komentarais, arba ignoruoti tam tikrų simbolių apdorojimą su atgaliniais brūkšniais. Tai ypač naudinga dokumentuojant. „Markdown“ sintaksė Ir reikia rodyti pavyzdžius tokius, kokie jie yra, be jokių interpretacijų.

„Markdown“ „Reddit“ platformoje: „Snoomark“ ir redagavimo režimas

„Reddit“ yra diskusijų platforma, kurioje laukiamos beveik bet kokios temos, suskirstytos į subredditus. Kalbant apie formatavimą, joje siūlomi du redaktoriai: vienas – vizualesniam raiškiajam tekstui, o kitas – paprastam tekstui, pagrįstam „Markdown“. Jei norite dirbti greitai ir tiksliai kontroliuoti rezultatą, turėtumėte naudoti „Markdown“ parinktį.

Pagal numatytuosius nustatymus „Reddit“ paprastai įjungia raiškiojo teksto redaktorių, todėl norėdami perjungti žymėjimo režimą, turite spustelėti parinktį Žymėjimo režimas įrašo ar komentaro teksto laukelyje. Iš ten galite tiesiogiai naudoti „Snoomark“ sintaksę.

Jei norite, kad „Markdown“ redaktorius būtų įkeliamas visada, turėtumėte eiti į vartotojo nustatymus, įvesti skyrių „Sklaidos kanalo nustatymai“ ir suaktyvinti parinktį Numatytasis nustatymas pagal nuolaidąTokiu būdu, kiekvieną kartą pradėjus rašyti įrašą ar komentarą, „Markdown“ redaktorius atsidarys automatiškai, jums nereikės jo keisti rankiniu būdu.

„Reddit“ palaiko daugumą pagrindinių ir pažangiausių „Markdown“ funkcijų: antraštes, paryškintą ir kursyvinį šriftą, sąrašus, citatas, kodo blokus, nuorodas ir kai kuriuos savo priedus, pvz., spoilerius. Tačiau, palyginti su „GitHub“, ji turi didelių trūkumų, ypač... vaizdo valdymaskas labai priklauso nuo konteksto ir redaktoriaus tipo.

„Reddit“ palaikoma sintaksė ir spoileriai

„Reddit“ naudojamas „Snoomark“ variantas apima daug bendrų elementų su „GitHub“, todėl jei jau mokate naudotis „Markdown“ saugykloms, šių žinių perkėlimas į „Reddit“ aplinką yra gana paprastas. Galite naudoti antraštes ilgiems įrašams struktūrizuoti, sunumeruotus arba ženklintus sąrašus, citatas atsakyti kitiems vartotojams ir kodo blokus, kai norite rodyti komandas ar techninius fragmentus.

Vienas iš pastebimų skirtumų yra tai, kaip „Reddit“ tvarko vaizdaiNors daugeliu atvejų vaizdai įkeliami per grafinę sąsają, o ne tiesiogiai naudojant „Markdown“ sintaksę, teksto turinį apdorojantis variklis vis tiek yra „Snoomark“, todėl šių vaizdų formatavimas pagrįstas „Markdown“.

Kita vertus, „Reddit“ priduria, kad papildomi elementai kurie nėra standartinės specifikacijos dalis, pavyzdžiui, spoileriai. Jie leidžia paslėpti tekstą už sluoksnio, kurį vartotojas gali parodyti spustelėdamas. Techniškai, kai „Reddit“ apdoroja spoilerį, jis transformuojamas į HTML, CSS klasių ir konkrečiai platformai skirto „JavaScript“ derinį.

Gautame spoilerio HTML vaizde yra tvarkyklės, kurios kontroliuoja, kada rodyti arba slėpti turinį, ir nors teoriškai kažką panašaus būtų galima parašyti naudojant paprastą HTML, „Reddit“ tai priklauso nuo vidinio įgyvendinimo. Jums, kaip vartotojui, svarbu, kad rašant tereikėtų naudoti redaktoriaus pateiktą konkrečią spoilerio sintaksę, ir Už vertimą atsakingas „Snoomark“. į atitinkamą struktūrą.

Trumpai tariant, „Snoomark“ paveldi daugelį „GitHub Flavored Markdown“ funkcijų, tačiau yra orientuotos į diskusijų bendruomenės, o ne projekto dokumentacijos poreikius. Nepaisant to, esmė išlieka ta pati: paprastas tekstas su paprastais simboliais, paverstas struktūrizuotu ir lengvai skaitomu turiniu.

Įvaldę „Markdown“ sintaksę „GitHub“ ir „Reddit“ platformose, galite daug efektyviau rašyti techninę dokumentaciją, atidaryti gerai paaiškintas problemas, palikti aiškius komentarus apie užklausas ir dalyvauti „Reddit“ diskusijose. Laikydamiesi kelių pagrindinių taisyklių – antraštių, pabrėžimo, sąrašų, citatų, kodo blokų, nuorodų, vaizdų ir konkrečių gudrybių, tokių kaip lentelės, sulankstoma informacija, įspėjimai, išnašos ir spoileriai – galite pereiti nuo paprasto teksto rašymo prie kūrimo. švarus, lengvai nuskaitomas ir profesionalus turinys nepalietus nė vieno pelės mygtuko.