Markdown Dijelaskan dalam 5 Minit
Anda mungkin pernah menggunakan Markdown tanpa menyedarinya. Pernah menaip **tebal** dalam mesej Slack? Menulis README di GitHub? Memformat siaran Reddit? Itulah Markdown.
Markdown adalah cara ringan untuk memformat teks biasa menggunakan simbol mudah. Daripada mengklik butang bar alat untuk tebal, condong, tajuk, dan senarai, anda menaip beberapa aksara yang menunjukkan pemformatan yang anda mahukan. Ia dicipta pada tahun 2004 oleh John Gruber dan Aaron Swartz, dan sejak itu menjadi bahasa pemformatan lalai untuk pembangun, penulis, dan sesiapa sahaja yang bekerja dengan teks di web.
Mengapa Markdown Wujud
Sebelum Markdown, memformat teks untuk web bermakna menulis HTML. Untuk menjadikan perkataan tebal, anda menaip <strong>tebal</strong>. Untuk mencipta senarai, anda memerlukan <ul><li>item</li></ul>. HTML berkuasa tetapi bertele-tele dan sukar dibaca dalam bentuk mentahnya.
Markdown menyelesaikan masalah ini dengan menyediakan singkatan yang mudah dibaca manusia. Teks mentah mudah dibaca walaupun sebelum dipaparkan. Output yang diformat bersih dan profesional. Anda mendapat yang terbaik dari kedua-dua dunia: teks sumber yang mudah dibaca dan output yang dipoles.
Tahukah anda? Falsafah reka bentuk Markdown adalah bahawa teks mentah harus "boleh diterbitkan seadanya, sebagai teks biasa, tanpa kelihatan seperti telah ditanda dengan tag atau arahan pemformatan." Inilah sebab sintaks Markdown menggunakan aksara yang secara visual mencadangkan pemformatan yang dihasilkannya.
Sintaks Penting
Berikut adalah semua yang anda perlu tahu untuk mula menggunakan Markdown secara produktif.
Tajuk
Gunakan simbol hash (#) untuk mencipta tajuk. Lebih banyak hash bermakna tajuk yang lebih kecil.
# Tajuk 1 (terbesar)
## Tajuk 2
### Tajuk 3
#### Tajuk 4
Tebal dan Condong
Balut teks dalam asterisk atau garis bawah:
**teks tebal**
*teks condong*
***tebal dan condong***
Senarai
Senarai tidak tersusun menggunakan sengkang, asterisk, atau tanda tambah. Senarai tersusun menggunakan nombor.
- Item pertama
- Item kedua
- Item ketiga
1. Langkah pertama
2. Langkah kedua
3. Langkah ketiga
Pautan
Kurungan segi empat untuk teks, kurungan bulat untuk URL:
[Klik di sini](https://example.com)
Gambar
Seperti pautan, tetapi dengan tanda seru di depan:
Petikan Blok
Gunakan simbol lebih besar daripada:
> Ini adalah petikan. Ia akan ditengahkan dan digayakan secara berbeza.
Kod
Aksen belakang untuk kod sebaris, tiga aksen belakang untuk blok kod:
Gunakan fungsi `print()` untuk mengeluarkan teks.
Untuk blok kod berbilang baris, gunakan tiga aksen belakang dengan pengecam bahasa pilihan:
```python
def hello():
print("Hello, world!")
```
Garis Mendatar
Tiga atau lebih sengkang, asterisk, atau garis bawah:
---
Jadual
Gunakan paip dan sengkang:
| Nama | Peranan | Lokasi |
| --- | --- | --- |
| Alice | Pembangun | Berlin |
| Bob | Pereka | London |
Di Mana Markdown Digunakan
Markdown ada di mana-mana:
Pembangunan Perisian
- GitHub, GitLab, Bitbucket: README, isu, permintaan tarik, dan dokumentasi semuanya ditulis dalam Markdown.
- Stack Overflow: Soalan dan jawapan menggunakan pemformatan Markdown.
- Dokumentasi kod: Banyak penjana dokumentasi (Docusaurus, MkDocs, Jekyll) menggunakan Markdown sebagai format sumber mereka.
Komunikasi
- Slack: Menyokong subset Markdown untuk pemformatan mesej.
- Discord: Menggunakan Markdown untuk tebal, condong, blok kod, dan lagi.
- Reddit: Siaran dan komen diformat dengan Markdown.
Penulisan dan Penerbitan
- Blog: Banyak penjana tapak statik menggunakan fail Markdown sebagai sumber kandungan.
- Buku: Beberapa alat penerbitan menerima manuskrip Markdown.
- Nota: Aplikasi seperti Obsidian, Notion, Bear, dan Typora dibina di sekitar Markdown.
Dokumentasi
- Dokumen teknikal: Dokumentasi API, panduan pengguna, dan wiki biasanya menggunakan Markdown.
- Pangkalan pengetahuan dalaman: Banyak pasukan menggunakan wiki berasaskan Markdown.
Petua Anda boleh pratonton dan berlatih Markdown sekarang, secara percuma, dalam pelayar anda: Tulis dalam Markdown. Lihat output yang diformat anda dalam masa nyata semasa anda menaip.
Variasi Markdown
Satu perkara yang perlu diketahui: terdapat "variasi" Markdown yang berbeza. Sintaks teras adalah sama di mana-mana, tetapi beberapa platform menambah sambungan:
| Variasi | Ciri Tambahan | Digunakan Oleh |
|---|---|---|
| CommonMark | Spesifikasi ketat | Standard umum |
| GitHub Flavored Markdown (GFM) | Senarai tugas, jadual, strikethrough, auto-linking | GitHub |
| MultiMarkdown | Nota kaki, petikan, metadata | Penulisan akademik |
| R Markdown | Kod R tertanam, analisis data | Sains data |
Perbezaannya kebanyakannya dalam ciri lanjutan. Asas-asas (tajuk, tebal, condong, senarai, pautan, gambar, kod) berfungsi sama di mana-mana.
Kesilapan Biasa
Terlupa Baris Kosong
Markdown memerlukan baris kosong sebelum dan selepas banyak elemen. Tajuk memerlukan baris kosong sebelumnya. Senarai memerlukan baris kosong sebelum dan selepas. Melupakan baris kosong ini adalah punca masalah rendering yang paling biasa.
Penanda Senarai Tidak Konsisten
Mencampurkan -, *, dan + dalam senarai yang sama boleh menyebabkan rendering yang tidak dijangka. Pilih satu dan kekalkannya.
Ruang Selepas Simbol
Sesetengah pemproses Markdown memerlukan ruang selepas # dalam tajuk dan selepas - dalam senarai. Sentiasa sertakan ruang untuk keselamatan.
# Tajuk yang betul
#Tajuk yang salah
- Item senarai yang betul
-Item senarai yang salah
Amaran Markdown tidak menyokong semua keperluan pemformatan. Jika anda memerlukan susun atur yang kompleks, teks berwarna, tipografi yang tepat, atau dokumen sedia cetak, anda mungkin memerlukan HTML, LaTeX, atau pemproses kata. Markdown paling sesuai untuk kandungan berstruktur yang berfokuskan teks.
Mengapa Markdown Patut Dipelajari
Markdown mengambil masa lima minit untuk dipelajari dan menjimatkan berjam-jam dari masa ke masa. Setelah anda mengetahuinya, anda boleh:
- Menulis dokumentasi yang dipaparkan dengan cantik di GitHub
- Memformat mesej dalam Slack dan Discord tanpa menyentuh tetikus
- Mengambil nota berstruktur yang mudah alih merentasi aplikasi
- Mencipta siaran blog dan kandungan web dari fail teks biasa
- Bekerjasama pada dokumen berasaskan teks tanpa isu keserasian format
Nisbah pelaburan-kepada-hasil adalah antara yang terbaik dalam seluruh dunia teknologi.
Mula menulis dalam Markdown sekarang:
Percuma, dalam pelayar anda, dengan pratonton masa nyata semasa anda menaip.