Markdown Lint
Periksa Markdown untuk menemukan masalah gaya dan sintaks dengan markdownlint, linter yang digunakan banyak editor dan pipeline CI. Tempel dokumen untuk mendapatkan semua temuan beserta baris, aturan seperti MD001, dan penjelasannya. Anda juga dapat memperoleh versi yang telah diperbaiki, yang mengoreksi hal-hal yang bisa ditangani markdownlint, seperti baris kosong, penanda daftar, dan spasi.
Pertanyaan yang sering diajukan
Aturan mana yang diperiksa?
Semua aturan yang diaktifkan markdownlint secara default, mulai dari MD001 (tingkat judul naik satu per satu) hingga aturan untuk daftar, baris kosong, blok kode, tautan, dan penekanan. Aturan panjang baris MD013 nonaktif kecuali Anda menetapkan panjang baris maksimum.
Bagaimana cara menonaktifkan aturan?
Cantumkan aturan yang akan dinonaktifkan di kolom aturan, pisahkan dengan koma atau spasi, dan gunakan nomor seperti MD033 atau nama seperti no-inline-html. Komentar sebaris dalam dokumen, seperti <!-- markdownlint-disable MD033 -->, juga berfungsi.
Apa fungsi opsi perbaikan?
Opsi ini menerapkan perbaikan otomatis yang ditawarkan markdownlint, seperti menambahkan baris kosong di sekitar judul dan daftar, menyamakan penanda daftar, atau menghapus spasi di akhir baris, lalu menampilkan dokumen yang sudah dikoreksi. Temuan tanpa perbaikan otomatis tetap perlu Anda perbaiki secara manual.
Versi markdownlint mana yang digunakan?
markdownlint 0.42.0, pustaka yang menjadi dasar ekstensi markdownlint untuk Visual Studio Code dan markdownlint-cli2. Dengan versi dan konfigurasi default yang sama, semuanya melaporkan temuan yang sama.
Mengapa judul pertama saya dipermasalahkan?
Aturan MD041 mengharuskan dokumen dimulai dengan judul tingkat teratas, sedangkan MD025 hanya mengizinkan satu judul. Jika platform Anda menambahkan judul itu sendiri, nonaktifkan aturan tersebut untuk dokumen Anda.
Berapa banyak temuan yang ditampilkan?
Jumlah total selalu dilaporkan, dan 500 temuan pertama dicantumkan dalam tabel. Perbaiki temuan awal, lalu jalankan pemeriksaan lagi untuk melihat sisanya.