Softonic

Pemformat Markdown

Langkah 1 / 2
Berikutnya

Tempel dokumen Markdown; pemformat akan menulis ulangnya dengan gaya yang konsisten: memperbaiki lompatan tingkat judul (tidak ada H2 setelah H4), mengisi kolom tabel agar sejajar di sumber, mewajibkan satu baris kosong antar-blok, menormalkan penanda daftar menjadi -, memampatkan rentetan baris kosong, serta mengurutkan definisi tautan bergaya referensi di bagian bawah. HTML yang dirender tidak berubah, hanya file sumber yang menjadi lebih rapi, sehingga diff menjadi mudah dibaca.

Bagaimana pemformat menulis ulang Markdown

  1. 1

    Tempel Markdown

    Jatuhkan dokumen mentah, README, halaman dokumentasi, catatan rapat.

  2. 2

    Pilih opsi gaya

    Penanda daftar (`-`/`*`), gaya judul (ATX/Setext), perataan tabel, kolom pembungkus.

  3. 3

    Format

    Alat mem-parsing dokumen menjadi AST lalu menserialisasikannya ulang dengan gaya yang dipilih.

  4. 4

    Bandingkan keluaran

    Tampilan berdampingan menunjukkan apa yang berubah sebelum Anda menempelkannya kembali.

Apa yang diperbaiki pemformat

  • Penanda daftar. *, -, + semuanya dinormalkan menjadi satu karakter yang konsisten (bawaan -).
  • Hierarki judul. Memperingatkan (atau menaikkan level) ketika H2 diikuti H4 tanpa H3 di antaranya.
  • Baris kosong. Tepat satu baris kosong antar-blok; tidak ada rentetan tiga baris atau lebih.
  • Tabel. Mengisi setiap kolom agar pipa (|) sejajar di sumber, meskipun perender Markdown tidak mempermasalahkannya.
  • Spasi di akhir baris. Menghapus spasi di akhir setiap baris kecuali penanda pemutus baris dua spasi yang disengaja.
  • Tautan referensi. Mengumpulkan definisi [label]: url di akhir dokumen, diurutkan secara alfabetis.
  • Pagar kode. Tag bahasa dinormalkan ke huruf kecil; blok kode berbasis indentasi menjadi blok berpagar.

Opsi gaya yang dapat Anda atur

Opsi Bawaan Alternatif
Penanda daftar - *, +
Gaya judul ATX Setext untuk H1/H2
Pembatas penekanan * _
Pembatas tebal ** __
Kolom pembungkus 0 (nonaktif) 80, 100, 120
Urutkan tautan referensi aktif nonaktif

Mengapa Markdown yang konsisten penting

Di repositori tim, Markdown yang tidak konsisten menghasilkan diff yang berisik: setiap kali seseorang menyimpan file dengan editor berbeda, penanda daftar bertukar dan tabel tersusun ulang. Pemformat menerapkan satu gaya sehingga peninjau pull request hanya melihat perubahan konten. Anggap saja seperti prettier untuk prosa.

Kapan sebaiknya tidak memformat

  • Blok kode berpagar tetap utuh bita demi bita, pemformat tidak akan pernah menyentuh isi blok kode. Jika pemformatan mengubah kode, itu adalah bug.
  • Pemutus baris keras yang disengaja pada lebar sempit (readme.md pada proyek terminal) akan dibungkus ulang jika Anda mengaktifkan kolom pembungkus. Nonaktifkan pembungkusan jika Anda mempertahankan pemutus baris yang disetel manual.
  • Blok HTML tersemat diteruskan tanpa perubahan.

Pengganti langsung pakai

Jika Anda lebih menyukai CLI lokal, pemformat menggunakan aturan AST yang sama dengan remark-stringify beserta plugin remark-gfm. prettier --parser markdown menghasilkan hasil serupa.

Pertanyaan yang Sering Diajukan

Tidak. Pemformat hanya menulis ulang sumbernya, keluaran HTML yang dirender sebelum dan sesudah seharusnya setara. Jika Anda melihat perubahan pada render, laporkan sebagai bug.

Tidak. Front-matter YAML atau TOML di bagian atas file dideteksi dan diteruskan tanpa diubah.

Ya, atur kolom pembungkus ke 80, 100, atau 120 dan paragraf akan dibungkus ulang. Baris di dalam pagar kode tidak pernah disentuh.

Tidak. Pemformat mengasumsikan tautan Anda berfungsi; ia hanya menata ulang definisi tautan referensi. Gunakan alat pemeriksa tautan secara terpisah.

Tidak. Parsing dan pemformatan berjalan di browser Anda; konten tidak pernah meninggalkan perangkat Anda.

Alat Terkait

Referensi Tabel ASCII

Tabel ASCII lengkap dari 0 sampai 127 dengan desimal, heksadesimal, oktal, biner, dan referensi karakter numerik HTML untuk setiap karakter, termasuk kode kontrol seperti NUL, LF, dan DEL.

Referensi Karakter HTML

Daftar entitas HTML yang dapat dicari, beserta kode bernama dan kode numeriknya, serta fitur salin dengan satu klik untuk karakter khusus dan simbol.

Referensi pintasan papan ketik

Cari pintasan bawaan terdokumentasi untuk VS Code, Chrome, dan Bash dengan GNU Readline di macOS, Windows, dan Linux.

Pemformat HTML

Format HTML secara lokal di browser dengan inden dua atau empat spasi. HTML tidak diunggah atau divalidasi.

Generator EditorConfig

Buat file .editorconfig dengan gaya dan ukuran indentasi, akhir baris, charset, dan aturan spasi Anda untuk format yang konsisten di berbagai IDE dan editor.

Validator Email

Validasi alamat email: pemeriksaan sintaks RFC 5322, pengecekan live record MX, serta detail bagian lokal, domain, dan panjang. Tidak ada email yang dikirim.

Alat ini tersedia dalam bahasa lain