Cara menggunakan Markdown dengan cepat di GitHub dan Reddit

Informatec Digital » Sumber » Cara menggunakan Markdown dengan cepat di GitHub dan Reddit

Jika anda kerap menulis di GitHub atau menghabiskan banyak masa di Reddit, menguasai Penurunan harga Ia merupakan salah satu perkara yang menjimatkan masa anda dan memudahkan hidup anda. Ia merupakan bahasa markup yang sangat ringan yang membolehkan anda memformat teks biasa dengan cepat, tanpa perlu bersusah payah dengan menu atau butang, hanya dengan beberapa simbol diletakkan di tempat yang betul.

Di GitHub anda akan menemuinya di mana-mana: dalam fail BACA.md daripada repositori, isu, permintaan tarik, perbincangan dan juga profil anda sendiri. Reddit, bagi pihaknya, menggunakan varian yang dipanggil Snoomark (Markdown gaya Reddit) yang mewarisi sebahagian besar sintaks GitHub, dengan beberapa ciri unik dan batasan tertentu. Mari kita lihat, langkah demi langkah dan dengan banyak contoh, Cara menggunakan Markdown dengan cepat di GitHub dan Reddit dan tanpa meninggalkan apa-apa yang penting.

Apakah Markdown dan mengapa ia begitu berguna di GitHub dan Reddit?

Penurunan harga adalah a bahasa penanda ringan Direka untuk menjadikan teks biasa mudah dibaca dan ditulis, di samping membolehkan penukaran kepada HTML dengan mudah. ​​Dalam praktiknya, ini bermakna anda boleh menulis teks biasa dan menambah aksara khas untuk mencipta tajuk, senarai, jadual, petikan, kod berformat, pautan atau imej.

Di GitHub, pelaksanaan yang digunakan ialah GitHub Flavored Markdown (GFM), yang melanjutkan sintaks klasik dengan jadual, senarai tugasan, penyerlahan kod lanjutan, sokongan warna, amaran dan beberapa tag HTML yang dibenarkan. Semua ini dipaparkan secara automatik dalam fail .md dan dalam ruangan komen platform.

Reddit menggunakan pemprosesnya sendiri yang dipanggil Snoomark, terbitan GFM. Ia berkongsi banyak ciri asas (huruf tebal, italik, tajuk, senarai, petikan, kod sebaris atau blok, pautan, dll.), tetapi ia mempunyai ciri pentingContohnya, sokongan imej lebih terhad bergantung pada konteks dan menambah elemennya sendiri seperti spoiler.

Keindahan semua ini ialah, dengan satu sintaks, anda boleh menulis teks yang kelihatan baik pada GitHub dan Reddit, hanya menyesuaikan beberapa butiran di mana setiap platform berfungsi secara berbeza. Ketahui peraturan asas Ia membolehkan anda bergerak bebas dalam kedua-duanya tanpa perlu mempelajari semula apa-apa dari awal.

Tajuk dan struktur kandungan

Antara perkara pertama yang akan anda gunakan ialah tajukKedua-dua di GitHub dan Reddit, ia digunakan untuk menstrukturkan teks kepada bahagian dan subseksyen.

Dalam Markdown, tajuk dicipta dengan meletakkan satu hingga enam simbol hash di hadapan teks: satu untuk tajuk tahap 1, dua untuk tahap 2, dan seterusnya sehingga tahap 6. Contohnya, dalam fail README.md GitHub anda mungkin mempunyai sesuatu seperti: # Tajuk utama, ## Bahagian, ### Subseksyen, Dll

Apabila GitHub menemui dua atau lebih pengepala dalam fail, ia secara automatik menjana jadual kandungan Boleh diakses daripada ikon "Garis Besar" di bahagian atas fail. Setiap tajuk muncul sebagai pautan yang membawa anda terus ke bahagian tersebut, yang sangat bagus untuk dokumen yang panjang.

Di samping itu, setiap tajuk menjadi sauh dalaman yang boleh anda pautkan dengan petikan URL berdasarkan teks tajuk. Untuk menjana petikan tersebut, GitHub menggunakan peraturan yang sangat spesifik: ia menukar huruf kepada huruf kecil, menggantikan ruang dengan tanda sempang, mengalih keluar tanda baca dan aksara pemformatan (seperti huruf condong), memangkas ruang berlebihan dan, jika hasilnya sepadan dengan tajuk sebelumnya yang lain, tambah akhiran angka (-1, -2, dsb.) untuk menjadikannya unik.

Ini membolehkan anda melakukan perkara seperti meletakkan bahagian ## Bahagian Contoh dan kemudian pautkannya dari titik lain dalam dokumen dengan pautan seperti ini: (#bahagian-sampel)atau pautan ke bahagian dengan aksara khas dalam tajuk, kerana GitHub menjana coretan mengikut peraturan tersebut dan menjadikannya boleh diakses dengan corak yang sama.

Penekanan, teks yang diserlahkan dan petikan

Markdown membolehkan anda menyerlahkan teks menggunakan pelbagai kaedah penekananTebal, italik, coretan, subskrip, superskrip atau garis bawah. Di GitHub, jadual gaya biasa akan kelihatan seperti ini, walaupun kami telah meringkaskannya di sini dengan perkataan yang berbeza:

Untuk memasukkan teks beraniTeks tebal disertakan dengan asterisk berganda atau garis bawah berganda; untuk huruf condong, asterisk tunggal atau garis bawah digunakan; untuk menconteng sesuatu, tilde berganda (dua tilde) diletakkan di kedua-dua belah teks. Huruf tebal dan italik bersarang juga boleh digabungkan, tiga asterisk boleh digunakan untuk digunakan pada keseluruhan bahagian teks, atau tag HTML seperti <br> boleh digunakan. _{y ^{untuk subskrip dan superskrip, dan untuk menggariskan.}}

GitHub juga membolehkan anda mencipta petikan gaya petikan blok Dengan meletakkan simbol lebih besar daripada (>) pada permulaan baris, teks yang dipetik dipaparkan dengan bar menegak di sebelah kiri dan berwarna kelabu, menjadikannya menonjol dengan jelas. Berbilang baris boleh disertakan dalam blok petikan yang sama, dan petikan juga boleh disusun dengan menambah lebih banyak simbol > pada permulaannya.

Satu bentuk petikan lanjutan yang hanya wujud di GitHub ialah amaran atau teguranIa berdasarkan sintaks petikan blok yang sama, tetapi baris pertama merangkumi penanda khas untuk menunjukkan jenis amaran. Contohnya, anda boleh menentukan `<alert>` untuk maklumat berguna, `<petua berguna>` untuk nasihat praktikal, `<data utama>` untuk data utama, `<notis segera>` untuk amaran segera dan `<alert>` untuk amaran risiko atau akibat negatif. GitHub memaparkan setiap jenis dengan warna dan ikon yang berbeza, membantu menyerlahkan maklumat penting dalam dokumentasi.

Reddit juga menyokong petikan ringkas dengan simbol > yang sama, walaupun ia tidak mempunyai sistem amaran GitHub yang kaya. Walaupun begitu, ia kekal sebagai cara yang sangat berguna untuk membalas seseorang dengan memetik sebahagian daripada mesej mereka tanpa mengulanginya sepenuhnya.

Penonjolan kod, blok dan warna

Kedua-dua GitHub dan Reddit membenarkan anda menyerlahkan coretan kod dalam teks menggunakan tanda semak belakang. Untuk kod sebaris, anda sertakan perkataan atau arahan dengan tanda semak belakang tunggal pada setiap sisi. Ini sesuai untuk menyerlahkan, contohnya, a git status dalam ayat, menjelaskan bahawa ia adalah satu perintah.

Apabila anda mahukan blok kod yang berdiri sendiri, Markdown menggunakan tiga tanda penyingkir: anda menulis satu baris dengan tiga tanda penyingkir, kemudian kod tersebut pada baris berasingan dan menutupnya dengan tiga tanda penyingkir yang lain. Di GitHub, jika anda juga menentukan bahasa sejurus selepas tanda penyingkir pertama, ia akan terpakai... penonjolan sintaksis dengan warna dan format khusus untuk bahasa tersebut.

GitHub juga menawarkan ciri khusus untuk menyerlahkan nilai warna dalam tanda belakang. Jika anda menulis warna dalam format heksadesimal, RGB atau HSL antara tanda belakang, platform tersebut akan menyertakan penunjuk warna kecil di sebelah teks. Contohnya, jika latar belakang dalam mod cahaya ialah #ffffff dan dalam mod gelap #000000, penonjolan kod ini membolehkan anda melihat dengan cepat yang mana satu.

Berkenaan kod dan visualisasi jadual, GitHub membolehkan anda mendayakan fon monospace tetap dalam semua medan komen untuk menjadikan kerja dengan teks teknikal lebih selesa. Jika anda mengedit banyak coretan kod dalam pelayar anda atau dalam editor seperti Kod Studio VisualMengaktifkan pilihan ini menjadikan penjajaran dan pembacaan lebih mudah. jauh lebih koheren.

Reddit juga menyokong blok kod dengan tanda semak belakang, baik dalam baris mahupun blok, walaupun penggunaannya di sana lebih tertumpu pada coretan kecil atau pseudokod berbanding dokumentasi panjang seperti repositori.

Pautan, sauh dan navigasi dalaman

Mencipta pautan dalam Markdown adalah sangat mudah: anda sertakan teks yang akan dipaparkan kepada pengguna dalam kurungan segi empat sama dan URL dalam kurungan. Ini berfungsi pada GitHub dan Reddit, dan boleh dipertingkatkan dengan pintasan papan kekunci pada GitHub (contohnya, menggunakan kombinasi kekunci untuk menukar teks yang dipilih menjadi pautan dengan cepat).

GitHub menambah beberapa ciri tambahan yang berkaitan dengan navigasi. Antaranya, ia membenarkan pautan terus ke tajuk menggunakan peraturan penjanaan fragmen yang dibincangkan sebelum ini. Tambahan pula, ia menyokong pautan relatif dalam repositori itu sendiri, yang penting dalam dokumentasi teknikal.

Pautan relatif ialah pautan yang dikira menggunakan fail semasa sebagai rujukan. Contohnya, jika README anda berada dalam root projek dan anda ingin memautkan ke fail docs/CONTRIBUTING.md, anda hanya perlu menulis pautan dengan laluan docs/CONTRIBUTING.md. GitHub mengendalikan penterjemahan pautan relatif ini dengan betul dalam mana-mana cabang yang anda gunakan, menghalangnya daripada rosak semasa menukar cabang atau mengklon repositori.

Cadangannya adalah untuk sentiasa menggunakan laluan relatif Untuk menavigasi antara fail dalam repositori yang sama, kerana pautan mutlak mungkin berhenti berfungsi dalam klon atau fork, GitHub membenarkan penggunaan operator standard seperti ./ atau ../ dan laluan bermula dengan / relatif kepada root projek.

Jika anda ingin mencipta titik sauh tersuai dalam dokumen melangkaui tajuk, anda boleh menggunakan tag HTML dengan atribut `nama`. Ini membolehkan anda meletakkan titik sasaran di tengah-tengah perenggan atau di sebelah teks yang tidak mempunyai tajuknya sendiri dan memautkannya menggunakan sintaks yang sama seperti untuk tajuk yang dijana secara automatik.

Imej di GitHub: Markdown, HTML dan laluan relatif

Di GitHub, imej biasanya dibenamkan menggunakan sintaks yang sama seperti pautan, tetapi didahului oleh tanda seru. Teks alternatif (alt) dinyatakan dalam kurungan segi empat sama, dan URL atau laluan ke imej diletakkan dalam kurungan. Teks alternatif ini penting untuk kemudahankerana itulah yang akan dibaca oleh pembaca skrin dan apa yang akan dipaparkan jika imej tidak dimuatkan.

Imej boleh datang daripada fail dalam repositori itu sendiri atau daripada URL luaran. GitHub membenarkan pelbagai corak laluan relatif untuk memuat naik imej daripada cawangan yang berbeza, repositori lain atau isu dan komen, menggunakan akhiran seperti ?mentah=benar untuk memaksa muat turun terus fail apabila perlu.

Selain sintaks Markdown standard, GitHub menyokong penggunaan elemen HTML Item ini amat berguna untuk pengecasan imej responsif Ini berubah mengikut pilihan tema pengguna (cerah atau gelap). Menggunakan pertanyaan media `prefers-color-scheme`, anda boleh menentukan sumber imej yang berbeza untuk setiap mod dan imej lalai untuk pelayar yang tidak menyokong ciri ini.

Corak tipikal melibatkan penyertaan dalam beberapa elemen dengan atribut media dan srcsetnya, dan akhirnya a Menggunakan atribut alt dan URL generik, pengguna dalam mod gelap melihat imej yang disesuaikan, manakala mereka yang dalam mod terang menerima imej yang berbeza, tanpa perlu menduplikasi kandungan dalam fail README.

GitHub juga menyokong komen HTML dalam fail Markdown, membolehkan anda menambah peringatan yang tidak kelihatan kepada pembaca, contohnya untuk mengingatkan mereka untuk mengemas kini bahagian imej atau menambah contoh baharu kemudian.

Jadual, bahagian lipatan dan pemisahan kandungan

Salah satu penambahbaikan paling berguna dalam GitHub Flavored Markdown ialah sokongannya untuk jadualAnda boleh menyusun data ke dalam baris dan lajur menggunakan bar menegak untuk memisahkan sel dan garis putus-putus untuk menandakan pengepala. Anda juga boleh menjajarkan lajur ke kanan, kiri atau tengah menggunakan titik bertindih dalam baris pemisah.

Jadual sangat berguna untuk membentangkan senarai bahasa pengaturcaraan, rangka kerja yang digunakan, tugasan yang dirancang, perbandingan ciri atau sebarang maklumat lain yang mendapat manfaat daripada struktur matriks. GitHub memaparkan jadual ini dengan gaya yang bersih dan mudah dibaca.

Untuk memastikan fail README yang panjang teratur, anda boleh menggunakan tag HTML untuk mencipta bahagian yang boleh dilipat. Bahagian ini memaparkan ringkasan dalam label dan membolehkan pengguna mengembangkan atau mengecut kandungan tambahan mengikut keperluan. Adalah perkara biasa untuk melampirkan jadual atau blok maklumat sekunder di dalamnya untuk mengelakkan mata daripada terlalu sembap.

Jika anda mahu bahagian itu kelihatan dikembangkan secara lalai, cuma tambahkan atribut buka pada Teknik ini sangat praktikal untuk mengumpulkan kedudukan, senarai panjang atau kandungan yang tidak penting untuk bacaan pertama tetapi mudah diakses.

Satu lagi alat mudah untuk menyusun maklumat ialah peraturan mendatar. Ia dicipta dengan menulis tiga atau lebih sempang pada garisan dan berfungsi untuk melukis garis pemisah antara bahagian, membolehkan anda memisahkan dengan jelas, contohnya, bahagian deskriptif daripada bahagian rujukan atau nota tambahan.

Peraturan ini boleh digabungkan dengan petikan di akhir dokumen untuk menyerlahkan frasa inspirasi, peringatan atau mesej penting. Contoh biasa ialah meletakkan petikan motivasi di akhir README profil anda, diformatkan dengan petikan blok selepas baris pemisah.

Komen tersembunyi dan kawalan format

GitHub membolehkan anda memperkenalkan Komen HTML dalam Markdown menggunakan sintaks Apa-apa sahaja yang anda masukkan ke dalam komen itu tidak akan ditunjukkan dalam kandungan yang dipaparkan, tetapi ia akan kelihatan dalam kod sumber, jadi ia sesuai untuk nota dalaman atau tugasan.

Contohnya, dalam README profil, anda boleh menambah komen yang mengatakan sesuatu seperti anda perlu mengembangkan bahagian "Perihal saya" kemudian atau anda perlu menyemak jadual teknologi usang, tanpa sesiapa yang melawat profil tersebut melihatnya secara langsung.

Satu lagi fungsi berguna ialah watak-watak melarikan diri yang biasanya ditafsirkan sebagai Markdown. Jika anda perlu memaparkan asterisk, simbol hash atau simbol lain secara literal tanpa diformatkan, hanya perlu mendahului setiap satu dengan tanda sengkang terbalik. Ini membolehkan anda, sebagai contoh, menulis ungkapan yang merangkumi simbol senarai tanpa menukarnya kepada senarai sebenar.

Apabila anda melihat fail markup di GitHub, anda mempunyai pilihan untuk bertukar antara paparan yang dipaparkan dan kod sumber dengan butang di bahagian atas (atau membukanya dalam editor seperti KurunganMelumpuhkan interpretasi Markdown membolehkan anda mengakses ciri paparan kod biasa seperti menghubungkan baris tertentuIni sangat berguna apabila anda ingin menunjuk ke bahagian tepat README atau mana-mana fail .md.

Akhir sekali, ingat bahawa GitHub mengendalikan pemisah baris secara berbeza dalam komen (isu, PR, dll.) dan dalam fail .md. Dalam komen, pemisah baris dihormati secara langsung, manakala dalam fail Markdown anda perlu menambah dua ruang pada akhir baris, iaitu garis miring terbalik atau noktah. untuk memaksa lompatan dalam perenggan yang sama.

Senarai, senarai bersarang dan senarai tugasan

Senarai merupakan salah satu elemen yang paling banyak digunakan dalam Markdown, baik di GitHub mahupun Reddit. Anda boleh mencipta senarai tidak tertib dengan meletakkan tanda sempang, asterisk atau tanda tambah sebelum setiap item senarai. Semua tanda ini dipaparkan secara serupa sebagai titik bulet.

Untuk menjana senarai mengarahkanSetiap baris dinomborkan dengan nombor diikuti dengan noktah dan jarak. Walaupun susunan nombor tidak semestinya sempurna (GitHub biasanya mengiranya semula), adalah idea yang baik untuk mengekalkan penomboran yang konsisten bagi menjadikan kod sumber boleh dibaca.

Senarai bersarang dicipta hanya dengan menambah lekukan pada item di bawahnya. Dalam editor monospace seperti Text SublimeHanya jajarkan penanda senarai bersarang secara visual di bawah aksara pertama teks dalam elemen induk. Dalam konteks seperti editor komen GitHub, di mana fon tidak monospaced, kira bilangan aksara sebelum teks dan gunakan bilangan ruang tersebut untuk indentasi.

Anda juga boleh membina pelbagai peringkat sarang, selagi anda mengekalkan konsistensi dalam bilangan ruang. Untuk senarai yang sangat kompleks, sistem ini memerlukan sedikit latihan, tetapi sebaik sahaja anda menguasainya, ia sangat cepat digunakan.

GitHub juga menawarkan senarai tugasanIni sangat berguna untuk isu, permintaan tarik dan dokumentasi. Ia dicipta dengan mendahului tanda sempang, ruang dan sepasang kurungan segi empat sama dengan ruang atau "x" di dalamnya: untuk tugasan yang belum selesai dan untuk tugasan yang telah selesai. Senarai ini dipaparkan dengan kotak pilihan yang boleh ditanda atau dinyahtanda daripada antara muka.

Jika teks item senarai tugasan bermula dengan kurungan, ia mesti diketepikan dengan tanda sengkang terbalik untuk mengelakkan kekeliruan dalam penghurai. Ia merupakan butiran kecil, tetapi penting apabila menulis penerangan yang bermula dengan sesuatu seperti "(Pilihan)" atau yang serupa.

Sebutan, rujukan dan emoji di GitHub

Salah satu kelebihan menulis dalam Markdown di GitHub ialah dapat menggunakan menyebutnya Mesej terus kepada pengguna dan pasukan di platform. Cuma taip @ diikuti dengan nama pengguna atau nama pasukan, dan GitHub akan menghantar pemberitahuan ke akaun tersebut, menarik perhatian mereka kepada perbualan tersebut.

Apabila anda menaip simbol @, GitHub memaparkan senarai pengguna dan pasukan yang berkaitan dengan repositori atau thread, dan anda boleh menapis senarai ini semasa anda menaip. Gunakan kekunci anak panah dan tekan Enter atau Tab untuk menerima cadangan. Untuk pasukan, gunakan format @organisasi/nama-pasukan, dan semua ahli pasukan akan melanggan thread tersebut.

Selain menyebut, GitHub memudahkan isu rujukan dan permintaan tarik Cuma taip # diikuti dengan nombor atau sebahagian daripada tajuk. Senarai hasil yang dicadangkan akan muncul, yang boleh anda lengkapkan dengan cara yang sama seperti sebutan. Ini mempercepatkan navigasi antara perbualan yang berkaitan.

Jika repositori anda mempunyai rujukan autopautan tersuai yang dikonfigurasikan, notasi luaran tertentu (seperti ID tiket JIRA atau Zendesk) juga boleh ditukar secara automatik menjadi pautan pendek. Tetapan ini memerlukan keistimewaan pentadbiran, tetapi setelah diaktifkan, ia membolehkan perkongsian data merentas sistem dengan usaha yang minimum.

Akhir sekali, GitHub menyokong emoji melalui kod: taip titik bertindih, diikuti dengan nama emoji, dan akhiri dengan titik bertindih yang lain. Semasa anda mula menaip, senarai cadangan akan muncul, yang boleh anda terima dengan Tab atau Enter. Memasukkan emoji ke dalam komen anda membantu memberikan sentuhan yang lebih berperikemanusiaan, selagi anda tidak menggunakannya secara berlebihan dalam dokumentasi formal.

Nota kaki dan kandungan lanjutan

GitHub juga menyokong Nota kaki Menggunakan sintaks berasaskan kurungan dan pengecam dengan aksara berselang-seli. Pada titik di mana anda mahukan rujukan, anda memasukkan sesuatu seperti , dan pada akhir dokumen anda mentakrifkan teks nota tersebut dengan tag yang sama, diikuti dengan titik bertindih dan kandungannya.

Nota kaki boleh merangkumi berbilang baris, dan untuk memaksa pemecahan baris dalam nota kaki, ruang berganda digunakan pada akhir baris, sama seperti dalam isi utama Markdown. Semasa membuat paparan, GitHub memaparkan superskrip pada teks dan senarai nota kaki pada akhirnya, dengan pautan balik untuk menavigasi antara rujukan dan nota kaki.

Satu lagi ciri canggih yang ditawarkan oleh GitHub ialah... amaran Ini telah dibincangkan (NOTA, PETUA, PENTING, AMARAN dan AWAS). Adalah dinasihatkan untuk menggunakannya hanya apabila benar-benar perlu dan untuk mengelakkan daripada menyusun terlalu banyak bersama-sama bagi mengelakkan pembaca terbeban. Ia tidak boleh disarang dalam elemen kompleks lain, jadi perancangan penempatan yang teliti adalah penting.

Akhir sekali, anda boleh meminta GitHub untuk menyembunyikan bahagian Markdown yang diberikan buat sementara waktu dengan membungkusnya dalam komen HTML, atau mengabaikan pemprosesan aksara tertentu dengan garis miring terbalik. Ini amat berguna apabila anda mendokumentasikan Sintaks Markdown sendiri Dan anda perlu menunjukkan contoh sebagaimana adanya, tanpa tafsiran.

Markdown di Reddit: Snoomark dan mod penyuntingan

Reddit ialah platform perbincangan di mana hampir semua topik dialu-alukan, disusun dalam subreddit. Dari segi pemformatan, ia menawarkan dua editor: satu untuk teks kaya yang lebih visual, dan satu lagi untuk teks biasa berdasarkan Markdown. Jika anda ingin bekerja dengan cepat dan mempunyai kawalan yang baik ke atas hasilnya, anda perlu menggunakan pilihan Markdown.

Secara lalai, Reddit biasanya mengaktifkan editor teks kaya, jadi untuk bertukar kepada mod markup, anda perlu mengklik pada pilihan tersebut Mod penurunan harga dalam kotak teks siaran atau komen. Dari situ, anda boleh menggunakan sintaks Snoomark secara langsung.

Jika anda lebih suka editor Markdown sentiasa dimuatkan, anda harus pergi ke tetapan pengguna, masukkan bahagian Tetapan Suapan dan aktifkan pilihan tersebut Lalai kepada penurunan hargaDengan cara ini, setiap kali anda mula menulis catatan atau komen, editor Markdown akan dibuka secara automatik tanpa anda perlu mengubahnya secara manual.

Reddit menyokong kebanyakan ciri Markdown asas dan lanjutan: tajuk, huruf tebal dan italik, senarai, petikan, blok kod, pautan dan beberapa tambahannya sendiri seperti spoiler. Walau bagaimanapun, ia mempunyai kekurangan yang ketara berbanding GitHub, terutamanya dalam pengendalian imejyang sedikit sebanyak bergantung pada konteks dan jenis editor.

Sintaks disokong oleh Reddit dan spoiler

Varian Snoomark yang digunakan oleh Reddit merangkumi banyak elemen yang sama dengan GitHub, jadi jika anda sudah mahir dalam Markdown untuk repositori, memindahkan pengetahuan tersebut ke persekitaran Reddit agak mudah. ​​Anda boleh menggunakan tajuk untuk menstrukturkan catatan panjang, senarai bernombor atau berbulet, petikan untuk membalas pengguna lain dan blok kod apabila anda ingin memaparkan arahan atau coretan teknikal.

Salah satu perbezaan yang ketara ialah cara Reddit mengendalikan imejWalaupun dalam kebanyakan kes, imej dimuat naik melalui antara muka grafik dan bukan secara langsung dengan sintaks Markdown, enjin yang memproses kandungan teks masih Snoomark, jadi pemformatan yang mengelilingi imej tersebut adalah berdasarkan Markdown.

Reddit, sebaliknya, menambah elemen tambahan yang bukan sebahagian daripada spesifikasi standard, seperti spoiler. Ini membolehkan anda menyembunyikan teks di sebalik lapisan yang boleh didedahkan oleh pengguna dengan satu klik. Secara teknikalnya, apabila Reddit memproses spoiler, ia mengubahnya menjadi gabungan HTML, kelas CSS dan JavaScript khusus platform.

Perwakilan HTML yang terhasil bagi spoiler merangkumi pengendali yang mengawal bila hendak menunjukkan atau menyembunyikan kandungan, dan walaupun secara teorinya sesuatu yang serupa boleh ditulis dengan HTML biasa, di Reddit ia bergantung pada pelaksanaan dalamannya. Perkara penting bagi anda sebagai pengguna ialah, semasa menulis, anda hanya perlu menggunakan sintaks spoiler khusus yang disediakan oleh editor, dan Snoomark bertanggungjawab menterjemahkannya kepada struktur yang sesuai.

Pendek kata, Snoomark mewarisi banyak tingkah laku daripada GitHub Flavored Markdown, tetapi ditujukan kepada keperluan komuniti perbincangan dan bukannya dokumentasi projek. Walaupun begitu, terasnya tetap sama: teks biasa dengan simbol mudah diubah menjadi kandungan berstruktur dan boleh dibaca.

Menguasai sintaks Markdown pada GitHub dan Reddit menjadikan penulisan dokumentasi teknikal, membuka isu yang dijelaskan dengan baik, meninggalkan komen yang jelas pada permintaan tarik dan menyertai perbincangan Reddit dengan lebih cekap. Dengan beberapa peraturan utama—tajuk, penekanan, senarai, petikan, blok kod, pautan, imej dan helah khusus seperti jadual, butiran boleh lipat, amaran, nota kaki dan spoiler—anda boleh beralih daripada menulis teks biasa kepada mencipta kandungan yang bersih, boleh diimbas dan profesional tanpa menyentuh satu butang tetikus pun.