Cách sử dụng
- Nhập Markdown trong trình chỉnh sửa hoặc nhấn “Thử ví dụ” để tải tài liệu có bảng và danh sách công việc.
- Xem bản xem trước cập nhật khi bạn nhập. Chuyển sang “Mã nguồn HTML” để xem mã được tạo.
- Bật hoặc tắt GitHub Flavored Markdown hay tùy chọn ngắt dòng đơn để phù hợp với nơi bạn sẽ đăng văn bản.
- Sao chép HTML vào CMS hoặc email, hoặc tải kết quả xuống dưới dạng tệp .html hoặc .md.
Cách hoạt động
Markdown được chuyển đổi bằng marked, một trình phân tích cú pháp mã nguồn mở được sử dụng rộng rãi, tuân theo đặc tả CommonMark và, khi bật tùy chọn GFM, hỗ trợ GitHub Flavored Markdown: bảng dùng dấu gạch đứng với căn chỉnh cột, danh sách công việc, ~~gạch ngang~~ và tự động tạo liên kết từ URL thuần. Chú thích cuối trang, công thức toán học và sơ đồ Mermaid không thuộc các đặc tả này nên sẽ hiển thị dưới dạng văn bản thuần.
Markdown có thể chứa HTML thô và HTML đó được giữ nguyên, như cách hoạt động của hầu hết trình kết xuất Markdown. Để bảo vệ bạn, bản xem trước không bao giờ được chèn trực tiếp vào trang này. Nội dung được hiển thị trong một khung cô lập, không được phép chạy tập lệnh, gửi biểu mẫu, mở cửa sổ bật lên hoặc truy cập trang web này; chính sách bảo mật nội dung của khung cũng chặn tập lệnh, biểu định kiểu bên ngoài, phông chữ và khung. Thẻ <script> hoặc thuộc tính onclick trong Markdown sẽ xuất hiện trong mã nguồn HTML nhưng không bao giờ được thực thi. Các liên kết trong bản xem trước chỉ hiển thị, không mở được; hãy sao chép URL nếu bạn muốn truy cập.
Bản xem trước dùng biểu định kiểu trung tính, tương tự các trình kết xuất README phổ biến; trang web của bạn hoặc GitHub có thể định dạng cùng HTML theo cách khác. HTML được sao chép là một đoạn mã thuần, không có kiểu; tệp .html tải xuống có thêm biểu định kiểu cơ bản để hiển thị giống bản xem trước. HTML được tải xuống hoặc sao chép không được làm sạch, vì vậy nếu có tập lệnh, chúng sẽ chạy ở nơi bạn dán hoặc mở HTML đó.
Ví dụ
Kiểm tra README trước khi đẩy lên kho mã
Dán README.md vào để kiểm tra các cột trong bảng có thẳng hàng, danh sách công việc hiển thị thành ô đánh dấu và các khối mã được đặt đúng trong hàng rào mã trước khi đưa tệp lên GitHub.
Soạn nội dung cho CMS hỗ trợ HTML
Soạn bài viết blog bằng Markdown, sau đó nhấn “Sao chép HTML” và dán mã <h2>, <p> và <ul> vào trình chỉnh sửa HTML của CMS.
Ngắt dòng kiểu trò chuyện
Văn bản từ ứng dụng trò chuyện có các dòng được ngăn cách bằng một lần xuống dòng. Bật “Xem mỗi lần xuống dòng là <br>” để giữ nguyên các dòng riêng biệt thay vì gộp chúng thành một đoạn văn.
Câu hỏi thường gặp
Dán Markdown từ nguồn không rõ có an toàn không?
Có, nếu chỉ để xem trước. HTML đã kết xuất được hiển thị trong một khung cô lập, nơi tập lệnh bị vô hiệu hóa, nên thẻ <script> hoặc trình xử lý sự kiện trong văn bản cũng không làm gì được. Hãy cẩn thận khi dán HTML đã xuất, vì nội dung này chưa được làm sạch.
Tại sao hình ảnh không hiển thị?
Theo mặc định, hình ảnh từ các trang web khác bị chặn để bản xem trước không gửi yêu cầu mạng. Bật “Tải hình ảnh từ trang web khác” để hiển thị chúng. Các đường dẫn tương đối như ./docs/screenshot.png không hoạt động vì tệp không có ở đây.
Công cụ có hỗ trợ chú thích, công thức toán học hoặc sơ đồ không?
Không. Công cụ hỗ trợ CommonMark và GitHub Flavored Markdown (bảng, danh sách công việc, gạch ngang, tự động tạo liên kết). Chú thích cuối trang, công thức LaTeX và sơ đồ Mermaid là các phần mở rộng nên bản xem trước hiển thị chúng dưới dạng văn bản thuần.
Tại sao xuống dòng một lần không bắt đầu dòng mới?
Trong Markdown tiêu chuẩn, một lần xuống dòng trong đoạn văn được xem như dấu cách. Thêm hai dấu cách ở cuối dòng, chèn một dòng trống hoặc bật “Xem mỗi lần xuống dòng là <br>”.
Quyền riêng tư
Markdown được chuyển đổi ngay trên trình duyệt, không được tải lên hoặc lưu trữ. Bản xem trước không tải nội dung nào từ Internet trừ khi bạn cho phép tải hình ảnh từ trang web khác; khi đó, hình ảnh được yêu cầu trực tiếp từ máy chủ lưu trữ.