Markdown Cheat Sheet: file .md là gì, viết README và viết cho AI agent đọc
Bài viết là một Markdown Cheat Sheet đầy đủ, gồm hai nửa. Nửa đầu là bảng tra cú pháp: file .md là gì, mở và tạo bằng cách nào, rồi heading, danh sách, liên kết, ảnh, khối mã, bảng, task list, alert box của GitHub, sơ đồ Mermaid và YAML frontmatter, mỗi loại kèm ví dụ chạy được. Nửa sau trả lời câu hỏi vì sao Markdown trở thành định dạng chung của mọi công cụ AI: nó tốn khoảng một nửa số ký tự so với HTML cho cùng nội dung, nó nằm sẵn trong dữ liệu huấn luyện, và model cũng xuất ra chính nó. Kèm danh sách các file mà trợ lý AI tự đọc trong repo — README.md, CLAUDE.md, AGENTS.md, copilot-instructions.md, Cursor rules, SKILL.md — cùng các quy tắc viết để agent hiểu đúng thay vì đoán.
Bạn có thể tạo một file README trên Github với Markdown. Nhưng markdown là gì và cách tạo một file README trên Github với Markdown như thế nào? Hãy cùng tìm hiểu ở bài viết này nhé!
Markdown là gì?
Markdown là một ngôn ngữ mã nguồn mở, được sử dụng để viết các file README, với cú pháp dễ hiểu và dễ đọc. Có thể được đọc trên nhiều nền tảng khác nhau, bao gồm những nền tảng web, trên máy tính, và trên các thiết bị di động.
Các định dạng file markdown phổ biến: .markdown, .md, .mkd, .mkdown, .text, .mdown...
Markdown là một trong số những markup language được sử dụng phổ biến nhất. Bên cạnh Markdown, bạn có thể sử dụng các markup language khác như HTML, XML...
Đặc biệt, bạn hoàn toàn có thể sử dụng cú pháp của các thẻ HTML trong file file markdown.
File .md là gì và mở bằng gì
.md là phần mở rộng của file Markdown — một file văn bản thuần (plain text), không phải định dạng nhị phân như .docx hay .pdf. Mở nó bằng Notepad vẫn đọc được toàn bộ nội dung, chỉ là không thấy phần định dạng được render ra.
Vì là văn bản thuần nên:
- Mở được bằng bất kỳ trình soạn thảo nào — Notepad, TextEdit, Vim, VS Code.
- Git so sánh được từng dòng, nên review thay đổi trong pull request rất dễ. Đây là lý do tài liệu kỹ thuật thường viết bằng Markdown thay vì Word.
- Không phụ thuộc phần mềm nào cả. File
.docxmà thiếu Word thì chật vật, còn.mdthì mười năm sau vẫn đọc được.
Muốn xem bản đã render thì dùng công cụ có chế độ xem trước:
| Công cụ | Cách xem trước |
|---|---|
| VS Code | Ctrl + Shift + V, hoặc biểu tượng chia đôi màn hình |
| GitHub / GitLab | Tự render khi mở file .md trong repo |
| Typora, Obsidian | Render trực tiếp ngay lúc gõ |
| Trình duyệt | Cần tiện ích mở rộng như Markdown Viewer |
Các phần mở rộng khác cũng là Markdown: .markdown, .mkd, .mdown, .mkdown. Dùng phổ biến nhất vẫn là .md.
Cách tạo file .md
Không cần phần mềm chuyên dụng. Chọn cách nào tiện nhất:
Cách 1 — VS Code (khuyên dùng)
File→New File.Ctrl+Sđể lưu, đặt tên kèm đuôi.md, ví dụREADME.md.- Gõ nội dung, rồi
Ctrl+Shift+Vđể xem bản render.
Cách 2 — Ngay trên GitHub, không cần cài gì
- Vào repo →
Add file→Create new file. - Đặt tên
README.md. - Gõ nội dung, dùng tab
Previewđể xem trước, rồiCommit changes.
Cách 3 — Dòng lệnh
# Linux / macOS
touch README.md
# Windows PowerShell
New-Item README.md
Cách 4 — Notepad trên Windows
Mở Notepad, gõ nội dung, rồi Save As. Nhớ hai điều: chọn All Files ở mục Save as type (không thì Windows tự thêm .txt thành README.md.txt), và chọn encoding UTF-8 để tiếng Việt không bị lỗi font.
Lưu ý về tên file: README.md viết hoa là quy ước, và GitHub nhận cả readme.md lẫn Readme.md. Nhưng trên Linux tên file phân biệt hoa thường, nên cứ viết hoa toàn bộ cho thống nhất.
Cú pháp Markdown
Định dạng text
Markdown hỗ trợ các kiểu định dạng text như sau:
- *In nghiêng*
- _In nghiêng_
- **In đậm**
- __In đậm__
- ***In đậm và nghiêng***
- ___In đậm và nghiêng___
- ~~Gạch ngang~~
- *~~In nghiêng và gạch ngang~~*
- **~~In đậm và gạch ngang~~**
- Kiểu<sub>subscript</sub>: H<sub>2</sub>O
- Kiểu<sup>superscript</sup>: E = mc<sup>2</sup>
Kết quả:
- In nghiêng
- In nghiêng
- In đậm
- In đậm
- In đậm và nghiêng
- In đậm và nghiêng
Gạch ngangIn nghiêng và gạch ngangIn đậm và gạch ngang- Kiểusubscript: H2O
- Kiểusuperscript: E = mc2
Thanh kẻ ngang
Để tạo thanh kẻ ngang, hãy sử dụng cú pháp sau (dùng tối thiểu 4 dấu -):
----
Kết quả:
Header
Có tất cả 6 header trong Markdown, bạn có thể sử dụng 1-6 # để tạo header.
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
Kết quả:
Trong đó, Header 1 là header lớn nhất, Header 6 là header nhỏ nhất. Thông thường, Header 1 sẽ được sử dụng để tạo tiêu đề, các Header khác sẽ được sử dụng để tạo các section trong file README.
Danh sách
Có 2 loại danh sách trong Markdown, danh sách đánh thứ tự và danh sách không đánh thứ tự.