- Markdown vam omogoča hitro oblikovanje navadnega besedila na GitHubu in Redditu z lahko in enostavno zapomnljivo sintakso.
- GitHub Flavored Markdown dodaja tabele, sezname opravil, opozorila, opombe in napredno navigacijo med razdelki.
- Reddit uporablja Snoomark, različico Markdowna, podobno kot GitHub, vendar s funkcijami, kot so spojlerji in drugačen način obdelave slik.
- Nadzor nad naslovi, seznami, citati, kodo, povezavami in slikami drastično izboljša berljivost in učinkovitost katere koli vsebine na obeh platformah.

Če redno pišete na GitHubu ali preživite veliko časa na Redditu, obvladovanje Markdown To je ena tistih stvari, ki vam prihranijo ure in olajšajo življenje. Gre za zelo lahek označevalni jezik, ki vam omogoča hitro oblikovanje navadnega besedila, brez težav z meniji ali gumbi, le z nekaj simboli, postavljenimi na prava mesta.
Na GitHubu ga boste našli povsod: v datotekah PREBERITE.md iz repozitorijev, težav, zahtevkov za prevzem, razprav in celo vašega lastnega profila. Reddit pa uporablja različico, imenovano Snoomark (Markdown v slogu Reddita), ki podeduje velik del sintakse GitHuba, z nekaj edinstvenimi funkcijami in določenimi omejitvami. Poglejmo si korak za korakom in s številnimi primeri, Kako hitro uporabiti Markdown na GitHubu in Redditu in ne da bi pri tem izpustili kaj pomembnega.
Kaj je Markdown in zakaj je tako uporaben na GitHubu in Redditu?
Markdown je a lahek označevalni jezik Zasnovan je tako, da je navadno besedilo enostavno za branje in pisanje, hkrati pa omogoča enostavno pretvorbo v HTML. V praksi to pomeni, da lahko pišete navadno besedilo in mu dodajate posebne znake za ustvarjanje naslovov, seznamov, tabel, citatov, oblikovane kode, povezav ali slik.
Na GitHubu se uporablja implementacija GitHub Flavored Markdown (GFM), ki razširja klasično sintakso s tabelami, seznami opravil, naprednim označevanjem kode, podporo za barve, opozorili in nekaterimi dovoljenimi oznakami HTML. Vse to se upodobi samodejno v datotekah .md in v poljih za komentarje platforme.
Reddit uporablja svoj procesor, imenovan Snoomark, izpeljanko GFM-a. Z njim si deli večino osnovnega delovanja (krepko, kurzivno, naslovi, seznami, narekovaji, vgrajena ali blokovna koda, povezave itd.), vendar ima pomembne lastnostiNa primer, podpora slikam je bolj omejena glede na kontekst in dodaja svoje elemente, kot so spojlerji.
Lepota vsega tega je v tem, da lahko z eno samo sintakso pišete besedila, ki so videti dobro tako na GitHubu kot na Redditu, pri čemer prilagodite le nekaj podrobnosti, kjer vsaka platforma deluje drugače. Naučite se osnovnih pravil Omogoča vam prosto gibanje v obeh, ne da bi se morali česar koli znova učiti iz nič.
Naslovi in struktura vsebine
Ena prvih stvari, ki jih boste uporabili, je nasloviTako na GitHubu kot na Redditu se uporabljajo za strukturiranje besedila v razdelke in podrazdelke.
V Markdownu se naslov ustvari tako, da se pred besedilom doda od enega do šest lojsteric: eden za naslov 1. stopnje, dva za 2. stopnjo in tako naprej do 6. stopnje. Na primer, v datoteki GitHub README.md lahko dobite nekaj takega: # Glavni naslov, ## Oddelek, ### Pododdelek, Itd
Ko GitHub v datoteki najde dve ali več glav, samodejno ustvari kazalo vsebine Dostopno prek ikone »Oris« na vrhu datoteke. Vsak naslov se prikaže kot povezava, ki vas vodi neposredno do tega razdelka, kar je odlično za dolge dokumente.
Poleg tega vsak naslov postane notranje sidro, na katerega se lahko povežete z delčkom URL-ja na podlagi besedila naslova. Za generiranje tega delčka GitHub uporablja zelo specifična pravila: pretvori črke v male črke, presledke nadomesti z vezaji, odstrani ločila in znake za oblikovanje (kot je kurziva), obreže odvečne presledke in, če se rezultat ujema z drugim prejšnjim naslovom, dodajte numerično pripono (-1, -2 itd.), da postane edinstveno.
To vam omogoča, da naredite stvari, kot je postavitev odseka ## Vzorčni odsek in nato nanj ustvarite povezavo z druge točke v dokumentu, kot je ta: (#vzorec-oddelka)ali celo povezave do razdelkov s posebnimi znaki v naslovu, saj GitHub ustvari delček kode po teh pravilih in ga omogoči dostop do njega z istim vzorcem.
Poudarek, označeno besedilo in citati
Markdown vam omogoča označevanje besedila z različnimi metodami poudarekKrepko, poševno, prečrtano, podpisano, nadpisano ali podčrtano. Na GitHubu bi tipična tabela slogov izgledala nekako takole, čeprav smo jo tukaj povzeli z drugimi besedami:
Za vnos besedila krepkoKrepko besedilo je označeno z dvojnimi zvezdicami ali dvojnimi podčrtaji; za poševni tisk se uporabljajo enojne zvezdice ali podčrtaji; za prečrtanje se na vsako stran besedila postavi dvojna tilda (dve tildi). Vgnezdeno krepko in poševno pisavo je mogoče tudi kombinirati, tri zvezdice pa lahko uporabite za uporabo obeh na celotnem odseku besedila ali pa uporabite oznake HTML, kot je <br>. y za podpise in nadpise ter za podčrtavanje.
GitHub vam omogoča tudi ustvarjanje citati v slogu blokovnih citatov Če na začetek vrstice postavite simbol »večje od« (>), se citirano besedilo prikaže z navpično črto na levi in v sivi barvi, zaradi česar jasno izstopa. V isti blok citata je mogoče vključiti več vrstic, citate pa je mogoče celo gnezditi z dodajanjem več simbolov > na začetek.
Napredna oblika citiranja, ki obstaja samo na GitHubu, je opozorila ali opominiTemeljijo na isti sintaksi blokovnega citatu, vendar prva vrstica vključuje poseben označevalec, ki označuje vrsto opozorila. Na primer, lahko določite `<alert>` za koristne informacije, `<helpful tips>` za praktične nasvete, `<key data>` za ključne podatke, `<urgent notices>` za nujna opozorila in `<alert>` za opozorila o tveganjih ali negativnih posledicah. GitHub prikaže vsako vrsto z drugačno barvo in ikono, kar pomaga poudariti kritične informacije v dokumentaciji.
Reddit podpira tudi preproste narekovaje z istim simbolom >, čeprav nima bogatega sistema opozoril GitHub. Kljub temu ostaja zelo uporaben način za odgovoriti nekomu s citiranjem dela njegovega sporočila brez popolnega ponavljanja.
Označevanje kode, bloki in barve
Tako GitHub kot Reddit omogočata označevanje odlomkov kode znotraj besedila z uporabo povratnih kljukic. Pri kodi v vrstici besedo ali ukaz ogradite z eno povratno kljukico na vsaki strani. To je idealno za označevanje, na primer, status git znotraj stavka, s čimer se jasno pove, da gre za ukaz.
Ko želite samostojen blok kode, Markdown uporabi tri povratne kljukice: napišete vrstico s tremi povratnimi kljukicami, nato kodo v ločenih vrsticah in zaključite s še tremi povratnimi kljukicami. Na GitHubu, če takoj za prvo povratno kljukico določite tudi jezik, velja ... poudarjanje skladnje z barvami in obliko, značilno za ta jezik.
GitHub ponuja tudi posebno funkcijo za označevanje barvne vrednosti znotraj povratnih odmikov. Če med povratnimi odmiki napišete barvo v šestnajstiški obliki, RGB ali HSL, platforma poleg besedila vključi majhen indikator barve. Če je na primer ozadje v svetlem načinu #ffffff in v temnem načinu #000000, vam označevanje teh kod omogoča, da hitro vidite, katera je katera.
Kar zadeva vizualizacijo kode in tabel, vam GitHub omogoča, da v vseh poljih za komentarje omogočite fiksno pisavo z enorazmernim prostorom, da bo delo s tehničnim besedilom udobnejše. Če v brskalniku ali urejevalnikih, kot je Koda Visual StudioOmogočanje te možnosti olajša poravnavo in branje. veliko bolj koherentno.
Reddit podpira tudi bloke kode s povratnimi kljukicami, tako vrstičnimi kot blokovnimi, čeprav je njihova uporaba tam bolj osredotočena na majhne delčke ali psevdokod kot na dolgo dokumentacijo, kot je tista v repozitoriju.
Ustvarjanje povezav v Markdownu je zelo preprosto: besedilo, ki se bo prikazalo uporabniku, zaprete v oglat oklepaj, URL pa v oklepaj. To deluje tako na GitHubu kot na Redditu in ga je mogoče izboljšati s bližnjicami na tipkovnici na GitHubu (na primer z uporabo kombinacij tipk za hitro pretvorbo izbranega besedila v povezavo).
GitHub dodaja nekaj dodatnih funkcij, povezanih z navigacijo. Kot prvo omogoča neposredna povezava do naslovov z uporabo prej omenjenih pravil za generiranje fragmentov. Poleg tega podpira relativne povezave znotraj samega repozitorija, kar je ključnega pomena pri tehnični dokumentaciji.
Relativna povezava je tista, ki se izračuna z uporabo trenutne datoteke kot reference. Če je na primer vaša datoteka README v korenu projekta in želite vzpostaviti povezavo z datoteko docs/CONTRIBUTING.md, preprosto napišete povezavo s potjo docs/CONTRIBUTING.md. GitHub poskrbi za pravilno prevajanje te relativne povezave v kateri koli veji, na kateri ste, in preprečuje, da bi se pokvarila pri preklapljanju vej ali kloniranju repozitorija.
Priporočilo je, da vedno uporabljate relativne poti Za navigacijo med datotekami znotraj istega repozitorija, ker absolutne povezave lahko prenehajo delovati v klonih ali razcepljenih delih, GitHub dovoljuje uporabo standardnih operatorjev, kot sta ./ ali ../, in poti, ki se začnejo z / glede na koren projekta.
Če želite v dokumentu ustvariti sidrne točke po meri, ki presegajo naslove, lahko uporabite oznake HTML z atributom `name`. To vam omogoča, da ciljno točko postavite na sredino odstavka ali poleg besedila, ki nima svojega naslova, in se nanjo povežete z isto sintakso kot za samodejno ustvarjene naslove.
Slike na GitHubu: Markdown, HTML in relativne poti
Na GitHubu so slike običajno vdelane z isto sintakso kot povezave, vendar pred njimi stoji klicaj. Alternativno besedilo (alt) je navedeno v oglatih oklepajih, URL ali pot do slike pa v oklepajih. To alternativno besedilo je pomembno za dostopnostiker bodo bralniki zaslona to prebrali in kaj se bo prikazalo, če se slika ne naloži.
Slike lahko prihajajo iz datotek znotraj samega repozitorija ali iz zunanjih URL-jev. GitHub omogoča več vzorcev relativnih poti za nalaganje slik iz različnih vej, drugih repozitorijev ali celo težav in komentarjev z uporabo pripon, kot so ?raw=true da po potrebi prisilite neposreden prenos datoteke.
Poleg standardne sintakse Markdowna GitHub podpira uporabo elementa HTML Ta izdelek je še posebej uporaben za polnjenje odzivne slike Te se spreminjajo glede na uporabnikove nastavitve teme (svetla ali temna). Z medijsko poizvedbo `prefers-color-scheme` lahko določite različne vire slik za vsak način in privzeto sliko za brskalnike, ki te funkcije ne podpirajo.
Tipičen vzorec vključuje vključitev znotraj več elementov z atributi media in srcset ter končno a Z uporabo atributa alt in generičnega URL-ja uporabniki v temnem načinu vidijo prilagojeno sliko, medtem ko tisti v svetlem načinu prejmejo drugačno, ne da bi morali podvajati vsebino v datoteki README.
GitHub podpira tudi komentarje HTML v datotekah Markdown, kar vam omogoča, da bralcu dodate nevidne opomnike, na primer, da ga opomnite na posodobitev razdelka slike ali dodajanje novih primerov pozneje.
Tabele, raztegljivi deli in ločevanje vsebine
Ena najbolj uporabnih izboljšav v GitHub Flavored Markdown je podpora za mizePodatke lahko organizirate v vrstice in stolpce z navpičnimi črtami za ločevanje celic in črtkano črto za označevanje glave. Stolpce lahko poravnate tudi desno, levo ali na sredino z dvopičjem v ločilni vrstici.
Tabele so zelo uporabne za predstavitev seznamov programskih jezikov, uporabljenih ogrodji, načrtovanih nalog, primerjav funkcij ali katerih koli drugih informacij, ki imajo koristi od matrične strukture. GitHub te tabele upodablja v čistem in berljivem slogu.
Za organiziranje dolge datoteke README lahko uporabite oznako HTML za ustvarjanje zložljivih razdelkov. Ti razdelki prikazujejo povzetek znotraj oznake in uporabniku omogočijo razširitev ali zoženje dodatne vsebine po potrebi. Običajno se tabele ali bloki sekundarnih informacij priložijo znotraj da se izognemo preobremenitvi oči.
Če želite, da se razdelek privzeto prikaže razširjen, preprosto dodajte atribut open v Ta tehnika je zelo praktična za združevanje lestvic, dolgih seznamov ali vsebine, ki ni bistvena za prvo branje, vendar je priročno imeti dostopno.
Drugo preprosto orodje za organiziranje informacij je vodoravno pravilo. Ustvari se tako, da na črto napišete tri ali več pomišljajev in služi za risanje ločnice med razdelki, kar omogoča jasno ločevanje na primer opisnega razdelka od razdelka z referencami ali dodatnimi opombami.
Ta pravila je mogoče kombinirati s citati na koncu dokumenta, da poudarite navdihujoče fraze, opomnike ali ključna sporočila. Tipičen primer bi bila postavitev motivacijskega citata na konec datoteke README vašega profila, oblikovanega z blokovnim citatom za ločilno črto.
Skriti komentarji in nadzor oblike
GitHub vam omogoča predstavitev HTML-komentarji znotraj Markdowna z uporabo sintakse Karkoli boste vnesli v ta komentar, ne bo prikazano v upodobljeni vsebini, bo pa vidno v izvorni kodi, zato je idealno za interne zapiske ali opravila.
Na primer, v datoteki README profila lahko dodate komentar, ki pravi nekaj takega, kot je, da morate pozneje razširiti razdelek »O meni« ali da morate pregledati tabelo zastarelih tehnologij, ne da bi jo kdo, ki obišče profil, videl neposredno.
Druga uporabna funkcija je tista, ubežni znaki kar bi se običajno interpretiralo kot Markdown. Če morate zvezdice, lojtre ali druge simbole prikazati dobesedno, ne da bi bili oblikovani, preprosto pred vsakega postavite poševno črtico nazaj. To vam na primer omogoča pisanje izrazov, ki vključujejo simbole seznama, ne da bi jih pretvorili v dejanske sezname.
Ko si na GitHubu ogledujete datoteko z oznakami, lahko z gumbom na vrhu preklapljate med upodobljenim pogledom in izvorno kodo (ali pa jo odprete v urejevalnikih, kot je NosilciČe onemogočite interpretacijo Markdowna, lahko dostopate do tipičnih funkcij prikaza kode, kot so povezava do določenih vrsticTo je zelo uporabno, če želite pokazati na natančen del datoteke README ali katere koli datoteke .md.
Nenazadnje ne pozabite, da GitHub obravnava prelome vrstic drugače v komentarjih (težave, PR-ji itd.) in v datotekah .md. V komentarjih se prelomi vrstic upoštevajo neposredno, medtem ko morate v datotekah Markdown na konec vrstice dodati dva presledka, poševnico nazaj ali piko. , da vsilite skok znotraj istega odstavka.
Seznami, ugnezdeni seznami in seznami opravil
Seznami so eden najpogosteje uporabljenih elementov v Markdownu, tako na GitHubu kot na Redditu. Sezname lahko ustvarite neurejeno tako, da pred vsak element seznama postavite vezaj, zvezdico ali znak plus. Vse te oznake so upodobljene podobno kot alineje.
Za ustvarjanje seznamov naročenoVsaka vrstica je oštevilčena s številko, ki ji sledi pika in presledek. Čeprav vrstni red številk ni nujno popoln (GitHub ga običajno preračuna), je dobro ohraniti dosledno oštevilčenje, da bo izvorna koda berljiva.
Vgnezdeni seznami se ustvarijo preprosto z dodajanjem zamika elementom pod njimi. V urejevalnikih z enorazporeditvenim vrstnim redom, kot je Sublime BesediloPreprosto vizualno poravnajte oznake vgnezdenega seznama pod prvim znakom besedila v nadrejenem elementu. V kontekstih, kot je urejevalnik komentarjev GitHub, kjer pisava ni monospaced, preštejte število znakov pred besedilom in to število presledkov uporabite za zamik.
Zgradite lahko tudi več ravni gnezdenja, če le ohranite doslednost v številu presledkov. Za zelo zapletene sezname ta sistem zahteva nekaj vaje, a ko se ga enkrat navadite, ga je zelo hitro uporabiti.
GitHub ponuja tudi sezname opravkovTo je zelo uporabno za težave, zahteve za prevzem in dokumentacijo. Ustvarijo se tako, da pred vezaj vstavijo presledek in par oglatih oklepajev s presledkom ali znakom "x" v notranjosti: za čakajoče naloge in za dokončane naloge. Ti seznami so upodobljeni s potrditvenimi polji, ki jih je mogoče v vmesniku označiti ali odznačiti.
Če se besedilo elementa seznama opravil začne z oklepajem, ga je treba ubežati s poševno črto, da se izognemo zmedi v razčlenjevalniku. To je majhna podrobnost, vendar pomembna pri pisanju opisov, ki se začnejo z nečim podobnim, kot je »(Neobvezno)«.
Omembe, reference in emojiji na GitHubu
Ena od prednosti pisanja v Markdownu na GitHubu je možnost uporabe omenja Neposredna sporočila uporabnikom in ekipam na platformi. Preprosto vnesite @, ki mu sledi uporabniško ime ali ime ekipe, in GitHub bo poslal obvestilo temu računu, s čimer bo njihovo pozornost usmeril na pogovor.
Ko vnesete simbol @, GitHub prikaže seznam uporabnikov in ekip, povezanih z repozitorijem ali nitjo, ta seznam pa lahko med tipkanjem filtrirate. Za sprejem predlogov uporabite puščične tipke in pritisnite Enter ali Tab. Za ekipe uporabite obliko @organizacija/ime-ekipe in vsi člani ekipe bodo naročeni na nit.
Poleg omemb GitHub omogoča težave s referencami in zahteve za prevzem Preprosto vtipkajte #, ki mu sledi številka ali del naslova. Prikazal se bo seznam predlaganih rezultatov, ki ga lahko izpolnite na enak način kot pri omembah. To močno pospeši navigacijo med povezanimi pogovori.
Če ima vaš repozitorij konfigurirane samodejno povezane reference po meri, se lahko nekatere zunanje notacije (kot so ID-ji vstopnic JIRA ali Zendesk) samodejno pretvorijo v kratke povezave. Ta nastavitev zahteva skrbniške pravice, ko pa je omogočena, omogoča skupno rabo podatkov med sistemi z minimalnim naporom.
Končno, GitHub podpira emojije prek kode: vnesite dvopičje, ki mu sledi ime emojija in končajte z drugim dvopičjem. Ko začnete tipkati, se prikaže seznam predlogov, ki jih lahko sprejmete s tipko Tab ali Enter. Vključitev emojijev v komentarje jim pomaga dati bolj človeški pridih, če jih le ne pretiravate z uporabo v formalni dokumentaciji.
Opombe in napredna vsebina
GitHub podpira tudi Opombe Uporaba sintakse na osnovi oklepajev in identifikatorja s prepletenim znakom. Na mestu, kjer želite sklic, vstavite nekaj takega kot , na koncu dokumenta pa definirate besedilo te opombe z isto oznako, ki ji sledi dvopičje in vsebina.
Opombe lahko segajo čez več vrstic, za prelom vrstic znotraj opombe pa se na koncu vrstice uporabijo dvojni presledki, tako kot v glavnem delu Markdowna. Pri upodabljanju GitHub prikaže nadpis nad besedilom in na koncu seznam opomb s povratnimi povezavami za navigacijo med referencami in opombami.
Druga napredna funkcija, ki jo ponuja GitHub, je ... opozorila O teh elementih (OPOMBA, NASVET, POMEMBNO, OPOZORILO in POZOR) je že govora. Priporočljivo jih je uporabljati le, kadar je to resnično potrebno, in se izogibati prevelikemu združevanju, da bralca ne preobremenite. Ni jih mogoče vgnezditi v druge kompleksne elemente, zato je skrbno načrtovanje njihove namestitve bistvenega pomena.
Končno lahko GitHub prosite, naj začasno skrije dele upodobljenega Markdowna tako, da jih zavije v komentarje HTML, ali pa naj prezre obdelavo določenih znakov s poševnimi črtami nazaj. To je še posebej uporabno pri dokumentiranju. Markdownova lastna sintaksa In primere morate prikazati takšne, kot so, brez interpretacije.
Markdown na Redditu: Snoomark in način urejanja
Reddit je platforma za razprave, kjer je dobrodošla skoraj vsaka tema, organizirana v podreddite. Kar zadeva oblikovanje, ponuja dva urejevalnika: enega za obogateno besedilo, ki je bolj vizualno, in drugega za navadno besedilo, ki temelji na Markdownu. Če želite delati hitro in imeti natančen nadzor nad rezultatom, boste želeli uporabiti možnost Markdown.
Reddit privzeto običajno aktivira urejevalnik obogatenega besedila, zato morate za preklop v način označevanja klikniti na možnost Način označevanja znotraj besedilnega polja objave ali komentarja. Od tam lahko neposredno uporabite sintakso Snoomark.
Če želite, da se urejevalnik Markdown vedno naloži, pojdite v uporabniške nastavitve, vstopite v razdelek Nastavitve vira in aktivirajte možnost Privzeto na markdownTako se bo urejevalnik Markdown vsakič, ko začnete pisati objavo ali komentar, samodejno odprl, ne da bi ga morali ročno spreminjati.
Reddit podpira večino osnovnih in naprednih funkcij Markdowna: naslove, krepko in kurzivno pisavo, sezname, citate, bloke kode, povezave in nekatere lastne dodatke, kot so spojlerji. Vendar ima v primerjavi z GitHubom precejšnje pomanjkljivosti, zlasti v ravnanje s slikamikar je precej odvisno od konteksta in vrste urednika.
Sintaksa, ki jo podpira Reddit, in spojlerji
Različica Snoomark, ki jo uporablja Reddit, vključuje veliko skupnih elementov z GitHubom, zato je prenos tega znanja v okolje Reddit precej preprost, če že obvladate Markdown za repozitorije. Za strukturiranje dolgih objav lahko uporabite naslove, oštevilčene ali označene sezname, citate za odgovor drugim uporabnikom in bloke kode, ko želite prikazati ukaze ali tehnične delčke.
Ena od opaznih razlik je način, kako Reddit obravnava posnetkiČeprav se slike v mnogih primerih nalagajo prek grafičnega vmesnika in ne neposredno s sintakso Markdown, je mehanizem, ki obdeluje besedilno vsebino, še vedno Snoomark, zato oblikovanje, ki obdaja te slike, temelji na Markdownu.
Reddit pa dodaja, dodatni elementi ki niso del standardne specifikacije, kot so spojlerji. Ti omogočajo skrivanje besedila za plastjo, ki jo lahko uporabnik razkrije s klikom. Tehnično gledano Reddit ob obdelavi spojlerja pretvori v kombinacijo HTML-ja, razredov CSS in JavaScripta, specifičnega za platformo.
Nastala HTML predstavitev spojlerja vključuje obdelovalce, ki nadzorujejo, kdaj prikazati ali skriti vsebino, in čeprav bi teoretično lahko nekaj podobnega napisali z navadnim HTML-jem, je na Redditu odvisno od njegove notranje implementacije. Pomembno za vas kot uporabnika je, da morate pri pisanju uporabiti le specifično sintakso spojlerja, ki jo ponuja urejevalnik, in Snoomark je zadolžen za prevod. na ustrezno strukturo.
Skratka, Snoomark podeduje veliko vedenj od GitHub Flavored Markdown, vendar je usmerjen k potrebam diskusijske skupnosti in ne k projektni dokumentaciji. Kljub temu jedro ostaja enako: golo besedilo s preprostimi simboli, pretvorjeno v strukturirano in berljivo vsebino.
Obvladovanje sintakse Markdowna na GitHubu in Redditu močno poveča učinkovitost pisanja tehnične dokumentacije, odpiranja dobro pojasnjenih težav, puščanja jasnih komentarjev na zahteve za prevzem in sodelovanja v razpravah na Redditu. Z nekaj ključnimi pravili – naslovi, poudarki, seznami, citati, bloki kode, povezavami, slikami in posebnimi triki, kot so tabele, strnljive podrobnosti, opozorila, opombe in spojlerji – lahko preidete od pisanja navadnega besedila k ustvarjanju čista, pregledna in profesionalna vsebina brez dotika ene same tipke miške.
Vsebina
- Kaj je Markdown in zakaj je tako uporaben na GitHubu in Redditu?
- Naslovi in struktura vsebine
- Poudarek, označeno besedilo in citati
- Označevanje kode, bloki in barve
- Povezave, sidra in notranja navigacija
- Slike na GitHubu: Markdown, HTML in relativne poti
- Tabele, raztegljivi deli in ločevanje vsebine
- Skriti komentarji in nadzor oblike
- Seznami, ugnezdeni seznami in seznami opravil
- Omembe, reference in emojiji na GitHubu
- Opombe in napredna vsebina
- Markdown na Redditu: Snoomark in način urejanja
- Sintaksa, ki jo podpira Reddit, in spojlerji
