- Markdown võimaldab teil GitHubis ja Redditis kiiresti vormindada lihtteksti kerge ja hõlpsasti meeldejääva süntaksi abil.
- GitHub Flavored Markdown lisab tabeleid, ülesannete nimekirju, teateid, allmärkusi ja täpsemat navigeerimist jaotiste vahel.
- Reddit kasutab Snoomarki, mis on Markdowni variant, mis sarnaneb GitHubi omaga, kuid millel on sellised funktsioonid nagu spoilerid ja erinev viis piltide käsitlemiseks.
- Pealkirjade, loendite, tsitaatide, koodi, linkide ja piltide haldamine parandab oluliselt mis tahes sisu loetavust ja tõhusust mõlemal platvormil.
Kui kirjutad sageli GitHubis või veedad palju aega Redditis, on Markdowni valdamine üks neist asjadest, mis säästab tunde ja teeb su elu lihtsamaks. See on väga kerge märgistuskeel, mis võimaldab sul kiiresti vormindada lihtteksti ilma menüüde või nuppudega vaeva nägemata, vaid mõne sümboli õigetesse kohtadesse paigutamisega.
GitHubis leiad seda kõikjal: repositooriumi README.md failides , probleemides, pull requestides, aruteludes ja isegi sinu enda profiilis. Reddit seevastu kasutab varianti nimega Snoomark (Redditi stiilis Markdown), mis pärib suure osa GitHubi süntaksist, millel on mõned unikaalsed funktsioonid ja piirangud. Vaatame samm-sammult ja rohkete näidete abil, kuidas Markdowni GitHubis ja Redditis kiiresti ja olulist vahele jätmata kasutada.
Mis on Markdown ja miks see GitHubis ja Redditis nii kasulik on?
Markdown on kerge märgistuskeel, mis on loodud selleks, et muuta lihttekst hõlpsasti loetavaks ja kirjutatavaks ning võimaldada ka vaevata HTML-iks teisendamist. Praktikas tähendab see, et saate kirjutada tavalist teksti ja lisada mõned erimärgid pealkirjade, loendite, tabelite, tsitaatide, vormindatud koodi, linkide või piltide loomiseks.
GitHubis kasutatakse implementatsioonina GitHub Flavored Markdown (GFM), mis laiendab klassikalist süntaksit tabelite, ülesannete nimekirjade, täiustatud koodi esiletõstmise, värvitoe, teadete ja mõnede lubatud HTML-siltide abil. Kõik see renderdatakse automaatselt .md-failides ja platvormi kommentaariväljadel.
Reddit kasutab oma redaktorit nimega Snoomark, mis on GFM-i derivaat. See jagab paljusid põhifunktsioone (paks kiri, kursiiv, pealkirjad, loendid, tsitaadid, tekstisisene või plokkkood, lingid jne), kuid sellel on olulisi iseärasusi : näiteks piltide tugi on kontekstist olenevalt piiratum ja see lisab oma elemente, näiteks spoilereid.
Selle kõige ilu seisneb selles, et ühe süntaksi abil saab kirjutada tekste, mis näevad head välja nii GitHubis kui ka Redditis, kohandades vaid mõnda detaili, kus iga platvorm töötab erinevalt. Põhireeglite õppimine võimaldab mõlemas hõlpsalt navigeerida, ilma et peaks midagi nullist uuesti õppima.
Pealkirjad ja sisu struktuur
Üks esimesi asju, mida sa nii GitHubis kui ka Redditis kasutad, on pealkirjad . Need aitavad teksti osadeks ja alajaotisteks struktureerida.
Markdownis luuakse pealkiri, lisades teksti ette ühe kuni kuus räsisümbolit: üks 1. taseme pealkirja jaoks, kaks 2. taseme jaoks ja nii edasi kuni 6. tasemeni. Näiteks GitHubi README.md failis võib olla midagi sellist: # Main Title , ## Section , ### Subsection jne.
Kui GitHub leiab failist kaks või enam pealkirja, genereerib see automaatselt sisukorra, millele pääseb ligi faili ülaosas oleva ikooni „Struktuur” kaudu. Iga pealkiri kuvatakse lingina, mis viib otse vastavasse jaotisse, mis on suurepärane pikkade dokumentide puhul.
Lisaks saab igast pealkirjast sisemine ankur, millele saab pealkirja teksti põhjal URL-i koodijupi abil linkida. Selle koodijupi genereerimiseks rakendab GitHub väga spetsiifilisi reegleid: see teisendab tähed väiketähtedeks, asendab tühikud sidekriipsudega, eemaldab kirjavahemärgid ja vormindusmärgid (nt kursiiv), kärbib liigsed tühikud ja kui tulemus vastab mõnele varasemale pealkirjale, lisab numbrilise järelliite (-1, -2 jne), et muuta see unikaalseks.
See võimaldab teil näiteks lisada ## näidisjaotise ja seejärel sellele dokumendis mujalt lingiga (nt (#näidisjaotis)) linkida või isegi linkida jaotistele, mille pealkirjas on erimärgid, kuna GitHub genereerib koodilõigu nende reeglite järgi ja muudab selle sama mustri abil kättesaadavaks.
Rõhuasetus, esiletõstetud tekst ja tsitaadid
Markdown võimaldab teksti esile tõsta erinevate rõhutusviiside abil : paks kiri, kursiiv, läbikriipsutus, allindeks, ülaindeks või allakriipsutus. GitHubis näeks tüüpiline stiilitabel välja umbes selline, kuigi oleme selle siin kokku võtnud teisiti:
Teksti paksuks muutmiseks ümbritsege see kahe tärni või alakriipsuga; kursiivkirja jaoks kasutage ühte tärni või alakriipsu; läbikriipsutamiseks kasutage teksti mõlemal küljel kahekordset tildet. Samuti saate kombineerida pesastatud paksu ja kursiivi, kasutada kolme tärni, et rakendada mõlemat tervele tekstiosale, või kasutada HTML-silte, näiteks `<b>` ala- ja ülaindeksite jaoks ja `<i>` alakriipsude jaoks.
GitHub võimaldab teil luua ka tsitaadiplokke, lisades rea algusesse suurema sümboli (>). Tsiteeritud tekst kuvatakse vasakul vertikaalse triibuga ja hallina, mis muudab selle selgelt eristuvaks. Ühes tsitaadiplokis võib olla mitu rida ja isegi tsitaate saab pesastada, lisades rea algusesse rohkem > sümboleid.
GitHubile ainuomane täiustatud viitamisviis on hoiatus või hoiatus . See kasutab sama tsitaadiplokkide süntaksit, kuid esimesel real on spetsiaalne marker, mis tähistab hoiatuse tüüpi. Näiteks saate määrata „hoiatus“ kasuliku teabe, „kasulike näpunäidete“, „oluliste andmete“, „kiireloomuliste hoiatuste“ ja „riskide või negatiivsete tagajärgede hoiatuste“ jaoks. GitHub kuvab iga tüübi erineva värvi ja ikooniga, mis aitab teie dokumentatsioonis olulist teavet esile tõsta.
Reddit toetab ka lihtsaid tsitaate sama > sümboliga, kuigi sellel puudub GitHubi rikkalik ping-süsteem. Sellegipoolest on see väga kasulik viis kellelegi vastata, tsiteerides osa tema sõnumist ilma seda tervikuna kordamata.
Koodi esiletõstmine, plokid ja värvid
Nii GitHub kui ka Reddit võimaldavad tekstis koodijuppe tagurpidi märgendite abil esile tõsta. Tekstisisese koodi puhul ümbritsetakse sõna või käsk mõlemal küljel ühe tagurpidi märgetega. See sobib ideaalselt näiteks lauses oleva „ git status” esiletõstmiseks, et teha selgeks, et tegemist on käsuga.
Kui soovite eraldiseisvat koodiplokki, kasutab Markdown kolme tagasiulatuvat märget: kirjutate rea kolme tagasiulatuvastusega, seejärel koodi eraldi ridadele ja lõpetate veel kolme tagasiulatuvastusega. GitHubis, kui määrate kohe pärast esimesi tagasiulatuvaid märgendeid ka keele, rakendatakse sellele keelele omaseid värvide ja vorminguga süntaksi esiletõstmist .
GitHub pakub ka spetsiifilist funktsiooni värviväärtuste esiletõstmiseks tagakoodide sees. Kui sisestate tagakoodide vahele värvi kuueteistkümnendsüsteemis, RGB- või HSL-vormingus, lisab platvorm teksti kõrvale väikese värviindikaatori. Näiteks kui heledas režiimis on taustavärv #ffffff ja tumedas režiimis #000000, võimaldab nende koodide esiletõstmine teil kiiresti näha, milline on milline.
Koodi ja tabelite kuvamise osas võimaldab GitHub teil lubada fikseeritud monospace fondi kõigis kommentaariväljades, mis lihtsustab tehnilise tekstiga töötamist. Kui redigeerite oma brauseris või redaktorites, näiteks Visual Studio Code'is , palju koodijuppe , muudab selle valiku lubamine joonduse ja loetavuse palju ühtlasemaks.
Reddit toetab ka koodiplokke koos tagasipeegeldustega, nii rea sees kui ka plokkidena, kuigi nende kasutamine seal keskendub rohkem väikestele lõikudele või pseudokoodile kui pikale dokumentatsioonile nagu repositooriumil.
Linkide loomine Markdownis on väga lihtne: kasutajale kuvatav tekst lisatakse nurksulgudesse ja URL sulgudesse. See toimib nii GitHubis kui ka Redditis ning seda saab GitHubis kiirklahvidega täiustada (näiteks klahvikombinatsioonide abil valitud tekst kiiresti lingiks teisendada).
GitHub lisab mõned navigeerimisega seotud funktsioonid. Esiteks võimaldab see teil pealkirjadele otse linkida, kasutades eelnevalt käsitletud koodijuppide genereerimise reegleid. Teiseks toetab see repositooriumis endas suhtelisi linke, mis on tehnilise dokumentatsiooni jaoks ülioluline.
Suhteline link on selline, mis arvutatakse praeguse faili põhjal. Näiteks kui teie README-fail asub projekti juurkataloogis ja soovite linkida failile docs/CONTRIBUTING.md, kirjutate lihtsalt lingi teega docs/CONTRIBUTING.md. GitHub tõlgib selle suhtelise lingi õigesti igas harus, kus te parasjagu olete, hoides ära selle katkemise harude vahetamisel või repositooriumi kloonimisel.
Soovitus on sama repositooriumi failide vahel navigeerimisel alati kasutada suhtelisi teid , sest absoluutsed lingid võivad kloonides või forkides töötamast lakata. GitHub lubab kasutada standardseid operaatoreid nagu ./ või ../ ja teid, mis algavad projekti juurkataloogi suhtes /-ga.
Kui soovite dokumendis pealkirjadest kaugemale luua kohandatud kinnituspunkte, saate kasutada HTML-silte atribuudiga `name`. See võimaldab teil sihtpunkti paigutada lõigu keskele või teksti kõrvale, millel pole oma pealkirja, ja linkida sellele sama süntaksi abil nagu automaatselt genereeritud pealkirjade puhul.
GitHubi pildid: Markdown, HTML ja suhtelised teed
GitHubis manustatakse pildid üldiselt sama süntaksi abil nagu lingid, kuid neile eelneb hüüumärk. Alternatiivtekst (alt) on määratud nurksulgudes ja pildi URL või tee paigutatakse sulgudesse. See alternatiivtekst on oluline ligipääsetavuse tagamiseks , kuna see on see, mida ekraanilugejad ette loevad ja mis kuvatakse, kui pildi laadimine ebaõnnestub.
Pildid võivad pärineda repositooriumi enda failidest või välistelt URL-idelt. GitHub lubab piltide üleslaadimiseks erinevatest harudest, teistest repositooriumidest või isegi probleemidest ja kommentaaridest mitut suhtelist teemustrit, kasutades vajadusel sufikseid nagu ?raw=true, et sundida faili otse alla laadima.
Lisaks standardsele Markdowni süntaksile toetab GitHub HTML-i `<picture>` elemendi kasutamist. See element on eriti kasulik responsiivsete piltide laadimiseks , mis muutuvad vastavalt kasutaja teema-eelistustele (hele või tume). Meediapäringu `prefers-color-scheme` abil saate iga režiimi jaoks määratleda erinevad pildiallikad ja vaikepildi brauseritele, mis seda funktsiooni ei toeta.
Tüüpiline muster hõlmab kaasamist mitu elementi oma media ja srcset atribuutidega ning lõpuks a Kasutades alt atribuuti ja üldist URL-i, näevad tumedas režiimis kasutajad kohandatud pilti, heledas režiimis olevad aga teistsugust, ilma et peaksid README-faili sisu dubleerima.
GitHub toetab ka Markdown-failides HTML-kommentaare, mis võimaldavad teil lugejale lisada nähtamatuid meeldetuletusi, näiteks et tuletada neile meelde pildiosa värskendamist või uute näidete lisamist hiljem.
Lauad, lahtikäivad sektsioonid ja sisu eraldamine
Üks GitHub Flavored Markdowni kõige kasulikumaid täiustusi on tabelite tugi . Andmeid saab ridadesse ja veergudesse korraldada, kasutades lahtrite eraldamiseks vertikaalseid triipe ja päise tähistamiseks kriipsude rida. Samuti on võimalik veerge joondada paremale, vasakule või keskele, kasutades eraldusreas koolonit.
Tabelid on väga kasulikud programmeerimiskeelte, kasutatavate raamistike, kavandatud ülesannete, funktsioonide võrdluste või muu maatriksstruktuurist kasu saavat teabe loendite esitamiseks. GitHub kuvab need tabelid puhtas ja loetavas stiilis.
Pika README-faili korrastatuna hoidmiseks saate HTML-märgendi `<details>` abil luua kokkupandavaid sektsioone. Need sektsioonid kuvavad `<summary>` sildi sees kokkuvõtet ja võimaldavad kasutajal vajadusel lisasisu laiendada või ahendada . Tavapärane on lisada `<details>` sildi sisse tabeleid või teisese teabe plokke, et vältida esmapilgul kasutaja ülekoormamist.
Kui soovite, et jaotis kuvatakse vaikimisi laiendatult, lisage lihtsalt atribuut „open” See tehnika on väga praktiline edetabelite, pikkade nimekirjade või sisu rühmitamiseks, mis pole esmalugemiseks hädavajalik, kuid millele on mugav ligi pääseda.
Teine lihtne teabe korraldamise tööriist on horisontaaljoon. See luuakse kolme või enama kriipsu kirjutamisega ühele reale ja selle eesmärk on tõmmata sektsioonide vahele eraldusjoon, võimaldades teil näiteks kirjeldavat osa selgelt eraldada viidete või lisamärkuste sektsioonist.
Neid reegleid saab kombineerida dokumendi lõpu tsitaatidega, et esile tõsta inspireerivaid fraase, meeldetuletusi või põhisõnumeid. Tüüpiline näide oleks motiveeriva tsitaadi paigutamine oma profiili README faili lõppu, vormindatuna plokktsitaadiga pärast eraldusjoont.
Peidetud kommentaarid ja vormingu kontroll
GitHub võimaldab Markdownis HTML-kommentaare lisada süntaksi <!-- comment --> abil. Kommentaari sisse pandud sisu ei kuvata renderdatud sisus, kuid see on nähtav lähtekoodis, mistõttu on see ideaalne sisemiste märkmete või ülesannete jaoks.
Näiteks profiili README failis saate lisada kommentaari, mis ütleb midagi sellist, et peate hiljem laiendama jaotist „Minust” või et peate üle vaatama vananenud tehnoloogiate tabeli, ilma et keegi profiili külastaja seda otse näeks.
Teine kasulik funktsioon on põgenemismärgid , mida tavaliselt tõlgendataks Markdowni sümbolitena. Kui teil on vaja tärne, räsimärke või muid sümboleid kuvada sõna-sõnalt ilma neid vormindamata, lisage igaühe ette lihtsalt kaldkriips. See võimaldab teil näiteks kirjutada avaldisi, mis sisaldavad loendisümboleid, ilma neid tegelikeks loenditeks teisendamata.
Kui vaatate GitHubis märgistusfaili, saate ülaosas oleva nupu abil vahetada renderdatud vaate ja lähtekoodi vahel (või avada selle redaktorites, näiteks Bracketsis ). Markdowni interpretatsiooni keelamine võimaldab teil pääseda juurde tüüpilistele koodivaate funktsioonidele, näiteks konkreetsete ridade linkimisele , mis on väga kasulik, kui soovite esile tõsta README-faili või mis tahes .md-faili täpse osa.
Lõpuks pidage meeles, et GitHub käsitleb reavahetusi kommentaarides (probleemid, PR-id jne) ja .md-failides erinevalt. Kommentaarides arvestatakse reavahetustega otse, samas kui Markdown-failides peate rea lõppu lisama kaks tühikut, kaldkriipsu või punkti. sundida hüpet sama lõigu sees.
Loendid, pesastatud loendid ja ülesandeloendid
Loendid on ühed Markdowni enimkasutatavad elemendid nii GitHubis kui ka Redditis. Järjestamata loendeid saab luua , lisades iga loendiüksuse ette sidekriipsu, tärni või plussmärgi. Kõik need markerid renderduvad sarnaselt täpploendipunktidega.
Järjestatud loendite genereerimiseks nummerdage iga rida numbriga, millele järgneb punkt ja tühik. Kuigi numbrite järjekord ei pea olema täiuslik (GitHub arvutab selle tavaliselt uuesti), on hea mõte säilitada ühtne nummerdamine, et lähtekood oleks loetav.
Pesastatud loendid luuakse lihtsalt nende all olevate üksuste taandamist kasutades. Püsisammulistes redaktorites, näiteks Sublime Textis , tuleb pesastatud loendimarkerid lihtsalt visuaalselt joondada ülemüksuse teksti esimese tähemärgi alla. Sellistes kontekstides nagu GitHubi kommentaariredaktor, kus font ei ole püsisammuline, tuleks lugeda teksti ees olevate tähemärkide arv ja kasutada taande jaoks seda arvu tühikuid.
Samuti saate luua mitu pesastamise taset, kui säilitate tühikute arvu järjepidevuse. Väga keerukate loendite puhul nõuab see süsteem veidi harjutamist, kuid kui olete selle selgeks saanud, on see väga kiire rakendama.
GitHub pakub ka ülesannete loendeid , mis on väga kasulikud probleemide, pull requestide ja dokumentatsiooni jaoks. Need luuakse, lisades loendi ette sidekriipsu, tühiku ja nurksulgude paari, mille sees on tühik või "x": üks ootel ülesannete ja teine lõpetatud ülesannete jaoks. Need loendid kuvatakse märkeruutudega, mida saab liidese kaudu valida või tühistada.
Kui ülesannete loendi üksuse tekst algab sulgudega, tuleb see parseris segaduse vältimiseks kaldkriipsuga asendada. See on väike detail, kuid oluline kirjelduste kirjutamisel, mis algavad näiteks sõnadega "(Valikuline)" või sarnasega.
Mainimised, viited ja emotikonid GitHubis
Üks GitHubis Markdownis kirjutamise eeliseid on võimalus platvormil otse kasutajaid ja meeskondi mainida . Lihtsalt tippige @-märk, millele järgneb kasutajanimi või meeskonna nimi, ja GitHub saadab sellele kontole teate, juhtides nende tähelepanu vestlusele.
Kui sisestate @-sümboli, kuvab GitHub repositooriumi või teemaga seotud kasutajate ja meeskondade loendi ning saate seda loendit tippimise ajal filtreerida. Soovituste kinnitamiseks kasutage nooleklahve ja vajutage sisestusklahvi (Enter) või tabeldusklahvi (Tab). Meeskondade puhul kasutage vormingut @organisatsioon/meeskonna-nimi ja kõik meeskonnaliikmed tellitakse teemale.
Lisaks mainimistele muudab GitHub probleemidele viitamise ja pull-requestide esitamise lihtsaks , sisestades lihtsalt #, millele järgneb number või osa pealkirjast. Ilmub soovitatud tulemuste loend, mille saate täita samamoodi nagu mainimiste puhul. See kiirendab oluliselt seotud vestluste vahelist navigeerimist.
Kui teie repositooriumil on konfigureeritud kohandatud automaatselt lingitud viited, võidakse teatud välised märgendid (näiteks JIRA või Zendeski piletite ID-d) samuti automaatselt lühikesteks linkideks teisendada. See säte nõuab administraatoriõigusi, kuid kui see on lubatud, võimaldab see süsteemidevahelist andmete jagamist minimaalse vaevaga.
Lõpuks toetab GitHub emotikone koodi kaudu: tippige koolon, millele järgneb emotikoni nimi ja lõpetage teise kooloniga. Tippima hakates kuvatakse soovituste loend, mille saate Tab või Enter abil vastu võtta. Emotikonide lisamine kommentaaridesse annab neile inimlikuma ilme, kui te neid ametlikus dokumentatsioonis üle ei kasuta.
Joonealused märkused ja täiustatud sisu
GitHub toetab ka allmärkusi, mis kasutavad sulgudel põhinevat süntaksit ja identifikaatorit koos kaldkriipsuga. Kohta, kuhu soovite viidet lisada, sisestage midagi sellist nagu `<allmärkus>` ja dokumendi lõpus defineerige selle allmärkuse tekst sama sildiga, millele järgneb koolon ja sisu.
Allmärkused võivad ulatuda mitmele reale ja allmärkuses reavahetuste sundimiseks kasutatakse rea lõpus topelttühikuid, nagu ka Markdowni põhitekstis. Renderdamisel kuvab GitHub teksti peal ülaindeksi ja lõpus allmärkuste loendi koos tagasilinkidega viidete ja allmärkuste vahel navigeerimiseks.
Teine GitHubi pakutav täiustatud funktsioon on eelnevalt mainitud hoiatused (MÄRKUS, NÕUANNE, TÄHTIS, HOIATUS ja ETTEVAATUST). Soovitatav on neid kasutada ainult siis, kui see on tõesti vajalik, ja vältida liiga paljude hoiatuste ühendamist, et mitte lugejat üle koormata. Neid ei saa teiste keerukate elementide sisse pesastada, seega on nende paigutamisel oluline hoolikas planeerimine.
Lõpuks saate paluda GitHubil ajutiselt peita renderdatud Markdowni osi, mähkides need HTML-kommentaaridesse, või ignoreerida teatud märkide töötlemist kaldkriipsude abil. See on eriti kasulik siis, kui dokumenteerite Markdowni süntaksit ennast ja peate näiteid kuvama olemasoleval kujul, ilma interpretatsioonita.
Markdown Redditis: Snoomark ja redigeerimisrežiim
Reddit on aruteluplatvorm, kus on teretulnud peaaegu kõik teemad, mis on korraldatud alamredditidesse. Vorminduse osas pakub see kahte redaktorit: üks visuaalsema rikkaliku teksti jaoks ja teine Markdownil põhineva lihtteksti jaoks. Kui soovite kiiresti töötada ja tulemust täpselt kontrollida, peaksite kasutama Markdowni valikut.
Vaikimisi aktiveerib Reddit tavaliselt rikkaliku teksti redaktori, seega märgistusrežiimi lülitumiseks peate postituse või kommentaari tekstikastis klõpsama Markdowni režiimi valikul. Sealt saate otse Snoomarki süntaksit kasutada.
Kui eelistad, et Markdowni redaktor laadiks alati, mine oma kasutajaseadetesse, ava jaotis „Veo seaded” ja luba valik „Vaikimisi Markdown” . Nii avaneb Markdowni redaktor automaatselt iga kord, kui hakkad postitust või kommentaari kirjutama, ilma et peaksid seda käsitsi muutma.
Reddit toetab enamikku Markdowni põhilisi ja täiustatud funktsioone: pealkirju, paksu ja kursiivi, loendeid, tsitaate, koodiplokke, linke ja mõningaid oma lisafunktsioone, näiteks spoilereid. Sellel on aga GitHubiga võrreldes olulisi puudusi, eriti piltide käsitlemisel , mis sõltub suuresti kontekstist ja redaktori tüübist.
Redditi toetatud süntaks ja spoilerid
Redditi kasutatav Snoomarki variant sisaldab palju GitHubiga ühiseid elemente, seega kui olete Markdown for repositooriumidega juba vilunud, on nende teadmiste ülekandmine Redditi keskkonda üsna lihtne. Pikkade postituste struktureerimiseks saate kasutada pealkirju, nummerdatud või täpploendeid, teistele kasutajatele vastamiseks tsitaate ja koodiplokke käskude või tehniliste lõikude kuvamiseks.
Üks tähelepanuväärne erinevus on see, kuidas Reddit pilte käsitleb . Kuigi paljudel juhtudel laaditakse pildid üles graafilise liidese kaudu, mitte otse Markdowni süntaksit kasutades, on tekstisisu töötlev mootor ikkagi Snoomark, seega põhineb nende piltide vormindamine tõepoolest Markdownil.
Reddit seevastu lisab standardspetsifikatsioonis mittesisalduvaid funktsioone , näiteks spoilerid. Need võimaldavad teksti peita kihi taha, mille kasutaja saab klõpsuga nähtavale tuua. Tehnilises mõttes teisendab Reddit spoileri töötlemisel selle HTML-i, CSS-klasside ja platvormispetsiifilise JavaScripti kombinatsiooniks.
Saadud spoileri HTML-esituse hulka kuuluvad käitlejad, mis kontrollivad sisu kuvamist või peitmist, ja kuigi teoreetiliselt saaks midagi sarnast kirjutada ka tavalise HTML-iga, sõltub see Redditis selle sisemisest implementatsioonist. Kasutajana on oluline, et kirjutamisel peate kasutama ainult redaktori pakutavat spoileri süntaksit ja Snoomark hoolitseb selle tõlkimise eest sobivasse struktuuri.
Lühidalt, Snoomark pärib palju käitumist GitHub Flavored Markdownilt, kuid on suunatud pigem arutelukogukonna kui projekti dokumentatsiooni vajadustele. Sellegipoolest jääb tuum samaks: lihttekst lihtsate sümbolitega, mis on teisendatud struktureeritud ja loetavaks sisuks.
Markdowni süntaksi valdamine GitHubis ja Redditis muudab tehnilise dokumentatsiooni kirjutamise, hästi selgitatud probleemide avamise, selgete kommentaaride jätmise pull requestidele ja Redditi aruteludes osalemise palju tõhusamaks. Mõne põhireegli abil – pealkirjad, rõhuasetus, loendid, tsitaadid, koodiplokid, lingid, pildid ja konkreetsed nipid nagu tabelid, kokkupandavad detailid, teated, allmärkused ja spoilerid – saate liikuda igavate sõnumite kirjutamisest puhta, skannitava ja professionaalse sisu loomiseni ilma ühegi hiireklõpsuta.
