Hoe je Markdown snel kunt gebruiken op GitHub en Reddit

Informatic Digital » Middelen » Hoe je Markdown snel kunt gebruiken op GitHub en Reddit

Als je regelmatig op GitHub schrijft of veel tijd op Reddit doorbrengt, is het beheersen van... Markdown Het is een van die dingen die je uren bespaart en je leven makkelijker maakt. Het is een zeer lichte opmaaktaal waarmee je snel platte tekst kunt formatteren, zonder gedoe met menu's of knoppen, gewoon met een paar symbolen op de juiste plekken.

Op GitHub vind je het overal: in de bestanden. README.md Van repositories, issues, pull requests, discussies en zelfs je eigen profiel. Reddit gebruikt op zijn beurt een variant genaamd Snoomark (Reddit-stijl Markdown) die veel van de syntaxis van GitHub overneemt, met enkele unieke kenmerken en bepaalde beperkingen. Laten we stap voor stap en met veel voorbeelden bekijken. Hoe je Markdown snel kunt gebruiken op GitHub en Reddit en zonder iets belangrijks weg te laten.

Wat is Markdown en waarom is het zo handig op GitHub en Reddit?

Afwaardering is een lichtgewicht opmaaktaal Ontworpen om het lezen en schrijven van platte tekst te vereenvoudigen, en tegelijkertijd een moeiteloze conversie naar HTML mogelijk te maken. In de praktijk betekent dit dat u gewone tekst kunt schrijven en speciale tekens kunt toevoegen om koppen, lijsten, tabellen, citaten, opgemaakte code, links of afbeeldingen te creëren.

Bij GitHub wordt de implementatie GitHub Flavored Markdown (GFM) gebruikt, die de klassieke syntaxis uitbreidt met tabellen, takenlijsten, geavanceerde syntaxmarkering, kleurondersteuning, waarschuwingen en enkele toegestane HTML-tags. Dit alles wordt automatisch weergegeven. in de .md-bestanden en in de commentaarvelden van het platform.

Reddit gebruikt een eigen processor genaamd Snoomark, een afgeleide van GFM. Deze deelt veel van de basisfunctionaliteit (vetgedrukt, cursief, koppen, lijsten, citaten, inline- of blokcode, links, enz.), maar heeft wel een aantal eigen mogelijkheden. belangrijke kenmerkenDe ondersteuning voor afbeeldingen is bijvoorbeeld beperkter, afhankelijk van de context, en voegt eigen elementen toe, zoals spoilers.

Het mooie hiervan is dat je met één enkele syntax teksten kunt schrijven die er zowel op GitHub als op Reddit goed uitzien, waarbij je slechts een paar details hoeft aan te passen waar elk platform anders werkt. Leer de basisregels Het stelt je in staat om je in beide talen vrij te bewegen zonder dat je iets helemaal opnieuw hoeft te leren.

Kopteksten en inhoudsstructuur

Een van de eerste dingen die je zult gebruiken zijn de headersZowel op GitHub als op Reddit worden ze gebruikt om de tekst in secties en subsecties te structureren.

In Markdown wordt een kop gemaakt door de tekst te laten voorafgaan door één tot zes hekjes (#): één voor een kop van niveau 1, twee voor niveau 2, enzovoort tot niveau 6. In een README.md-bestand van GitHub zou je bijvoorbeeld zoiets kunnen hebben als: # Hoofdtitel, ## Sectie, ### Subsectie, Etc.

Als GitHub twee of meer headers in een bestand vindt, genereert het automatisch een TOC Toegankelijk via het "Overzicht"-pictogram bovenaan het bestand. Elke kop verschijnt als een link die u direct naar dat gedeelte brengt, wat erg handig is voor lange documenten.

Bovendien wordt elke kop een intern anker waarnaar u kunt linken met een URL-fragment op basis van de titeltekst. Om dat fragment te genereren, past GitHub zeer specifieke regels toe: het zet letters om in kleine letters, vervangt spaties door koppeltekens, verwijdert leestekens en opmaaktekens (zoals cursivering), verwijdert overtollige spaties en, als het resultaat overeenkomt met een eerdere kop, een numeriek achtervoegsel toevoegen (-1, -2, enz.) om het uniek te maken.

Dit stelt je in staat om dingen te doen zoals een sectie plaatsen. ## Voorbeeldsectie en link er vervolgens vanuit een ander punt in het document naar met een link zoals deze: (#voorbeeldsectie)of zelfs linken naar secties met speciale tekens in de titel, aangezien GitHub het codefragment genereert volgens die regels en het op dezelfde manier toegankelijk maakt.

Nadruk, gemarkeerde tekst en citaten

Met Markdown kun je tekst markeren met behulp van verschillende methoden. nadrukVetgedrukt, cursief, doorgehaald, subscript, superscript of onderstreept. Op GitHub ziet een typische stijltabel er ongeveer zo uit, hoewel we het hier met andere woorden hebben samengevat:

Om tekst in te voegen vetgedruktVetgedrukte tekst wordt tussen dubbele sterretjes of dubbele underscores geplaatst; voor cursieve tekst worden enkele sterretjes of underscores gebruikt; om tekst door te strepen, wordt een dubbele tilde (twee tildes) aan weerszijden van de tekst geplaatst. Geneste vetgedrukte en cursieve tekst kunnen ook gecombineerd worden, drie sterretjes kunnen gebruikt worden om beide op een hele tekstsectie toe te passen, of er kunnen HTML-tags zoals <br> gebruikt worden. _{y ^{voor subscripts en superscripts, en voor onderstreping.}}

GitHub biedt je ook de mogelijkheid om te creëren citaten in blokcitaatstijl Door het groter-dan-symbool (>) aan het begin van de regel te plaatsen, wordt de geciteerde tekst met een verticale balk links ervan en in grijs weergegeven, waardoor deze duidelijk opvalt. Meerdere regels kunnen in hetzelfde citaatblok worden opgenomen en citaten kunnen zelfs genest worden door meer >-symbolen aan het begin toe te voegen.

Een geavanceerde vorm van citeren die alleen op GitHub bestaat, zijn de waarschuwingen of vermaningenZe zijn gebaseerd op dezelfde syntaxis voor blokcitaten, maar de eerste regel bevat een speciale markering om het type waarschuwing aan te geven. Je kunt bijvoorbeeld `<alert>` specificeren voor nuttige informatie, `<helpful tips>` voor praktisch advies, `<key data>` voor belangrijke gegevens, `<urgent notices>` voor dringende waarschuwingen en `<alert>` voor waarschuwingen over risico's of negatieve gevolgen. GitHub geeft elk type weer met een andere kleur en een ander pictogram, waardoor belangrijke informatie in de documentatie beter wordt benadrukt.

Reddit ondersteunt ook eenvoudige aanhalingstekens met hetzelfde symbool >, hoewel het het uitgebreide waarschuwingssysteem van GitHub mist. Desondanks blijft het een zeer nuttige manier om Iemand antwoorden door een deel van zijn of haar bericht te citeren. zonder het volledig te herhalen.

Codemarkering, blokken en kleuren

Zowel GitHub als Reddit bieden de mogelijkheid om codefragmenten in de tekst te markeren met behulp van backticks. Voor inline code plaats je het woord of de opdracht tussen enkele backticks aan weerszijden. Dit is ideaal om bijvoorbeeld een codefragment te markeren. git status binnen een zin, zodat duidelijk is dat het een bevel is.

Wanneer je een losstaand codeblok wilt, gebruikt Markdown drie backticks: je schrijft een regel met drie backticks, vervolgens de code op aparte regels en sluit af met nog eens drie backticks. Op GitHub wordt de taal ook toegepast als je die direct na de eerste backtick specificeert... syntaxis accentuering met kleuren en opmaak die specifiek zijn voor die taal.

GitHub biedt ook een specifieke functie voor het markeren van objecten. kleurwaarden Binnen backticks. Als u een kleur in hexadecimale, RGB- of HSL-indeling tussen backticks schrijft, voegt het platform een ​​kleine kleurindicator naast de tekst toe. Als de achtergrond in de lichte modus bijvoorbeeld #ffffff is en in de donkere modus #000000, kunt u door deze codes te markeren snel zien welke welke is.

Wat betreft de visualisatie van code en tabellen, biedt GitHub de mogelijkheid om een ​​vast monospace-lettertype in alle commentaarvelden in te schakelen, waardoor het werken met technische tekst comfortabeler wordt. Als je veel codefragmenten bewerkt in je browser of in editors zoals Visual Studio-codeDoor deze optie in te schakelen, worden uitlijning en lezen eenvoudiger. veel samenhangender.

Reddit ondersteunt ook codeblokken met backticks, zowel inline als in blokken, hoewel het gebruik ervan daar meer gericht is op kleine fragmenten of pseudocode dan op lange documentatie zoals die van een repository.

Links, ankers en interne navigatie

Links maken in Markdown is heel eenvoudig: je plaatst de tekst die je aan de gebruiker wilt tonen tussen vierkante haken en de URL tussen ronde haakjes. Dit werkt zowel op GitHub als op Reddit en kan op GitHub worden uitgebreid met sneltoetsen (bijvoorbeeld door toetscombinaties te gebruiken om geselecteerde tekst snel in een link om te zetten).

GitHub voegt een aantal extra functies toe met betrekking tot navigatie. Zo biedt het bijvoorbeeld de mogelijkheid om... link direct naar kopjes Het maakt gebruik van de eerder besproken regels voor het genereren van fragmenten. Bovendien ondersteunt het relatieve links binnen de repository zelf, wat cruciaal is voor technische documentatie.

Een relatieve link is een link die wordt berekend met het huidige bestand als referentie. Als je README-bestand zich bijvoorbeeld in de projectmap bevindt en je wilt linken naar het bestand docs/CONTRIBUTING.md, dan schrijf je simpelweg een link met het pad docs/CONTRIBUTING.md. GitHub vertaalt deze relatieve link correct naar elke branch waarin je je bevindt, zodat de link niet kapotgaat bij het wisselen van branches of het klonen van de repository.

Het advies is om altijd te gebruiken relatieve paden Om tussen bestanden binnen dezelfde repository te navigeren, omdat absolute links mogelijk niet meer werken in klonen of forks, staat GitHub het gebruik toe van standaardoperators zoals ./ of ../ en paden die beginnen met / ten opzichte van de projectroot.

Als u naast koppen ook andere ankerpunten in een document wilt maken, kunt u HTML-tags met het `name`-attribuut gebruiken. Hiermee kunt u een ankerpunt midden in een alinea of ​​naast tekst zonder eigen titel plaatsen en ernaar linken met dezelfde syntaxis als voor automatisch gegenereerde koppen.

Afbeeldingen op GitHub: Markdown, HTML en relatieve paden

Op GitHub worden afbeeldingen over het algemeen ingesloten met dezelfde syntax als links, maar voorafgegaan door een uitroepteken. De alternatieve tekst (alt) wordt tussen vierkante haken geplaatst en de URL of het pad naar de afbeelding staat tussen haakjes. Deze alternatieve tekst is belangrijk voor de weergave van afbeeldingen. toegankelijkheidwant dat is wat schermlezers zullen lezen en wat er zal worden weergegeven als de afbeelding niet laadt.

Afbeeldingen kunnen afkomstig zijn van bestanden binnen de repository zelf of van externe URL's. GitHub staat meerdere relatieve padpatronen toe voor het uploaden van afbeeldingen vanuit verschillende branches, andere repositories, of zelfs issues en opmerkingen, met behulp van achtervoegsels zoals ?raw=true om, indien nodig, de directe download van het bestand af te dwingen.

Naast de standaard Markdown-syntaxis ondersteunt GitHub ook het gebruik van het HTML-element. Dit artikel is bijzonder handig voor het opladen. responsieve afbeeldingen Deze kleuren veranderen afhankelijk van de thema-voorkeuren van de gebruiker (licht of donker). Met de mediaquery `prefers-color-scheme` kunt u verschillende afbeeldingsbronnen definiëren voor elke modus, en een standaardafbeelding voor browsers die deze functie niet ondersteunen.

Het gebruikelijke patroon houdt in dat het volgende wordt opgenomen binnen verschillende elementen met zijn media- en srcset-attributen, en tenslotte een Door gebruik te maken van het alt-attribuut en een generieke URL, zien gebruikers in de donkere modus een aangepaste afbeelding, terwijl gebruikers in de lichte modus een andere afbeelding te zien krijgen, zonder dat er inhoud in het README-bestand hoeft te worden gedupliceerd.

GitHub ondersteunt ook HTML-commentaren in Markdown-bestanden, waardoor je onzichtbare herinneringen aan de lezer kunt toevoegen, bijvoorbeeld om hen eraan te herinneren een afbeeldingssectie bij te werken of later nieuwe voorbeelden toe te voegen.

Tabellen, uitklapbare secties en scheiding van de inhoud.

Een van de nuttigste verbeteringen in GitHub Flavored Markdown is de ondersteuning voor tekenenJe kunt gegevens ordenen in rijen en kolommen door verticale strepen te gebruiken om cellen te scheiden en een stippellijn om de koptekst aan te geven. Je kunt kolommen ook rechts, links of in het midden uitlijnen met een dubbele punt in de scheidingsrij.

Tabellen zijn erg handig voor het presenteren van lijsten met programmeertalen, gebruikte frameworks, geplande taken, functievergelijkingen of andere informatie die baat heeft bij een matrixstructuur. GitHub geeft deze tabellen weer in een overzichtelijke en leesbare stijl.

Om een ​​lang README-bestand overzichtelijk te houden, kunt u de HTML-tag gebruiken. om inklapbare secties te creëren. Deze secties tonen een samenvatting binnen het label. en de gebruiker de mogelijkheid geven om uit te breiden of in te krimpen aanvullende inhoud indien nodig. Het is gebruikelijk om tabellen of blokken met aanvullende informatie daarin op te nemen. om te voorkomen dat het oog overbelast raakt.

Als je wilt dat de sectie standaard uitgeklapt verschijnt, voeg dan eenvoudig het attribuut 'open' toe aan... Deze techniek is erg praktisch voor het groeperen van ranglijsten, lange lijsten of inhoud die niet essentieel is voor een eerste lezing, maar wel gemakkelijk toegankelijk is.

Een ander eenvoudig hulpmiddel voor het ordenen van informatie is de horizontale lijn. Deze wordt gemaakt door drie of meer streepjes op een lijn te tekenen en dient als scheidingslijn tussen secties, waardoor je bijvoorbeeld een beschrijvende sectie duidelijk kunt scheiden van een sectie met referenties of aanvullende notities.

Deze regels kunnen worden gecombineerd met citaten aan het einde van een document om inspirerende zinnen, herinneringen of belangrijke boodschappen te benadrukken. Een typisch voorbeeld is het plaatsen van een motiverend citaat aan het einde van je profiel-README, opgemaakt als een blokcitaat na een scheidingslijn.

Verborgen opmerkingen en opmaakcontrole

Met GitHub kun je introducties maken HTML-commentaar binnen Markdown met behulp van de syntax Alles wat je in die opmerking plaatst, wordt niet weergegeven in de uiteindelijke content, maar wel in de broncode. Het is dus ideaal voor interne notities of takenlijsten.

Je kunt bijvoorbeeld in een README-bestand van een profiel een opmerking toevoegen zoals dat je het gedeelte 'Over mij' later moet uitbreiden of dat je een overzicht van verouderde technologieën moet bekijken, zonder dat iemand die het profiel bezoekt dit direct ziet.

Een andere nuttige functie is die van ontsnappingspersonages wat normaal gesproken als Markdown wordt geïnterpreteerd. Als je sterretjes, hekjes of andere symbolen letterlijk wilt weergeven zonder dat ze worden opgemaakt, plaats je er simpelweg een backslash voor. Hierdoor kun je bijvoorbeeld expressies schrijven die lijstsymbolen bevatten zonder ze om te zetten in daadwerkelijke lijsten.

Wanneer je een markupbestand op GitHub bekijkt, kun je met een knop bovenaan schakelen tussen de weergegeven weergave en de broncode (of het openen in editors zoals...). BeugelsDoor de Markdown-interpretatie uit te schakelen, krijgt u toegang tot typische codeweergavefuncties zoals link specifieke lijnenDit is erg handig als je naar een specifiek gedeelte van een README-bestand of een ander .md-bestand wilt verwijzen.

Tot slot is het belangrijk om te onthouden dat GitHub regeleinden anders behandelt in opmerkingen (issues, pull requests, enz.) en in .md-bestanden. In opmerkingen worden regeleinden direct gerespecteerd, terwijl je in Markdown-bestanden twee spaties, een backslash of een punt aan het einde van de regel moet toevoegen. om de sprong binnen dezelfde alinea af te dwingen.

Lijsten, geneste lijsten en takenlijsten

Lijsten zijn een van de meest gebruikte elementen in Markdown, zowel op GitHub als op Reddit. Je kunt lijsten maken. ongeordend door een koppelteken, asterisk of plusteken voor elk item in de lijst te plaatsen. Al deze tekens worden op dezelfde manier weergegeven als opsommingstekens.

Om lijsten te genereren besteldElke regel wordt genummerd met een nummer, gevolgd door een punt en een spatie. Hoewel de volgorde van de nummers niet perfect hoeft te zijn (GitHub herberekent deze meestal), is het raadzaam om een ​​consistente nummering aan te houden om de broncode leesbaar te houden.

Geneste lijsten worden eenvoudigweg gemaakt door inspringing toe te voegen aan de items eronder. In editors met een monospace-indeling zoals Sublime TextLijn de geneste lijstmarkeringen visueel uit onder het eerste teken van de tekst in het bovenliggende element. In contexten zoals de GitHub-commentaareditor, waar het lettertype geen vaste breedte heeft, tel je het aantal tekens vóór de tekst en gebruik je dat aantal spaties voor de inspringing.

Je kunt ook meerdere niveaus van geneste elementen bouwen, zolang je maar consistent blijft in het aantal spaties. Voor zeer complexe lijsten vereist dit systeem wat oefening, maar als je het eenmaal onder de knie hebt, is het heel snel toe te passen.

GitHub biedt ook de mogelijkheid om takenlijstenDeze zijn erg handig voor issues, pull requests en documentatie. Ze worden gemaakt door een koppelteken, een spatie en een paar vierkante haken te laten voorafgaan door een spatie of een "x": voor openstaande taken en voor voltooide taken. Deze lijsten worden weergegeven met selectievakjes die via de interface kunnen worden aangevinkt of uitgevinkt.

Als de tekst van een taak in een takenlijst begint met haakjes, moet deze worden ontsnapt met een backslash om verwarring bij de parser te voorkomen. Het is een klein detail, maar belangrijk bij het schrijven van beschrijvingen die beginnen met iets als "(Optioneel)" of iets dergelijks.

Vermeldingen, referenties en emoji's op GitHub

Een van de voordelen van het schrijven in Markdown op GitHub is de mogelijkheid om gebruik te maken van... vermeldt Stuur rechtstreeks berichten naar gebruikers en teams op het platform. Typ simpelweg @ gevolgd door de gebruikersnaam of teamnaam, en GitHub stuurt een melding naar dat account, waardoor hun aandacht op het gesprek wordt gevestigd.

Wanneer je het @-symbool typt, toont GitHub een lijst met gebruikers en teams die aan de repository of thread zijn gekoppeld. Je kunt deze lijst filteren terwijl je typt. Gebruik de pijltjes toetsen en druk op Enter of Tab om de suggesties te accepteren. Voor teams gebruik je de indeling @organisatie/teamnaam; alle teamleden worden dan geabonneerd op de thread.

Naast vermeldingen faciliteert GitHub ook... referentieproblemen en pull-aanvragen Typ simpelweg # gevolgd door een nummer of een deel van de titel. Er verschijnt een lijst met suggesties, die je op dezelfde manier kunt aanvullen als bij vermeldingen. Dit versnelt het navigeren tussen gerelateerde gesprekken aanzienlijk.

Als uw repository aangepaste, automatisch gekoppelde referenties heeft geconfigureerd, kunnen bepaalde externe notaties (zoals JIRA- of Zendesk-ticket-ID's) ook automatisch worden omgezet in verkorte links. Deze instelling vereist beheerdersrechten, maar eenmaal ingeschakeld, maakt het delen van gegevens tussen systemen met minimale inspanning mogelijk.

Tot slot ondersteunt GitHub emoji's via code: typ een dubbele punt, gevolgd door de naam van de emoji, en eindig met nog een dubbele punt. Tijdens het typen verschijnt een lijst met suggesties, die je kunt accepteren met Tab of Enter. Het gebruik van emoji's in je reacties geeft ze een persoonlijker tintje, zolang je ze maar niet te vaak gebruikt in formele documentatie.

Voetnoten en geavanceerde inhoud

GitHub ondersteunt ook Voetnoten Gebruikmakend van een syntaxis met haakjes en een identificator met een tussenliggend teken. Op de plek waar je de verwijzing wilt, voeg je iets in als , en aan het einde van het document definieer je de tekst van die notitie met dezelfde tag, gevolgd door een dubbele punt en de inhoud.

Voetnoten kunnen meerdere regels beslaan. Om regeleinden binnen een voetnoot af te dwingen, worden dubbele spaties aan het einde van de regel gebruikt, net als in de hoofdtekst van de Markdown. Bij het weergeven toont GitHub een superscript boven de tekst en een lijst met voetnoten aan het einde, met backlinks om tussen referenties en voetnoten te navigeren.

Een andere geavanceerde functie die GitHub biedt is... alertas Deze zijn al besproken (OPMERKING, TIP, BELANGRIJK, WAARSCHUWING en VOORZICHTIG). Het is raadzaam ze alleen te gebruiken wanneer echt nodig en te voorkomen dat er te veel achter elkaar staan ​​om de lezer niet te overweldigen. Ze kunnen niet in andere complexe elementen worden genest, dus een zorgvuldige planning van hun plaatsing is essentieel.

Tot slot kun je GitHub vragen om gedeeltes van de weergegeven Markdown tijdelijk te verbergen door ze in HTML-commentaren te plaatsen, of om de verwerking van bepaalde tekens met backslashes te negeren. Dit is vooral handig bij het documenteren van code. De eigen syntaxis van Markdown En je moet de voorbeelden laten zien zoals ze zijn, zonder interpretatie.

Markdown op Reddit: Snoomark en bewerkingsmodus

Reddit is een discussieplatform waar vrijwel elk onderwerp welkom is, georganiseerd in subreddits. Qua opmaak biedt het twee editors: een voor rich text, die meer visueel is, en een voor platte tekst op basis van Markdown. Als je snel wilt werken en nauwkeurige controle over het resultaat wilt hebben, kun je het beste de Markdown-optie gebruiken.

Standaard activeert Reddit meestal de rich text-editor, dus om over te schakelen naar de opmaakmodus moet je op de betreffende optie klikken. Markdown-modus binnen het tekstvak van een bericht of reactie. Van daaruit kun je de Snoomark-syntaxis direct gebruiken.

Als je er de voorkeur aan geeft dat de Markdown-editor altijd wordt geladen, ga dan naar de gebruikersinstellingen, open het gedeelte 'Feedinstellingen' en activeer de optie. Standaardwaarde: markdownOp deze manier wordt de Markdown-editor automatisch geopend elke keer dat je een bericht of reactie begint te schrijven, zonder dat je dit handmatig hoeft te wijzigen.

Reddit ondersteunt de meeste basis- en geavanceerde Markdown-functies: koppen, vetgedrukte en cursieve tekst, lijsten, citaten, codeblokken, links en enkele eigen extra's zoals spoilers. Het heeft echter aanzienlijke tekortkomingen in vergelijking met GitHub, met name op het gebied van... Behandeling van afbeeldingenDat hangt nogal af van de context en het type editor.

Syntaxis ondersteund door Reddit en spoilers

De Snoomark-variant die Reddit gebruikt, bevat veel elementen die overeenkomen met die van GitHub. Dus als je al bekend bent met Markdown voor repositories, is het overzetten van die kennis naar de Reddit-omgeving vrij eenvoudig. Je kunt kopjes gebruiken om lange berichten te structureren, genummerde of opsommingstekens, citaten om op andere gebruikers te reageren en codeblokken om commando's of technische fragmenten weer te geven.

Een van de opvallende verschillen is de manier waarop Reddit omgaat met de beeldspraakHoewel afbeeldingen in veel gevallen via de grafische interface worden geüpload en niet rechtstreeks met Markdown-syntaxis, is de engine die de tekstinhoud verwerkt nog steeds Snoomark, waardoor de opmaak rondom die afbeeldingen gebaseerd is op Markdown.

Reddit voegt daar daarentegen aan toe: aanvullende elementen die geen deel uitmaken van de standaardspecificatie, zoals spoilers. Hiermee kun je tekst verbergen achter een laag die de gebruiker met een klik kan onthullen. Technisch gezien zet Reddit een spoiler om in een combinatie van HTML, CSS-klassen en platformspecifieke JavaScript.

De resulterende HTML-weergave van een spoiler bevat handlers die bepalen wanneer de inhoud moet worden getoond of verborgen. Hoewel theoretisch iets soortgelijks met gewone HTML zou kunnen worden geschreven, hangt het op Reddit af van de interne implementatie. Het belangrijkste voor jou als gebruiker is dat je bij het schrijven alleen de specifieke spoilersyntaxis hoeft te gebruiken die door de editor wordt aangeboden. Snoomark is verantwoordelijk voor de vertaling. naar de juiste structuur.

Kort gezegd erft Snoomark veel eigenschappen van GitHub Flavored Markdown, maar is afgestemd op de behoeften van een discussiegemeenschap in plaats van projectdocumentatie. De kern blijft echter hetzelfde: platte tekst met eenvoudige symbolen wordt omgezet in gestructureerde en leesbare inhoud.

Door de Markdown-syntaxis op GitHub en Reddit onder de knie te krijgen, wordt het schrijven van technische documentatie, het openen van goed onderbouwde issues, het plaatsen van duidelijke opmerkingen bij pull requests en het deelnemen aan Reddit-discussies veel efficiënter. Met een paar belangrijke regels – kopjes, nadruk, lijsten, citaten, codeblokken, links, afbeeldingen en specifieke trucs zoals tabellen, inklapbare details, alerts, voetnoten en spoilers – kun je van het schrijven van platte tekst overstappen naar het creëren van Schone, scanbare en professionele inhoud zonder ook maar één muisknop aan te raken.