Markdown Preview
Live Markdown preview
Live Markdown preview Chạy cục bộ trong trình duyệt của bạn
About the
Bản xem trước Markdown hiển thị Markdown của bạn khi bạn nhập, ở chế độ xem cạnh nhau, theo sau CommonMark với các tiện ích mở rộng GitHub mà hầu hết mọi người thực sự sử dụng: bảng, danh sách tác vụ, khối mã có rào chắn, gạch ngang và liên kết tự động. Đây là cách nhanh nhất để kiểm tra README trước khi thực hiện nó, bởi vì sự khác biệt giữa giao diện Markdown trong nguồn và giao diện được hiển thị là không rõ ràng và cú pháp bảng nói riêng không thành công trong âm thầm khi một dấu gạch ngang hoặc dấu gạch ngang sai. HTML được hiển thị cũng có thể được sao chép ra nếu bạn cần nó ở nơi nào đó không tự xử lý Markdown.
Where people use the
- Kiểm tra README hiển thị chính xác trước khi đẩy nó.
- Soạn thảo ghi chú phát hành hoặc nhật ký thay đổi với chế độ xem trực tiếp kết quả.
- Chuyển đổi tài liệu Markdown sang HTML cho CMS không chấp nhận Markdown.
- Xem lại yêu cầu kéo Markdown của người khác và xem nó sẽ trông như thế nào.
How to use the
- 1
Paste or write your Markdown
Trình chỉnh sửa chấp nhận mọi thứ từ một đoạn văn đến một tài liệu đầy đủ với các tiêu đề, danh sách, liên kết và hàng rào mã.
- 2
Xem bảng kết xuất
Bản xem trước cập nhật sau mỗi lần nhấn phím, do đó, bảng bị hỏng hoặc hàng rào không được đóng sẽ hiển thị ngay lập tức thay vì sau bước xuất bản.
- 3
Fix the source, not the preview
The preview is read-only. Khi có nội dung nào đó hiển thị sai, nguyên nhân hầu như luôn là thiếu dòng trống trước danh sách hoặc tiêu đề bảng không có hàng phân cách.
- 4
Copy the HTML if you need it
Chuyển sang chế độ xem HTML để lấy đánh dấu đã tạo, điều này rất hữu ích cho việc dán vào CMS yêu cầu HTML thay vì Markdown.
Lời khuyên và phương pháp hay nhất
- Để lại một dòng trống trước và sau mỗi phần tử khối; hầu hết các lỗi kết xuất khó hiểu đều bị thiếu một dòng trống.
- Sử dụng các khối mã có rào chắn với tên ngôn ngữ để mã được đánh dấu thay vì được coi là văn bản thuần túy.
- Giữ một câu trên mỗi dòng trong tài liệu dài; nó làm cho các khác biệt có thể đọc được sau này.
Câu hỏi thường gặp
Which Markdown specification is used?
CommonMark làm cơ sở, cùng với các phần mở rộng GitHub Flavored Markdown cho bảng, danh sách nhiệm vụ, mã có rào chắn và gạch ngang. Sự kết hợp đó bao gồm định dạng README trên GitHub, GitLab và hầu hết các trang tài liệu.
Why is my table not rendering?
Một bảng cần có hàng tiêu đề, ngay sau đó là hàng dấu phân cách, với một dòng trống trước khối. Mỗi hàng phải có cùng số lượng ống như tiêu đề. Bất kỳ một trong những thứ còn thiếu sẽ biến toàn bộ nội dung thành một đoạn văn bản có các ký tự ống trong đó.
Tại sao các mục trong danh sách của tôi lại hợp nhất thành một đoạn văn?
Markdown cần một dòng trống giữa đoạn văn và danh sách theo sau nó. Không có nó, các điểm đánh dấu danh sách được coi là văn bản thông thường.
Nó có hỗ trợ LaTeX hoặc toán học không?
Không. Kết xuất toán học cần một thư viện riêng như KaTeX hoặc MathJax và một cú pháp khác. Biểu thức ký hiệu đô la ở đây sẽ hiển thị dưới dạng văn bản thuần túy.
HTML thô có được phép không?
Có, HTML nội tuyến sẽ được chuyển thẳng qua, đó cũng là điều mà GitHub thực hiện. Nếu bạn xuất bản kết quả đầu ra ở bất kỳ nơi nào công khai, hãy làm sạch nó trước tiên vì HTML thô cũng là cách các tập lệnh được đưa vào.
Văn bản của tôi đi đâu?
Hư không. Quá trình phân tích cú pháp và hiển thị diễn ra trong trình duyệt của bạn bằng thư viện JavaScript Markdown. Không có gì được lưu hoặc truyền đi nên bản nháp sẽ biến mất khi bạn đóng tab trừ khi bạn sao chép nó ra.