Xem và preview README.md

Kiểm tra README trước khi push. Mở tệp, dán văn bản, hoặc thả liên kết GitHub vào và thấy huy hiệu, bảng, khối mã, danh sách công việc, cảnh báo và sơ đồ Mermaid hiển thị đúng như GitHub.

Xem trước một README

Miễn phí · không cần đăng ký · chạy trong trình duyệt, không tải lên gì cả

README của markdown-it mở từ URL GitHub, hiển thị với huy hiệu, cảnh báo và mã trong GitHub Dark — Một README thật mở thẳng từ liên kết GitHub: huy hiệu, cảnh báo, bảng và mã hiển thị như trên GitHub.

Mở README từ GitHub hoặc từ ổ đĩa

Dán một URL GitHub như https://github.com/user/repo/blob/main/README.md vào Mở → Từ URL — trình xem chuyển nó thành liên kết tệp raw giúp bạn và hiển thị. Liên kết Gist cũng hoạt động tương tự. Với dự án trên máy bạn, thả README.md vào trang hoặc dán nội dung vào trình soạn thảo.

Mọi thứ GitHub hiển thị, hiển thị cùng một cách

GitHub-Flavored Markdown là một phương ngữ cụ thể, và README dựa nhiều vào các phần mở rộng của nó: bảng gạch đứng, danh sách công việc - [ ], ~~gạch ngang~~, URL tự liên kết, cảnh báo > [!NOTE] / [!WARNING], phần <details> cho hướng dẫn cài đặt dài, huy hiệu shields.io, neo tiêu đề tương đối và khối mã có nhãn ngôn ngữ. Tất cả đều hiển thị ở đây, với cùng id tiêu đề mà GitHub tạo ra nên các liên kết trong trang vẫn hoạt động. Sơ đồ Mermaid — GitHub cũng vẽ — cũng hiển thị.

Sửa trước khi commit

Chuyển sang bố cục Chia đôi và sửa README với xem trước trực tiếp: thanh công cụ chèn bảng và danh sách công việc, phím tắt lo in đậm, liên kết và tiêu đề, và dàn ý cho thấy cấu trúc các phần có dễ đọc không. Tải xuống .md khi thấy ổn, hoặc sao chép HTML đã hiển thị cho trang web của dự án. README không phải file Markdown duy nhất trong một kho mã: các file hướng dẫn như CLAUDE.md và AGENTS.md cũng mở theo cách y hệt — xem trình xem CLAUDE.md.

Xem thực tế

Các khung cảnh báo Note, Important, Warning và Caution kiểu GitHub, một trích dẫn và một phần details có thể thu gọn trong giao diện GitHub Dark — Cảnh báo kiểu GitHub, trích dẫn và các phần <details> thu gọn được, trong GitHub Dark.

Các khối mã TypeScript, Python, Bash và diff được tô sáng cú pháp, có nhãn ngôn ngữ và nút sao chép — Khối mã có nhãn ngôn ngữ, tô sáng cú pháp cho hơn 50 ngôn ngữ và nút sao chép — đây là giao diện One Dark.

Công thức KaTeX dạng khối và lưu đồ Mermaid được hiển thị ngay trong bản xem trước — Công thức KaTeX và lưu đồ Mermaid hiển thị ngay trong tài liệu.

Cách hoạt động

1
Dán liên kết README GitHub vào Mở → Từ URL, hoặc thả tệp vào trang.
2
Đọc bản hiển thị với huy hiệu, bảng, mã và sơ đồ đúng chỗ.
3
Sửa ở chế độ Chia đôi, rồi tải xuống README.md đã cập nhật.

Bạn nhận được gì

Liên kết GitHub, tự chuyển đổi

URL blob và Gist tự động thành tệp raw.

GFM đầy đủ

Bảng, danh sách công việc, cảnh báo, chú thích, details, huy hiệu, liên kết tự động, emoji.

Sơ đồ Mermaid

Sơ đồ kiến trúc và luồng hiển thị tại chỗ.

Giao diện tối và sáng

Xem README đọc thế nào ở GitHub Dark lẫn Light.

Sửa với xem trước

Sửa lỗi định dạng và tải xuống tệp đã chỉnh.

Riêng tư

Tệp cục bộ không bao giờ rời trình duyệt; nội dung tải từ URL không được lưu.

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

Nó có trông y hệt GitHub không?

Quy tắc Markdown và id tiêu đề khớp GitHub-Flavored Markdown, và giao diện GitHub Light / Dark dùng màu của GitHub. Có thể có khác biệt nhỏ về khoảng cách, nhưng cấu trúc, bảng, mã và cảnh báo hiển thị như nhau.

Tôi có thể xem trước README của kho riêng tư không?

Không qua URL, vì máy chủ không thể xác thực với GitHub. Thay vào đó hãy tải tệp xuống và thả vào trang — nó ở lại trên thiết bị của bạn.

Liên kết hình ảnh tương đối có hoạt động không?

Hình ảnh có URL tuyệt đối hiển thị được. Đường dẫn tương đối như docs/logo.png không thể phân giải với tệp cục bộ; khi mở từ URL GitHub, hãy dùng đường dẫn raw.githubusercontent.com.

Huy hiệu có hiển thị không?

Có. Huy hiệu là hình ảnh bình thường với URL tuyệt đối và hiển thị bình thường.

Tôi có thể hiển thị README từ trang khác, không phải GitHub không?

Có, bất kỳ URL công khai nào trả về tệp Markdown đều được. Trang HTML bị từ chối để bạn biết cần dùng liên kết raw.

Công cụ liên quan

Sẵn sàng khi bạn cần

Dán Markdown, thả tệp vào hoặc mở một URL — bản xem trước hiện ra ngay lập tức và mọi thứ ở lại trên thiết bị của bạn.

Mở Markdown Viewer