Markdown sang HTML

Cách sử dụng

1. Dán Markdown — một README, một ghi chú, một changelog.
2. Chuyển sang Xem trước để thấy kết quả, hoặc giữ ở HTML để đọc mã.
3. Bật bọc tài liệu đầy đủ nếu kết quả sẽ thành một tệp độc lập.
4. Sao chép hoặc tải kết quả về.

Tính năng

• Hỗ trợ tiêu đề, in đậm nghiêng, danh sách, trích dẫn, khối mã, đường kẻ, liên kết, ảnh và bảng.
• Escape HTML thô, nên tài liệu dán vào không thể chèn mã vào nơi kết quả được dùng.
• Bỏ liên kết và ảnh dùng javascript:, vẫn giữ lại phần chữ hiển thị.
• Gắn class ngôn ngữ cho khối mã, sẵn sàng cho bộ tô màu cú pháp.
• Chạy hoàn toàn trong trình duyệt.

Câu hỏi thường gặp

Vì sao HTML tôi viết trong Markdown không chạy?

Vì nó bị escape có chủ ý. Markdown cho phép HTML thô, và tôn trọng điều đó sẽ biến mọi công cụ chuyển đổi thành đường chèn mã: kết quả thường được render ở đâu đó — một CMS, một email, một trang web — và những gì trong README của người lạ sẽ chạy ở đó. Đánh đổi ở đây là một tính năng hiếm dùng lấy việc loại bỏ cả một lớp vấn đề, và trang này nói rõ chứ không để bạn bất ngờ.

Đây có phải CommonMark không?

Không, và cũng không nhận là vậy. Công cụ xử lý những thành phần người ta thực sự viết — tiêu đề, in đậm nghiêng, mã, danh sách, trích dẫn, liên kết, ảnh, đường kẻ, bảng — chứ không xử lý phần đuôi dài các trường hợp tham chiếu lồng nhau trong đặc tả. Với một hệ thống tài liệu hãy dùng thư viện đầy đủ; còn để chuyển một văn bản bạn đang đọc thì đây là đủ.

Liên kết javascript: thì sao?

Phần chữ được giữ lại và phần liên kết bị bỏ, nên ý nghĩa còn nguyên mà rủi ro thì không. Chỉ http, https, mailto và đường dẫn tương đối mới trở thành thẻ liên kết. Chỉ escape phần chữ là chưa đủ: thuộc tính href là một lối vào riêng biệt thứ hai.

Công cụ liên quan