Back

Pratinjau Markdown

Markdown adalah bahasa markup ringan untuk membuat teks terformat menggunakan sintaks teks biasa. Populer untuk dokumentasi, file README, dan pencatatan, dirender ke HTML untuk ditampilkan. Alat ini mempratinjau Markdown dengan rendering langsung, mengekstrak struktur dokumen (judul, tautan, gambar), dan dapat mengonversi ke HTML.

Spesifikasi

Kasus Penggunaan Umum

  • Mempratinjau file README.md sebelum commit
  • Meninjau formatting dokumentasi
  • Mengekstrak semua tautan dari dokumen untuk validasi
  • Mengonversi Markdown ke HTML untuk penyematan
  • Menganalisis struktur dan navigasi dokumen

Fitur

  • Pratinjau langsung dengan rendering HTML
  • Mengekstrak struktur dokumen (judul sebagai daftar isi)
  • Mencantumkan semua tautan dan gambar dalam dokumen
  • Mendeteksi dan menampilkan blok kode dengan petunjuk bahasa
  • Mengurai frontmatter (metadata YAML)
  • Mengonversi ke output HTML yang bersih
  • Statistik jumlah kata dan karakter

Contoh

README dengan Fitur

Coba →

README proyek tipikal dengan judul, daftar, dan kode.

# My Project

A brief description of what this project does.

## Installation

```bash
npm install my-project
```

## Features

- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework

## Links

- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)

Tips

  • Gunakan # untuk judul (# H1, ## H2, ### H3, dll.).
  • Blok kode menggunakan triple backtick dengan identifier bahasa opsional.
  • Tautan menggunakan sintaks [teks](url); gambar menggunakan ![alt](url).
  • Frontmatter di antara baris --- dapat berisi metadata YAML.

Pemahaman Pratinjau Markdown

Markdown adalah bahasa markup ringan yang dibuat oleh John Gruber pada tahun 2004, dirancang agar dapat dibaca sebagai teks biasa sambil mengonversi dengan bersih ke HTML. Sintaksnya menggunakan karakter tanda baca yang secara visual menyarankan formatting-nya: # untuk judul, * untuk penekanan, - untuk daftar, dan backtick untuk kode. File Markdown tetap berguna bahkan tanpa rendering, itulah mengapa format ini mendominasi untuk dokumentasi, file README, dan penulisan teknis.

Spesifikasi CommonMark (2014) mengatasi banyak ambiguitas Markdown asli. CommonMark mendefinisikan secara tepat bagaimana kasus tepi ditangani, dan sebagian besar parser modern mengimplementasikannya. GitHub Flavored Markdown (GFM) memperluas CommonMark dengan tabel, daftar tugas, coret, URL yang di-autolink, dan blok kode berpagar dengan penyorotan sintaks.

GFM adalah standar de facto untuk file README, deskripsi pull request, komentar issue, dan situs dokumentasi. Sebagian besar platform dokumentasi (Notion, Docusaurus, MkDocs, GitBook) mendukung GFM atau superset darinya.

Frontmatter adalah konvensi umum untuk menambahkan metadata terstruktur ke file Markdown. Blok YAML yang dibatasi oleh baris --- di bagian atas file dapat berisi judul, tanggal, penulis, dan tag yang digunakan oleh generator situs statis (Astro, Hugo, Jekyll, Next.js) untuk membangun navigasi dan layout halaman.

Dalam praktik, "Markdown" hampir selalu mengacu pada CommonMark atau GFM. Spesifikasi Markdown asli membiarkan banyak kasus tepi tidak terdefinisi, dan CommonMark menyelesaikan ambiguitas tersebut dengan spesifikasi yang ketat. GFM memperluas CommonMark dengan tabel, daftar tugas, coret, dan URL yang di-autolink. Saat mengevaluasi parser atau renderer Markdown, memeriksa kepatuhan CommonMark-nya adalah indikator yang andal tentang seberapa baik ia menangani kasus tepi.

Tabel dalam GFM menggunakan pipe (|) untuk memisahkan kolom dan tanda hubung (-) untuk baris pembagi header. Perataan kolom dikontrol dengan titik dua di pembagi: :--- untuk rata kiri, :---: untuk tengah, dan ---: untuk rata kanan. Tabel adalah ekstensi GFM dan bukan bagian dari sintaks Markdown asli. Frontmatter, yang dibatasi oleh baris --- di bagian paling awal file, adalah blok metadata YAML yang digunakan oleh generator situs statis untuk metadata halaman seperti judul, tanggal, layout, dan tag. GitHub merender frontmatter sebagai tabel di bagian atas file, meskipun tidak semua renderer memprosesnya.

Blok kode berpagar menggunakan triple backtick dengan identifier bahasa opsional setelah backtick pembuka — misalnya, baris dengan tiga backtick diikuti oleh "javascript" memulai blok JavaScript dengan penyorotan sintaks. Identifier bahasa yang tersedia tergantung pada platform rendering. Mengindentasi kode dengan empat spasi juga membuat blok kode, tetapi tanpa kemampuan untuk menentukan bahasa untuk penyorotan.

← Kembali ke semua alat