Jak szybko używać języka Markdown na platformach GitHub i Reddit

Informatec Digital » Zasoby » Jak szybko używać języka Markdown na platformach GitHub i Reddit

Jeśli regularnie piszesz na GitHubie lub spędzasz dużo czasu na Reddicie, opanowanie Obniżka cen To jedna z tych rzeczy, które oszczędzają godziny i ułatwiają życie. To bardzo lekki język znaczników, który pozwala szybko formatować zwykły tekst, bez konieczności korzystania z menu czy przycisków, a jedynie za pomocą kilku symboli umieszczonych w odpowiednich miejscach.

Na GitHubie znajdziesz to wszędzie: w plikach README.md z repozytoriów, zgłoszeń, żądań ściągnięcia, dyskusji, a nawet własnego profilu. Reddit z kolei korzysta z wariantu o nazwie Snoomark (markdown w stylu Reddita), który dziedziczy wiele ze składni GitHuba, z pewnymi unikalnymi funkcjami i pewnymi ograniczeniami. Zobaczmy krok po kroku i na wielu przykładach, Jak szybko używać języka Markdown na platformach GitHub i Reddit i nie pomijając niczego ważnego.

Czym jest Markdown i dlaczego jest tak przydatny na GitHubie i Reddicie?

Markdown to a lekki język znaczników Zaprojektowano, aby ułatwić czytanie i pisanie zwykłego tekstu, a jednocześnie umożliwić bezproblemową konwersję do formatu HTML. W praktyce oznacza to, że możesz pisać zwykły tekst i dodawać znaki specjalne, aby tworzyć nagłówki, listy, tabele, cytaty, sformatowany kod, linki lub obrazy.

W serwisie GitHub wykorzystano implementację GitHub Flavored Markdown (GFM), która rozszerza klasyczną składnię o tabele, listy zadań do wykonania, zaawansowane wyróżnianie kodu, obsługę kolorów, alerty i niektóre dozwolone znaczniki HTML. Wszystko to jest renderowane automatycznie w plikach .md i w polach komentarzy platformy.

Reddit korzysta z własnego procesora o nazwie Snoomark, pochodnego GFM. Ma on wiele wspólnych podstawowych funkcji (pogrubienie, kursywa, nagłówki, listy, cytaty, kod w tekście lub blokowy, linki itp.), ale ma ważne cechyNa przykład obsługa obrazów jest bardziej ograniczona w zależności od kontekstu i dodaje własne elementy, takie jak spoilery.

Piękno tego wszystkiego polega na tym, że przy użyciu jednej składni można pisać teksty, które dobrze prezentują się zarówno na GitHubie, jak i Reddicie, dostosowując tylko kilka szczegółów, ponieważ każda platforma działa inaczej. Poznaj podstawowe zasady Umożliwia swobodne poruszanie się w obu językach, bez konieczności uczenia się czegokolwiek od nowa.

Nagłówki i struktura treści

Jedną z pierwszych rzeczy, których użyjesz, jest nagłówkiZarówno na GitHubie, jak i na Reddicie służą one do podziału tekstu na sekcje i podsekcje.

W Markdown nagłówek tworzy się, poprzedzając tekst od jednego do sześciu symboli hash: jeden dla nagłówka poziomu 1, dwa dla poziomu 2 i tak dalej, aż do poziomu 6. Na przykład w pliku README.md w serwisie GitHub możesz mieć coś takiego: # Tytuł główny, ## Sekcja, ### Podsekcja, itp.

Gdy GitHub znajdzie dwa lub więcej nagłówków w pliku, automatycznie generuje tabela zawartości Dostęp do niego można uzyskać za pomocą ikony „Konspekt” u góry pliku. Każdy nagłówek pojawia się jako link prowadzący bezpośrednio do odpowiedniej sekcji, co jest przydatne w przypadku długich dokumentów.

Dodatkowo każdy nagłówek staje się wewnętrznym punktem odniesienia, do którego można linkować za pomocą fragmentu adresu URL na podstawie tekstu tytułu. Aby wygenerować ten fragment, GitHub stosuje bardzo szczegółowe zasady: zamienia litery na małe, zastępuje spacje myślnikami, usuwa znaki interpunkcyjne i formatujące (takie jak kursywa), przycina zbędne spacje, a jeśli wynik pasuje do poprzedniego nagłówka, dodaj sufiks numeryczny (-1, -2, itd.) aby uczynić go unikalnym.

Dzięki temu możesz wykonywać czynności takie jak umieszczanie sekcji ## Sekcja przykładowa a następnie połączyć się z nim z innego miejsca w dokumencie za pomocą takiego łącza: (#przykładowa-sekcja)lub nawet linkować do sekcji zawierających znaki specjalne w tytule, ponieważ GitHub generuje fragment kodu zgodnie z tymi zasadami i udostępnia go za pomocą tego samego wzorca.

Podkreślenie, wyróżniony tekst i cytaty

Markdown umożliwia wyróżnianie tekstu różnymi metodami naciskPogrubienie, kursywa, przekreślenie, indeks dolny, indeks górny lub podkreślenie. Na GitHubie typowa tabela stylów wyglądałaby mniej więcej tak, chociaż tutaj podsumowaliśmy ją innymi słowami:

Aby umieścić tekst pogrubienieTekst pogrubiony jest ujęty w podwójne gwiazdki lub podwójne podkreślenia; w przypadku kursywy stosuje się pojedyncze gwiazdki lub podkreślenia; aby coś przekreślić, po obu stronach tekstu umieszcza się podwójną tyldę (dwie tyldy). Zagnieżdżone pogrubienie i kursywę można również łączyć, można użyć trzech gwiazdek, aby zastosować oba te znaki do całego fragmentu tekstu, lub użyć znaczników HTML, takich jak <br>. _{y ^{do indeksów dolnych i górnych oraz do podkreślenia.}}

GitHub umożliwia również tworzenie cytaty w stylu blockquote Umieszczając symbol większości (>) na początku wiersza, cytowany tekst jest wyświetlany z pionową kreską po lewej stronie i w kolorze szarym, co sprawia, że ​​jest wyraźnie widoczny. W jednym bloku cytatu można umieścić wiele wierszy, a cytaty można zagnieżdżać, dodając na początku więcej symboli >.

Zaawansowaną formą cytowania, która jest dostępna wyłącznie w serwisie GitHub, jest alerty lub napomnieniaOpierają się na tej samej składni cytatu blokowego, ale pierwszy wiersz zawiera specjalny znacznik wskazujący rodzaj alertu. Na przykład, możesz określić `<alert>` dla przydatnych informacji, `<przydatne wskazówki>` dla praktycznych porad, `<kluczowe dane>` dla kluczowych danych, `<pilne powiadomienia>` dla pilnych ostrzeżeń i `<alert>` dla ostrzeżeń o ryzyku lub negatywnych konsekwencjach. GitHub wyświetla każdy typ innym kolorem i ikoną, co pomaga wyróżnić kluczowe informacje w dokumentacji.

Reddit obsługuje również proste cudzysłowy z tym samym symbolem >, choć brakuje mu rozbudowanego systemu powiadomień GitHuba. Mimo to pozostaje bardzo użytecznym sposobem odpowiadanie komuś poprzez cytowanie części jego wiadomości bez powtarzania całości.

Podświetlanie kodu, bloki i kolory

Zarówno GitHub, jak i Reddit umożliwiają zaznaczanie fragmentów kodu w tekście za pomocą odwrotnych apostrofów. W przypadku kodu inline, słowo lub polecenie należy otoczyć pojedynczym odwrotnym apostrofem z każdej strony. Jest to idealne rozwiązanie do zaznaczania na przykład… status gita w zdaniu, wyraźnie wskazując, że jest to polecenie.

Gdy potrzebujesz samodzielnego bloku kodu, Markdown używa trzech odwrotnych apostrofów: piszesz wiersz z trzema odwrotnymi apostrofami, a następnie kod w osobnych wierszach i zamykasz kolejnymi trzema odwrotnymi apostrofami. Na GitHubie, jeśli podasz również język zaraz po pierwszym odwrotnym apostrofie, zostanie on zastosowany... Podświetlanie składni z kolorami i formatem właściwym dla danego języka.

GitHub oferuje również specjalną funkcję wyróżniania wartości kolorów W odwrotnych apostrofach. Jeśli wpiszesz kolor w formacie szesnastkowym, RGB lub HSL między odwrotnymi apostrofami, platforma wyświetli obok tekstu mały wskaźnik koloru. Na przykład, jeśli tło w trybie jasnym to #ffffff, a w trybie ciemnym #000000, zaznaczenie tych kodów pozwoli Ci szybko sprawdzić, który jest który.

Jeśli chodzi o wizualizację kodu i tabel, GitHub umożliwia włączenie stałej czcionki o stałej szerokości we wszystkich polach komentarzy, aby praca z tekstem technicznym była wygodniejsza. Jeśli edytujesz wiele fragmentów kodu w przeglądarce lub w edytorach takich jak… Visual Studio CodeWłączenie tej opcji ułatwia wyrównywanie i odczytywanie. o wiele bardziej spójny.

Reddit obsługuje również bloki kodu z odwrotnymi apostrofami, zarówno w tekście, jak i w bloku, chociaż ich użycie w tym przypadku koncentruje się bardziej na małych fragmentach lub pseudokodzie niż na długiej dokumentacji, takiej jak w przypadku repozytorium.

Linki, kotwice i nawigacja wewnętrzna

Tworzenie linków w Markdownie jest bardzo proste: tekst, który ma zostać wyświetlony użytkownikowi, umieszcza się w nawiasach kwadratowych, a adres URL w nawiasach okrągłych. Działa to zarówno na GitHubie, jak i Reddicie, a na GitHubie można je udoskonalić za pomocą skrótów klawiaturowych (na przykład, używając kombinacji klawiszy, aby szybko przekształcić zaznaczony tekst w link).

GitHub dodaje kilka dodatkowych funkcji związanych z nawigacją. Po pierwsze, pozwala link bezpośrednio do nagłówków Wykorzystuje omówione wcześniej zasady generowania fragmentów. Ponadto obsługuje linki względne w samym repozytorium, co jest kluczowe w dokumentacji technicznej.

Link względny to link obliczany na podstawie bieżącego pliku jako odniesienia. Na przykład, jeśli plik README znajduje się w katalogu głównym projektu i chcesz utworzyć link do pliku docs/CONTRIBUTING.md, wystarczy wpisać link ze ścieżką docs/CONTRIBUTING.md. GitHub obsługuje poprawne tłumaczenie tego linku względnego w dowolnej gałęzi, w której się znajdujesz, zapobiegając jego uszkodzeniu podczas przełączania gałęzi lub klonowania repozytorium.

Zaleca się zawsze używać ścieżki względne Aby poruszać się pomiędzy plikami w obrębie tego samego repozytorium (z uwagi na fakt, że łącza bezwzględne mogą przestać działać w przypadku klonów lub rozwidleń), GitHub zezwala na używanie standardowych operatorów, takich jak ./ lub ../, oraz ścieżek rozpoczynających się od / względem katalogu głównego projektu.

Jeśli chcesz utworzyć niestandardowe punkty zakotwiczenia w dokumencie poza nagłówkami, możesz użyć znaczników HTML z atrybutem `name`. Pozwala to umieścić punkt docelowy w środku akapitu lub obok tekstu, który nie ma własnego tytułu, i utworzyć do niego link za pomocą tej samej składni, co w przypadku automatycznie generowanych nagłówków.

Obrazy na GitHubie: Markdown, HTML i ścieżki względne

W serwisie GitHub obrazy są zazwyczaj osadzane przy użyciu tej samej składni co linki, ale poprzedzone wykrzyknikiem. Tekst alternatywny (alt) jest podany w nawiasach kwadratowych, a adres URL lub ścieżka do obrazu znajduje się w nawiasach okrągłych. Ten tekst alternatywny jest ważny dla… dostępnośćponieważ to właśnie odczytają czytniki ekranu i to zostanie wyświetlone, jeśli obraz się nie załaduje.

Obrazy mogą pochodzić z plików w samym repozytorium lub z zewnętrznych adresów URL. GitHub umożliwia przesyłanie obrazów z różnych gałęzi, innych repozytoriów, a nawet zgłoszeń i komentarzy za pomocą sufiksów takich jak: ?raw=true aby wymusić bezpośrednie pobranie pliku, gdy będzie to konieczne.

Oprócz standardowej składni Markdown, GitHub obsługuje użycie elementu HTML Ten przedmiot jest szczególnie przydatny do ładowania responsywne obrazy Zmieniają się one w zależności od preferencji użytkownika dotyczących motywu (jasny lub ciemny). Za pomocą zapytania o media `prefers-color-scheme` możesz zdefiniować różne źródła obrazu dla każdego trybu oraz domyślny obraz dla przeglądarek, które nie obsługują tej funkcji.

Typowy wzór obejmuje włączenie do kilka elementów z atrybutami media i srcset, a na koniec Dzięki atrybutowi alt i ogólnemu adresowi URL użytkownicy w trybie ciemnym widzą dostosowany obraz, a użytkownicy w trybie jasnym widzą inny, bez konieczności duplikowania treści w pliku README.

GitHub obsługuje również komentarze HTML w plikach Markdown, co pozwala na dodawanie niewidocznych przypomnień dla czytelnika, na przykład przypominających o konieczności zaktualizowania sekcji obrazu lub dodania nowych przykładów w późniejszym czasie.

Tabele, sekcje rozkładane i rozdzielanie treści

Jedną z najbardziej przydatnych ulepszeń w GitHub Flavored Markdown jest obsługa stołyDane można uporządkować w wierszach i kolumnach, używając pionowych kresek do oddzielania komórek i linii przerywanej do zaznaczenia nagłówka. Można również wyrównać kolumny do prawej, lewej lub do środka, używając dwukropka w wierszu separatora.

Tabele są bardzo przydatne do prezentowania list języków programowania, używanych frameworków, planowanych zadań, porównań funkcji i wszelkich innych informacji, które korzystają ze struktury macierzowej. GitHub renderuje te tabele w przejrzysty i czytelny sposób.

Aby zachować porządek w długim pliku README, możesz użyć znacznika HTML aby utworzyć sekcje zwijane. Sekcje te wyświetlają podsumowanie w etykiecie. i umożliwiają użytkownikowi rozszerzanie lub zwężanie dodatkowa treść w razie potrzeby. Powszechne jest umieszczanie tabel lub bloków informacji drugorzędnych w aby nie męczyć wzroku.

Jeśli chcesz, aby sekcja domyślnie wyświetlała się jako rozwinięta, po prostu dodaj atrybut open do Technika ta jest bardzo praktyczna przy grupowaniu rankingów, tworzeniu długich list lub tworzeniu treści, które nie są niezbędne przy pierwszym czytaniu, ale wygodnie jest mieć do nich dostęp.

Innym prostym narzędziem do porządkowania informacji jest linia pozioma. Tworzy się ją poprzez narysowanie trzech lub więcej kresek na linii i służy do wyznaczania linii podziału między sekcjami, umożliwiając wyraźne oddzielenie na przykład sekcji opisowej od sekcji z odnośnikami lub dodatkowymi notatkami.

Reguły te można łączyć z cytatami na końcu dokumentu, aby wyróżnić inspirujące frazy, przypomnienia lub kluczowe przesłania. Typowym przykładem jest umieszczenie motywującego cytatu na końcu pliku README profilu, sformatowanego z cytatem blokowym po linii rozdzielającej.

Ukryte komentarze i kontrola formatu

GitHub pozwala na wprowadzenie Komentarze HTML w Markdown za pomocą składni Wszystko, co umieścisz w komentarzu, nie będzie widoczne w renderowanej treści, ale będzie widoczne w kodzie źródłowym. Dlatego komentarz ten doskonale nadaje się do wewnętrznych notatek lub zadań.

Na przykład w pliku README profilu możesz dodać komentarz, który na przykład poinformuje, że później musisz rozwinąć sekcję „O mnie” lub że musisz przejrzeć tabelę przestarzałych technologii, nie ujawniając tego osobom odwiedzającym profil.

Inną przydatną funkcją jest znaki ucieczki co normalnie byłoby interpretowane jako Markdown. Jeśli chcesz wyświetlić gwiazdki, symbole hash lub inne symbole dosłownie, bez ich formatowania, po prostu poprzedź każdy z nich ukośnikiem odwrotnym. Pozwala to na przykład na pisanie wyrażeń zawierających symbole listy bez konwertowania ich na faktyczne listy.

Podczas przeglądania pliku znaczników w serwisie GitHub masz możliwość przełączania się między widokiem renderowanym a kodem źródłowym za pomocą przycisku u góry (lub otwierania go w edytorach takich jak WspornikiWyłączenie interpretacji Markdown pozwala na dostęp do typowych funkcji widoku kodu, takich jak: linie łącząceJest to bardzo przydatne, gdy chcesz wskazać konkretny fragment pliku README lub dowolnego pliku .md.

Na koniec pamiętaj, że GitHub inaczej traktuje podziały wierszy w komentarzach (zgłoszeniowych, PR itp.) i w plikach .md. W komentarzach podziały wierszy są respektowane bezpośrednio, natomiast w plikach Markdown należy dodać dwie spacje na końcu wiersza, ukośnik odwrotny lub kropkę. aby wymusić przejście w obrębie tego samego akapitu.

Listy, listy zagnieżdżone i listy zadań do wykonania

Listy to jeden z najczęściej używanych elementów w Markdownie, zarówno na GitHubie, jak i Reddicie. Możesz tworzyć listy nieuporządkowany umieszczając myślnik, gwiazdkę lub znak plus przed każdym elementem listy. Wszystkie te znaki są renderowane podobnie jak punkty wypunktowania.

Aby wygenerować listy zamówioneKażdy wiersz jest numerowany cyfrą, po której następuje kropka i spacja. Chociaż kolejność cyfr nie musi być idealna (GitHub zazwyczaj ją przelicza), warto zachować spójną numerację, aby kod źródłowy był czytelny.

Listy zagnieżdżone tworzy się po prostu poprzez dodanie wcięć do elementów znajdujących się pod nimi. W edytorach o stałej szerokości, takich jak Sublime TextWystarczy wizualnie wyrównać znaczniki listy zagnieżdżonej poniżej pierwszego znaku tekstu w elemencie nadrzędnym. W kontekstach takich jak edytor komentarzy GitHub, gdzie czcionka nie jest stała, należy policzyć liczbę znaków przed tekstem i użyć tej liczby spacji do wcięć.

Możesz również budować wiele poziomów zagnieżdżenia, o ile zachowasz spójność w liczbie spacji. W przypadku bardzo złożonych list ten system wymaga trochę praktyki, ale gdy już się go opanuje, bardzo szybko się go stosuje.

GitHub oferuje również listy rzeczy do zrobieniaSą one bardzo przydatne w przypadku zgłoszeń, żądań ściągnięcia i dokumentacji. Tworzy się je, poprzedzając myślnik, spację i parę nawiasów kwadratowych spacją lub znakiem „x” w środku: dla zadań oczekujących i ukończonych. Listy te są wyświetlane z polami wyboru, które można zaznaczać lub odznaczać z poziomu interfejsu.

Jeśli tekst elementu listy zadań zaczyna się od nawiasów, należy go poprzedzić ukośnikiem odwrotnym, aby uniknąć pomyłki w parserze. To drobny szczegół, ale ważny podczas pisania opisów zaczynających się od słów takich jak „(Opcjonalne)” lub podobnych.

Wzmianki, odniesienia i emotikony w serwisie GitHub

Jedną z zalet pisania w Markdown na GitHubie jest możliwość korzystania wspomina Wysyłaj bezpośrednie wiadomości do użytkowników i zespołów na platformie. Wystarczy wpisać @, a następnie nazwę użytkownika lub zespołu, a GitHub wyśle ​​powiadomienie na to konto, zwracając uwagę użytkowników na konwersację.

Po wpisaniu symbolu @ GitHub wyświetli listę użytkowników i zespołów powiązanych z repozytorium lub wątkiem. Możesz filtrować tę listę podczas wpisywania. Użyj klawiszy strzałek i naciśnij Enter lub Tab, aby zaakceptować sugestie. W przypadku zespołów użyj formatu @organizacja/nazwa-zespołu, a wszyscy członkowie zespołu zostaną zasubskrybowani do wątku.

Oprócz wzmianek GitHub ułatwia problemy referencyjne i żądania ściągnięcia Wystarczy wpisać #, a następnie numer lub fragment tytułu. Pojawi się lista sugerowanych wyników, którą można uzupełnić w taki sam sposób, jak w przypadku wzmianek. To znacznie przyspiesza nawigację między powiązanymi wątkami.

Jeśli w repozytorium skonfigurowano niestandardowe, automatyczne linki, niektóre notacje zewnętrzne (takie jak identyfikatory zgłoszeń w JIRA lub Zendesk) mogą być również automatycznie konwertowane na krótkie linki. To ustawienie wymaga uprawnień administratora, ale po włączeniu umożliwia udostępnianie danych między systemami przy minimalnym wysiłku.

GitHub obsługuje emoji za pomocą kodu: wpisz dwukropek, a następnie nazwę emoji i zakończ kolejnym dwukropkiem. Gdy zaczniesz pisać, pojawi się lista sugestii, które możesz zaakceptować klawiszem Tab lub Enter. Umieszczanie emoji w komentarzach pomaga nadać im bardziej ludzki charakter, o ile nie nadużywasz ich w formalnej dokumentacji.

Przypisy i zaawansowana treść

GitHub obsługuje również przypisy Używając składni opartej na nawiasach i identyfikatora z przeplatanym znakiem. W miejscu, w którym chcesz umieścić odwołanie, wstawiasz coś takiego jak , a na końcu dokumentu definiujesz tekst tej notatki tym samym znacznikiem, po którym następuje dwukropek i treść.

Przypisy mogą obejmować wiele wierszy, a aby wymusić podział wiersza w przypisie, na końcu wiersza stosuje się podwójne spacje, tak jak w głównej części tekstu w Markdownie. Podczas renderowania GitHub wyświetla indeks górny w tekście i listę przypisów na końcu, wraz z linkami zwrotnymi do nawigacji między odniesieniami i przypisami.

Kolejną zaawansowaną funkcją oferowaną przez GitHub jest... alarmy Zostały one już omówione (UWAGA, WSKAZÓWKA, WAŻNE, OSTRZEŻENIE i PRZESTROGA). Zaleca się ich używanie tylko wtedy, gdy jest to naprawdę konieczne i aby uniknąć zbyt wielu elementów, które mogłyby przytłoczyć czytelnika. Nie można ich zagnieżdżać w innych złożonych elementach, dlatego staranne zaplanowanie ich rozmieszczenia jest kluczowe.

Na koniec możesz poprosić GitHub o tymczasowe ukrycie sekcji renderowanego kodu Markdown poprzez umieszczenie ich w komentarzach HTML lub o zignorowanie przetwarzania niektórych znaków za pomocą ukośników odwrotnych. Jest to szczególnie przydatne podczas dokumentowania Własna składnia Markdowna A przykłady trzeba pokazywać takimi, jakie są, bez interpretacji.

Markdown na Reddicie: Snoomark i tryb edycji

Reddit to platforma dyskusyjna, na której mile widziany jest niemal każdy temat, podzielona na subreddity. Oferuje dwa edytory formatowania: jeden do tekstu sformatowanego, bardziej wizualnego, oraz drugi do zwykłego tekstu opartego na Markdownie. Jeśli chcesz pracować szybko i mieć pełną kontrolę nad rezultatem, skorzystaj z opcji Markdown.

Domyślnie Reddit zazwyczaj aktywuje edytor tekstu sformatowanego, więc aby przełączyć się na tryb znaczników, należy kliknąć opcję Tryb Markdown w polu tekstowym wpisu lub komentarza. Stamtąd możesz bezpośrednio skorzystać ze składni Snoomark.

Jeśli wolisz, aby edytor Markdown zawsze się ładował, przejdź do ustawień użytkownika, wejdź w sekcję Ustawienia kanału i aktywuj tę opcję Domyślnie do MarkdownuDzięki temu za każdym razem, gdy zaczniesz pisać wpis lub komentarz, edytor Markdown otworzy się automatycznie i nie będziesz musiał wprowadzać zmian ręcznie.

Reddit obsługuje większość podstawowych i zaawansowanych funkcji Markdown: nagłówki, pogrubienie i kursywę, listy, cytaty, bloki kodu, linki oraz niektóre własne dodatki, takie jak spoilery. Ma jednak znaczące braki w porównaniu z GitHubem, zwłaszcza w… zarządzanie obrazamico w dużej mierze zależy od kontekstu i typu edytora.

Składnia obsługiwana przez Reddit i spoilery

Wariant Snoomark używany przez Reddit zawiera wiele elementów wspólnych z GitHubem, więc jeśli znasz już Markdown w repozytoriach, przeniesienie tej wiedzy do środowiska Reddita jest dość proste. Możesz używać nagłówków do strukturyzowania długich postów, numerowanych lub wypunktowanych list, cytatów do odpowiadania innym użytkownikom oraz bloków kodu, aby wyświetlać polecenia lub fragmenty techniczne.

Jedną z zauważalnych różnic jest sposób, w jaki Reddit radzi sobie z obrazowośćMimo że w wielu przypadkach obrazy przesyła się za pomocą graficznego interfejsu, a nie bezpośrednio przy użyciu składni Markdown, to silnikiem przetwarzającym treść tekstową jest nadal Snoomark, a zatem formatowanie otaczające te obrazy opiera się na Markdown.

Z drugiej strony Reddit dodaje dodatkowe elementy które nie są częścią standardowej specyfikacji, takie jak spoilery. Pozwalają one ukryć tekst za warstwą, którą użytkownik może wyświetlić jednym kliknięciem. Technicznie rzecz biorąc, gdy Reddit przetwarza spoiler, przekształca go w kombinację HTML, klas CSS i JavaScriptu specyficznego dla danej platformy.

Wynikowa reprezentacja spoilera w formacie HTML zawiera procedury obsługi, które kontrolują, kiedy pokazać lub ukryć treść. Teoretycznie coś podobnego można by napisać w zwykłym HTML-u, ale na Reddicie zależy to od jego wewnętrznej implementacji. Dla Ciebie jako użytkownika ważne jest, aby podczas pisania używać wyłącznie konkretnej składni spoilera dostarczonej przez edytor. Za tłumaczenie odpowiada Snoomark do odpowiedniej struktury.

Krótko mówiąc, Snoomark dziedziczy wiele funkcji z GitHub Flavored Markdown, ale jest ukierunkowany na potrzeby społeczności dyskusyjnej, a nie dokumentacji projektu. Mimo to rdzeń pozostaje ten sam: zwykły tekst z prostymi symbolami przekształcony w ustrukturyzowaną i czytelną treść.

Znajomość składni Markdown na GitHubie i Reddicie znacznie usprawnia pisanie dokumentacji technicznej, zgłaszanie dobrze wyjaśnionych problemów, dodawanie jasnych komentarzy do pull requestów i uczestnictwo w dyskusjach na Reddicie. Dzięki kilku kluczowym zasadom – nagłówkom, wyróżnieniom, listom, cytatom, blokom kodu, linkom, obrazkom i konkretnym sztuczkom, takim jak tabele, zwijane szczegóły, alerty, przypisy i spoilery – możesz przejść od pisania zwykłego tekstu do tworzenia… czysta, łatwa do skanowania i profesjonalna treść bez dotykania ani jednego przycisku myszy.