Ako rýchlo používať Markdown na GitHub a Reddit

Informatec Digital » Zdroje » Ako rýchlo používať Markdown na GitHub a Reddit

Ak pravidelne píšete na GitHub alebo trávite veľa času na Reddite, mastering Markdown Je to jedna z tých vecí, ktoré vám ušetria hodiny a uľahčia život. Je to veľmi ľahký značkovací jazyk, ktorý vám umožňuje rýchlo formátovať obyčajný text bez toho, aby ste sa museli trápiť s ponukami alebo tlačidlami, len s niekoľkými symbolmi umiestnenými na správnych miestach.

Na GitHube to nájdete všade: v súboroch README.md z repozitárov, problémov, pull requestov, diskusií a dokonca aj z vášho vlastného profilu. Reddit používa variant s názvom Snoomark (Markdown v štýle Redditu), ktorý zdedí veľkú časť syntaxe GitHubu s niektorými jedinečnými funkciami a určitými obmedzeniami. Pozrime sa krok za krokom a s mnohými príkladmi, Ako rýchlo používať Markdown na GitHub a Reddit a bez toho, aby sa vynechalo čokoľvek dôležité.

Čo je Markdown a prečo je taký užitočný na GitHub a Reddit?

Markdown je a ľahký značkovací jazyk Navrhnuté tak, aby obyčajný text bol ľahko čitateľný a písaný a zároveň umožňoval jednoduchú konverziu do formátu HTML. V praxi to znamená, že môžete písať bežný text a pridávať špeciálne znaky na vytváranie nadpisov, zoznamov, tabuliek, citácií, formátovaného kódu, odkazov alebo obrázkov.

Na GitHube sa používa implementácia GitHub Flavored Markdown (GFM), ktorá rozširuje klasickú syntax o tabuľky, zoznamy úloh, pokročilé zvýrazňovanie kódu, podporu farieb, upozornenia a niektoré povolené HTML značky. Toto všetko sa vykresľuje automaticky v súboroch .md a v poliach komentárov platformy.

Reddit používa vlastný procesor s názvom Snoomark, derivát GFM. Zdieľa väčšinu základného správania (tučné písmo, kurzíva, nadpisy, zoznamy, citácie, vložený alebo blokový kód, odkazy atď.), ale má dôležité vlastnostiNapríklad podpora obrázkov je obmedzenejšia v závislosti od kontextu a pridáva vlastné prvky, ako sú spoilery.

Krása toho všetkého spočíva v tom, že s jedinou syntaxou môžete písať texty, ktoré vyzerajú dobre na GitHube aj Reddite, pričom upravíte len niekoľko detailov tam, kde každá platforma funguje inak. Naučte sa základné pravidlá Umožňuje vám voľne sa pohybovať v oboch bez toho, aby ste sa museli čokoľvek učiť od začiatku.

Nadpisy a štruktúra obsahu

Jednou z prvých vecí, ktoré použijete, je záhlavieNa GitHub aj Reddite sa používajú na štruktúrovanie textu do sekcií a podsekcií.

V Markdowne sa nadpis vytvorí tak, že sa pred text umiestni jeden až šesť symbolov mriežky: jeden pre nadpis úrovne 1, dva pre úroveň 2 atď. až do úrovne 6. Napríklad v súbore GitHub README.md môžete mať niečo ako: # Hlavný názov, ## Sekcia, ### Podsekcia, Atď

Keď GitHub nájde v súbore dve alebo viac hlavičiek, automaticky vygeneruje obsah Prístupné cez ikonu „Osnova“ v hornej časti súboru. Každý nadpis sa zobrazuje ako odkaz, ktorý vás presmeruje priamo do danej sekcie, čo je skvelé pre dlhé dokumenty.

Okrem toho sa každý nadpis stáva internou kotvou, na ktorú môžete odkazovať pomocou úryvku URL adresy na základe textu nadpisu. Na generovanie tohto úryvku GitHub používa veľmi špecifické pravidlá: konvertuje písmená na malé písmená, nahrádza medzery pomlčkami, odstraňuje interpunkčné a formátovacie znaky (napríklad kurzívu), oreže prebytočné medzery a ak sa výsledok zhoduje s iným predchádzajúcim nadpisom, pridať číselnú príponu (-1, -2 atď.), aby bol jedinečný.

To vám umožňuje robiť veci ako umiestnenie sekcie ## Ukážková sekcia a potom naň vytvorte odkaz z iného miesta v dokumente pomocou tohto odkazu: (#sample-section)alebo dokonca odkazovať na sekcie so špeciálnymi znakmi v názve, pretože GitHub generuje úryvok kódu podľa týchto pravidiel a sprístupňuje ho pomocou rovnakého vzoru.

Zvýraznenie, zvýraznený text a citácie

Markdown umožňuje zvýrazňovať text rôznymi metódami dôrazTučné písmo, kurzíva, prečiarknuté, dolný index, horný index alebo podčiarknutie. Na GitHub by typická tabuľka štýlov vyzerala približne takto, hoci sme ju tu zhrnuli inými slovami:

Vloženie textu tučneTučný text sa uzatvára do dvojitých hviezdičiek alebo dvojitých podčiarkovníkov; pre kurzívu sa používajú jednoduché hviezdičky alebo podčiarkovníky; na prečiarknutie sa na každú stranu textu umiestni dvojitá vlnovka (dve vlnovky). Vnorené tučné písmo a kurzívu je možné aj kombinovať, tri hviezdičky sa dajú použiť na použitie oboch na celú časť textu alebo sa dajú použiť značky HTML, ako napríklad <br>. _{y ^{pre dolné a horné indexy a na podčiarknutie.}}

GitHub vám tiež umožňuje vytvárať citáty v štýle blokových citátov Umiestnením symbolu väčšie ako (>) na začiatok riadku sa citovaný text zobrazí so zvislou čiarou vľavo a sivou farbou, vďaka čomu jasne vynikne. Do toho istého bloku citácií je možné zahrnúť viacero riadkov a citácie je možné dokonca vnoriť pridaním ďalších symbolov > na začiatok.

Pokročilá forma citovania, ktorá existuje iba na GitHube, je upozornenia alebo napomenutiaSú založené na rovnakej syntaxi blokových citátov, ale prvý riadok obsahuje špeciálny marker na označenie typu upozornenia. Môžete napríklad zadať `<alert>` pre užitočné informácie, `<helpful tips>` pre praktické rady, `<key data>` pre kľúčové údaje, `<urgent notices>` pre urgentné upozornenia a `<alert>` pre upozornenia na riziká alebo negatívne dôsledky. GitHub zobrazuje každý typ inou farbou a ikonou, čo pomáha zvýrazniť dôležité informácie v dokumentácii.

Reddit tiež podporuje jednoduché úvodzovky s rovnakým symbolom >, hoci mu chýba bohatý systém upozornení GitHubu. Napriek tomu zostáva veľmi užitočným spôsobom odpovedať niekomu citovaním časti jeho správy bez toho, aby som to úplne zopakoval.

Zvýrazňovanie kódu, bloky a farby

GitHub aj Reddit umožňujú zvýrazňovať úryvky kódu v texte pomocou spätných čiarok. V prípade vloženého kódu uzatvárate slovo alebo príkaz jednou spätnou čiarkou na každej strane. To je ideálne na zvýraznenie napríklad git status vo vete, čím sa jasne uvedie, že ide o príkaz.

Keď chcete samostatný blok kódu, Markdown používa tri spätné anuity: napíšete riadok s tromi spätnými anuitami, potom kód na samostatných riadkoch a uzatvárate ďalšími tromi spätnými anuitami. Na GitHub, ak hneď za prvými spätnými anuitami zadáte aj jazyk, platí to... zvýraznenie syntaxe s farbami a formátom špecifickým pre daný jazyk.

GitHub tiež ponúka špecifickú funkciu na zvýrazňovanie farebné hodnoty v rámci spätných atrakcií. Ak medzi spätné atraky zadáte farbu v hexadecimálnom, RGB alebo HSL formáte, platforma zobrazí vedľa textu malý indikátor farby. Napríklad, ak je farba pozadia v svetlom režime #ffffff a v tmavom režime #000000, zvýraznenie týchto kódov vám umožní rýchlo zistiť, ktorá je ktorá.

Pokiaľ ide o vizualizáciu kódu a tabuliek, GitHub umožňuje povoliť fixné písmo s monospace vo všetkých poliach komentárov, aby sa práca s technickým textom spríjemnila. Ak upravujete veľa úryvkov kódu vo svojom prehliadači alebo v editoroch, ako napríklad Kód Visual StudioPovolenie tejto možnosti uľahčuje zarovnanie a čítanie. oveľa súdržnejšie.

Reddit tiež podporuje bloky kódu so spätnými averziami, a to ako inline, tak aj blokové, hoci ich použitie sa tam zameriava skôr na malé úryvky alebo pseudokód než na dlhú dokumentáciu, ako je napríklad dokumentácia v repozitári.

Odkazy, kotvy a interná navigácia

Vytváranie odkazov v Markdowne je veľmi jednoduché: text, ktorý sa má zobraziť používateľovi, uzatvoríte do hranatých zátvoriek a URL adresu do zátvorky. Funguje to na GitHub aj Reddit a dá sa to vylepšiť klávesovými skratkami na GitHub (napríklad pomocou klávesových kombinácií rýchlo previesť vybraný text na odkaz).

GitHub pridáva niektoré ďalšie funkcie súvisiace s navigáciou. V prvom rade umožňuje priamy odkaz na nadpisy pomocou pravidiel generovania fragmentov, ktoré boli spomenuté vyššie. Okrem toho podporuje relatívne prepojenia v rámci samotného repozitára, čo je kľúčové v technickej dokumentácii.

Relatívny odkaz je odkaz, ktorý sa vypočíta s použitím aktuálneho súboru ako referencie. Napríklad, ak sa váš súbor README nachádza v koreňovom adresári projektu a chcete prepojiť súbor docs/CONTRIBUTING.md, jednoducho napíšete odkaz s cestou docs/CONTRIBUTING.md. GitHub sa postará o správny preklad tohto relatívneho odkazu v akejkoľvek vetve, na ktorej sa nachádzate, čím zabráni jeho poškodeniu pri prepínaní vetiev alebo klonovaní repozitára.

Odporúčanie je vždy používať relatívne cesty Na navigáciu medzi súbormi v rámci toho istého repozitára, pretože absolútne odkazy môžu prestať fungovať v klonoch alebo forkoch, GitHub umožňuje použitie štandardných operátorov ako ./ alebo ../ a ciest začínajúcich na / vzhľadom na koreň projektu.

Ak chcete v dokumente vytvoriť vlastné kotviace body nad rámec nadpisov, môžete použiť značky HTML s atribútom `name`. To vám umožňuje umiestniť cieľový bod do stredu odseku alebo vedľa textu, ktorý nemá vlastný nadpis, a prepojiť ho pomocou rovnakej syntaxe ako pre automaticky generované nadpisy.

Obrázky na GitHub: Markdown, HTML a relatívne cesty

Na GitHub sa obrázky vo všeobecnosti vkladajú pomocou rovnakej syntaxe ako odkazy, ale s výkričníkom. Alternatívny text (alt) je uvedený v hranatých zátvorkách a URL adresa alebo cesta k obrázku je umiestnená v zátvorkách. Tento alternatívny text je dôležitý pre prístupnosťpretože to je to, čo čítačky obrazovky prečítajú a čo sa zobrazí, ak sa obrázok nenačíta.

Obrázky môžu pochádzať zo súborov v samotnom repozitári alebo z externých URL adries. GitHub umožňuje viacero vzorov relatívnych ciest na nahrávanie obrázkov z rôznych vetiev, iných repozitárov alebo dokonca problémov a komentárov pomocou prípon ako napríklad ?raw=true v prípade potreby vynútiť priame stiahnutie súboru.

Okrem štandardnej syntaxe Markdownu podporuje GitHub aj použitie elementu HTML. Táto položka je obzvlášť užitočná na nabíjanie responzívne obrázky Tieto sa menia podľa preferencií témy používateľa (svetlá alebo tmavá). Pomocou mediálneho dopytu `prefers-color-scheme` môžete definovať rôzne zdroje obrázkov pre každý režim a predvolený obrázok pre prehliadače, ktoré túto funkciu nepodporujú.

Typický vzorec zahŕňa zahrnutie v rámci niekoľko prvkov s atribútmi media a srcset a nakoniec a Pomocou atribútu alt a generickej URL adresy vidia používatelia v tmavom režime upravený obrázok, zatiaľ čo používatelia v svetlom režime dostanú iný, bez toho, aby museli duplikovať obsah v súbore README.

GitHub tiež podporuje HTML komentáre v súboroch Markdown, čo vám umožňuje pridať čitateľovi neviditeľné pripomienky, napríklad na pripomenutie aktualizácie sekcie obrázka alebo neskoršieho pridania nových príkladov.

Tabuľky, rozkladacie časti a oddelenie obsahu

Jedným z najužitočnejších vylepšení v GitHub Flavored Markdown je jeho podpora pre kresliťDáta môžete usporiadať do riadkov a stĺpcov pomocou zvislých čiar na oddelenie buniek a prerušovanej čiary na označenie hlavičky. Stĺpce môžete tiež zarovnať doprava, doľava alebo na stred pomocou dvojbodky v oddeľovacom riadku.

Tabuľky sú veľmi užitočné na prezentáciu zoznamov programovacích jazykov, použitých frameworkov, plánovaných úloh, porovnaní funkcií alebo akýchkoľvek iných informácií, ktoré profitujú z maticovej štruktúry. GitHub vykresľuje tieto tabuľky v čistom a čitateľnom štýle.

Na usporiadanie dlhého súboru README môžete použiť značku HTML vytvoriť zbaliteľné sekcie. Tieto sekcie zobrazujú súhrn v rámci označenia a umožniť používateľovi rozšíriť alebo zmenšiť ďalší obsah podľa potreby. Je bežné uzatvárať tabuľky alebo bloky sekundárnych informácií do aby sa predišlo preťaženiu oka.

Ak chcete, aby sa sekcia štandardne zobrazovala rozbalená, jednoducho pridajte atribút open k Táto technika je veľmi praktická na zoskupovanie rebríčkov, dlhých zoznamov alebo obsahu, ktorý nie je nevyhnutný pre prvé čítanie, ale je vhodné mať ho ľahko dostupný.

Ďalším jednoduchým nástrojom na organizáciu informácií je horizontálne pravítko. Vytvorí sa napísaním troch alebo viacerých čiarok na čiaru a slúži na nakreslenie deliacej čiary medzi sekciami, čo umožňuje jasne oddeliť napríklad popisnú sekciu od sekcie s odkazmi alebo dodatočnými poznámkami.

Tieto pravidlá je možné kombinovať s citátmi na konci dokumentu na zvýraznenie inšpiratívnych fráz, pripomienok alebo kľúčových posolstiev. Typickým príkladom by bolo umiestnenie motivačného citátu na koniec súboru README vášho profilu, formátovaného s blokovým citátom za oddeľovacou čiarou.

Skryté komentáre a ovládanie formátu

GitHub vám umožňuje predstaviť HTML komentáre v rámci Markdownu pomocou syntaxe Čokoľvek, čo vložíte do tohto komentára, sa nezobrazí vo vykreslenom obsahu, ale bude to viditeľné v zdrojovom kóde, takže je to ideálne pre interné poznámky alebo úlohy.

Napríklad v súbore README profilu môžete pridať komentár, ktorý hovorí niečo ako „neskôr potrebujete rozšíriť sekciu „O mne““ alebo „potrebujete si prezrieť tabuľku zastaraných technológií“, bez toho, aby ju niekto, kto navštívil profil, videl priamo.

Ďalšou užitočnou funkciou je únikové znaky čo by sa normálne interpretovalo ako Markdown. Ak potrebujete zobraziť hviezdičky, mriežky alebo iné symboly doslovne bez toho, aby boli formátované, jednoducho pred každý z nich umiestnite spätné lomítko. To vám napríklad umožní písať výrazy, ktoré obsahujú symboly zoznamu bez toho, aby ste ich konvertovali na skutočné zoznamy.

Keď si na GitHube prezeráte súbor so značkami, máte možnosť prepínať medzi vykresleným zobrazením a zdrojovým kódom pomocou tlačidla v hornej časti (alebo ho otvoriť v editoroch ako KonzolyZakázanie interpretácie Markdownu vám umožní prístup k typickým funkciám zobrazenia kódu, ako napríklad prepojiť konkrétne riadkyToto je veľmi užitočné, keď chcete ukázať na presnú časť súboru README alebo ľubovoľného súboru .md.

Nakoniec nezabudnite, že GitHub spracováva zalomenia riadkov odlišne v komentároch (problémy, PR atď.) a v súboroch .md. V komentároch sa zalomenia riadkov rešpektujú priamo, zatiaľ čo v súboroch Markdown je potrebné na koniec riadku pridať dve medzery, spätné lomítko alebo bodku. vynútiť skok v rámci toho istého odseku.

Zoznamy, vnorené zoznamy a zoznamy úloh

Zoznamy sú jedným z najpoužívanejších prvkov v Markdowne, a to ako na GitHub, tak aj na Reddite. Môžete vytvárať zoznamy. neusporiadaný umiestnením spojovníka, hviezdičky alebo znamienka plus pred každú položku zoznamu. Všetky tieto značky sa zobrazujú podobne ako odrážky.

Generovanie zoznamov objednalKaždý riadok je očíslovaný číslom, za ktorým nasleduje bodka a medzera. Hoci poradie čísel nemusí byť dokonalé (GitHub ho zvyčajne prepočíta), je vhodné zachovať konzistentné číslovanie, aby bol zdrojový kód čitateľný.

Vnorené zoznamy sa vytvárajú jednoduchým pridaním odsadenia k položkám pod nimi. V editoroch s rovnakým rozstupom, ako napríklad Sublime TextJednoducho zarovnajte vnorené značky zoznamu vizuálne pod prvý znak textu v nadradenom elemente. V kontextoch, ako je editor komentárov GitHub, kde písmo nie je monospacedované, spočítajte počet znakov pred textom a tento počet medzier použite na odsadenie.

Môžete tiež vytvoriť viacero úrovní vnorenia, pokiaľ zachováte konzistentnosť v počte medzier. Pri veľmi zložitých zoznamoch si tento systém vyžaduje trochu cviku, ale akonáhle si ho osvojíte, je veľmi rýchle ho aplikovať.

GitHub tiež ponúka zoznamy úlohTieto sú veľmi užitočné pre úlohy, žiadosti o zmeny a dokumentáciu. Vytvárajú sa tak, že pred ne umiestnite pomlčku, medzeru a pred hranaté zátvorky medzeru alebo „x“: pre čakajúce úlohy a pre dokončené úlohy. Tieto zoznamy sa zobrazujú so začiarkavacími políčkami, ktoré je možné začiarknuť alebo zrušiť začiarknutie v rozhraní.

Ak text položky zoznamu úloh začína zátvorkami, musí byť ukončený spätným lomítkom, aby sa predišlo nejasnostiam v analyzátore. Je to malý detail, ale dôležitý pri písaní popisov, ktoré začínajú niečím ako „(Voliteľné)“ alebo podobne.

Zmienky, referencie a emoji na GitHube

Jednou z výhod písania v Markdowne na GitHube je možnosť používať zmieňuje Priame správy používateľom a tímom na platforme. Stačí napísať @ a za ním používateľské meno alebo názov tímu a GitHub pošle upozornenie na daný účet, čím upúta ich pozornosť na konverzáciu.

Keď zadáte symbol @, GitHub zobrazí zoznam používateľov a tímov priradených k repozitáru alebo vláknu a tento zoznam môžete počas písania filtrovať. Na prijatie návrhov použite klávesy so šípkami a stlačte kláves Enter alebo Tab. Pre tímy použite formát @organizácia/názov-tímu a všetci členovia tímu budú prihlásení na odber vlákna.

Okrem zmienok GitHub uľahčuje problémy s referenciami a žiadosti o stiahnutie Jednoducho napíšte # a za ním číslo alebo časť názvu. Zobrazí sa zoznam navrhovaných výsledkov, ktorý môžete vyplniť rovnakým spôsobom ako pri zmienkach. To výrazne urýchľuje navigáciu medzi súvisiacimi konverzáciami.

Ak má váš repozitár nakonfigurované vlastné automaticky prepojené referencie, niektoré externé notácie (ako napríklad ID tiketov JIRA alebo Zendesk) sa môžu tiež automaticky previesť na krátke odkazy. Toto nastavenie vyžaduje administrátorské oprávnenia, ale po povolení umožňuje zdieľanie údajov medzi systémami s minimálnym úsilím.

GitHub nakoniec podporuje emoji prostredníctvom kódu: napíšte dvojbodku, za ňou názov emoji a na záver ďalšou dvojbodkou. Keď začnete písať, zobrazí sa zoznam návrhov, ktoré môžete prijať pomocou klávesu Tab alebo Enter. Začlenenie emoji do komentárov im pomáha dodať ľudskejší nádych, pokiaľ ich nepreháňate s používaním vo formálnej dokumentácii.

Poznámky pod čiarou a rozšírený obsah

GitHub tiež podporuje Poznámky pod čiarou Použitie syntaxe založenej na zátvorkách a identifikátora s prekladaným znakom. Na mieste, kde chcete umiestniť odkaz, vložíte niečo ako a na konci dokumentu definujete text danej poznámky s rovnakým tagom, za ktorým nasleduje dvojbodka a obsah.

Poznámky pod čiarou môžu zahŕňať viacero riadkov a na vynútenie zalomenia riadkov v rámci poznámky pod čiarou sa na konci riadku používajú dvojité medzery, rovnako ako v hlavnom texte Markdownu. Pri vykresľovaní GitHub zobrazuje horný index nad textom a na konci zoznam poznámok pod čiarou so spätnými odkazmi na navigáciu medzi referenciami a poznámkami pod čiarou.

Ďalšou pokročilou funkciou, ktorú GitHub ponúka, je... výstrahy Tieto už boli prediskutované (POZNÁMKA, TIP, DÔLEŽITÉ, UPOZORNENIE a POZOR). Odporúča sa ich používať iba v prípade skutočnej potreby a vyhnúť sa ich spájaniu s priveľa ďalšími prvkami, aby ste čitateľa nezahltili. Nemožno ich vkladať do iných zložitých prvkov, preto je nevyhnutné starostlivé plánovanie ich umiestnenia.

Nakoniec môžete požiadať GitHub, aby dočasne skryl časti vykresleného Markdownu ich zabalením do HTML komentárov alebo aby ignoroval spracovanie určitých znakov pomocou spätných lomiek. Toto je obzvlášť užitočné pri dokumentovaní. vlastná syntax jazyka Markdown A musíte ukázať príklady také, aké sú, bez interpretácie.

Markdown na Reddite: Snoomark a režim úprav

Reddit je diskusná platforma, kde je vítaná takmer každá téma, organizovaná do subredditov. Čo sa týka formátovania, ponúka dva editory: jeden pre vizuálne prepracovaný formátovaný text a druhý pre obyčajný text založený na Markdowne. Ak chcete pracovať rýchlo a mať presnú kontrolu nad výsledkom, budete chcieť použiť možnosť Markdown.

Reddit štandardne aktivuje editor formátovaného textu, takže ak chcete prepnúť do režimu označovania, musíte kliknúť na túto možnosť. Režim Markdown v textovom poli príspevku alebo komentára. Odtiaľ môžete priamo použiť syntax Snoomarku.

Ak chcete, aby sa editor Markdownu vždy načítaval, prejdite do nastavení používateľa, vstúpte do sekcie Nastavenia kanála a aktivujte túto možnosť. Predvolené na markdownTakto sa editor Markdown otvorí automaticky vždy, keď začnete písať príspevok alebo komentár, bez toho, aby ste ho museli manuálne meniť.

Reddit podporuje väčšinu základných aj pokročilých funkcií Markdownu: nadpisy, tučné písmo a kurzívu, zoznamy, citácie, bloky kódu, odkazy a niektoré vlastné bonusy, ako napríklad spoilery. V porovnaní s GitHubom má však značné nedostatky, najmä v... manipulácia s obrázkamičo dosť závisí od kontextu a typu editora.

Syntax podporovaná Redditom a spoilery

Variant Snoomarku používaný Redditom obsahuje mnoho spoločných prvkov s GitHubom, takže ak už ovládate Markdown pre repozitáre, prenos týchto znalostí do prostredia Redditu je pomerne jednoduchý. Na štruktúrovanie dlhých príspevkov môžete použiť nadpisy, číslované alebo odrážkové zoznamy, citácie na odpovedanie iným používateľom a bloky kódu, keď chcete zobraziť príkazy alebo technické úryvky.

Jedným z pozoruhodných rozdielov je spôsob, akým Reddit rieši obraznosťHoci sa v mnohých prípadoch obrázky nahrávajú cez grafické rozhranie a nie priamo so syntaxou Markdown, nástrojom, ktorý spracováva textový obsah, je stále Snoomark, takže formátovanie okolo týchto obrázkov je založené na Markdowne.

Reddit na druhej strane dodáva doplnkové prvky ktoré nie sú súčasťou štandardnej špecifikácie, ako napríklad spoilery. Tieto umožňujú skryť text za vrstvou, ktorú môže používateľ odhaliť kliknutím. Technicky vzaté, keď Reddit spracováva spoiler, transformuje ho na kombináciu HTML, CSS tried a JavaScriptu špecifického pre platformu.

Výsledná HTML reprezentácia spoileru obsahuje obslužné programy, ktoré riadia, kedy sa má obsah zobraziť alebo skryť, a hoci teoreticky by sa niečo podobné dalo napísať pomocou obyčajného HTML, na Reddite to závisí od jeho internej implementácie. Dôležité pre vás ako používateľa je, že pri písaní stačí použiť iba špecifickú syntax spoileru, ktorú poskytuje editor, a Snoomark má na starosti jeho preklad do príslušnej štruktúry.

Stručne povedané, Snoomark zdedil mnoho správania z GitHub Flavored Markdown, ale je zameraný skôr na potreby diskusnej komunity než na projektovú dokumentáciu. Jadro však zostáva rovnaké: obyčajný text s jednoduchými symbolmi transformovaný na štruktúrovaný a čitateľný obsah.

Zvládnutie syntaxe Markdownu na GitHub a Reddite výrazne zefektívňuje písanie technickej dokumentácie, otváranie dobre vysvetlených problémov, zanechávanie jasných komentárov k pull requestom a účasť na diskusiách na Reddite. S niekoľkými kľúčovými pravidlami – nadpisy, dôraz, zoznamy, citácie, bloky kódu, odkazy, obrázky a špecifické triky, ako sú tabuľky, skladacie detaily, upozornenia, poznámky pod čiarou a spoilery – môžete prejsť od písania obyčajného textu k tvorbe... čistý, čitateľný a profesionálny obsah bez dotyku jediného tlačidla myši.