Trình định dạng Markdown

Những gì trình định dạng sửa

• Ký hiệu danh sách. *, -, + đều được chuẩn hóa thành một ký tự nhất quán (mặc định -).
• Hệ thống cấp tiêu đề. Cảnh báo (hoặc nâng cấp) khi H2 được theo sau bởi H4 mà không có H3 ở giữa.
• Dòng trống. Chính xác một dòng trống giữa các khối; không có chuỗi ba dòng trở lên.
• Bảng. Đệm mỗi cột để các dấu gạch đứng (|) căn chỉnh trong nguồn, dù trình kết xuất Markdown không bận tâm.
• Khoảng trắng cuối dòng. Loại bỏ khoảng trắng cuối mỗi dòng, ngoại trừ ký hiệu ngắt dòng hai khoảng trắng cố ý.
• Liên kết tham chiếu. Thu thập các định nghĩa [label]: url ở cuối tài liệu, sắp xếp theo bảng chữ cái.
• Hàng rào mã. Thẻ ngôn ngữ được chuẩn hóa thành chữ thường; các khối mã dựa trên thụt lề trở thành khối có hàng rào.

Tùy chọn phong cách bạn có thể đặt

Vì sao Markdown nhất quán lại quan trọng

Trong kho lưu trữ nhóm, Markdown không nhất quán tạo ra các bản diff nhiễu: mỗi khi ai đó lưu tệp bằng một trình soạn thảo khác, ký hiệu danh sách hoán đổi và bảng được sắp xếp lại. Trình định dạng áp đặt một phong cách duy nhất để người đánh giá pull request chỉ thấy những thay đổi về nội dung. Hãy xem nó như prettier cho văn xuôi.

Khi nào không nên định dạng

• Khối mã có hàng rào vẫn nguyên vẹn từng byte, trình định dạng không bao giờ chạm vào nội dung của khối mã. Nếu việc định dạng làm thay đổi mã, đó là một lỗi.
• Ngắt dòng cứng cố ý ở độ rộng hẹp (readme.md trong dự án terminal) sẽ được ngắt lại nếu bạn bật cột ngắt dòng. Tắt ngắt dòng nếu bạn giữ các ngắt dòng đã tinh chỉnh thủ công.
• Khối HTML nhúng được truyền qua nguyên vẹn.

Giải pháp thay thế trực tiếp

Nếu bạn thích CLI cục bộ, trình định dạng dùng cùng bộ quy tắc AST như remark-stringify với plugin remark-gfm. prettier --parser markdown cho kết quả tương tự.