Bảng tra cứu nhanh Markdown

Bước 1 / 3 33%

Chọn một chủ đề Markdown

Bắt đầu với một nhóm ví dụ, sau đó mở toàn bộ bảng tra cứu.

Cú pháp Markdown thiết yếu được nhóm theo chủ đề, hiển thị mã nguồn sẵn để sao chép bên cạnh kết quả của trình phân tích thực tế. Nội dung gồm các phần cốt lõi của CommonMark (tiêu đề, danh sách, nhấn mạnh, liên kết, hình ảnh và khối mã có rào) cùng các phần mở rộng GitHub Flavored Markdown (bảng, danh sách công việc, gạch ngang và tự động tạo liên kết cho URL thuần). Hãy giữ trang này bên cạnh khi làm việc với GitHub, GitLab, Obsidian và trình tạo trang tĩnh.

Cách dùng bảng tra cứu

  1. 1

    Duyệt theo danh mục

    Chuyển đến tiêu đề, danh sách, mã, liên kết, bảng hoặc các phần mở rộng GFM.

  2. 2

    So sánh nguồn và kết quả

    Mỗi ví dụ hiển thị Markdown thô bên cạnh kết quả của trình phân tích GFM thực tế.

  3. 3

    Sao chép đoạn mã

    Chạm vào sao chép để lấy mã nguồn của bất kỳ ví dụ nào.

  4. 4

    Kiểm tra nhãn cú pháp

    Mỗi ví dụ được gắn nhãn CommonMark hoặc GitHub Flavored Markdown (GFM).

Tiêu đề

# Tiêu đề H1
## Mục H2
### Mục con H3

Hãy dùng kiểu ATX (#) thay vì Setext (=== bên dưới văn bản). Mọi trình phân tích đều hỗ trợ cả hai, nhưng ATX dễ đọc hơn trong một diff.

Nhấn mạnh

*nghiêng* hoặc _nghiêng_, **đậm** hoặc __đậm__, ***đậm nghiêng***. GFM bổ sung ~~gạch ngang~~.

Danh sách

Danh sách không thứ tự dùng -, * hoặc + (chọn một và dùng nhất quán):

- Thứ nhất
- Thứ hai
  - Lồng nhau (hai khoảng trắng)

Danh sách có thứ tự tự động đánh số lại:

1. Mục
1. Mục
1. Mục

Nội dòng: `code`. Khối có rào kèm thẻ ngôn ngữ tùy chọn:

```python
def hello(name):
    return f"Xin chào, {name}"
```

Hãy thụt lề bốn khoảng trắng cho khối mã nếu bạn thích cú pháp cũ hơn.

Liên kết và hình ảnh

[Văn bản liên kết](https://example.com)
[Liên kết có tiêu đề](https://example.com "Chú giải")
![Văn bản thay thế](/path/to/image.png)

Kiểu tham chiếu giúp giữ các URL dài nằm ngoài đoạn văn:

Xem [tài liệu][1].

[1]: https://example.com/docs

Bảng (GFM)

| Col A | Col B |
|-------|------:|
| a     |     1 |
| b     |    22 |

Căn chỉnh dùng dấu hai chấm trong hàng phân cách: :--- căn trái, :---: căn giữa, ---: căn phải.

Danh sách công việc (GFM)

- [x] Hoàn thành
- [ ] Cần làm

Những lỗi thường gặp

  • Hai khoảng trắng ở cuối dòng chèn một dấu ngắt dòng trong đoạn văn. Một khoảng trắng chỉ nối các dòng lại với nhau.
  • Cần một dòng trống trước hầu hết các phần tử khối (tiêu đề, danh sách, khối mã).
  • Đừng thụt lề dấu đầu dòng của danh sách bằng tab nếu trình render của bạn yêu cầu khoảng trắng; hãy thụt lề bằng hai hoặc bốn khoảng trắng.
  • Thoát bằng dấu gạch chéo ngược để hiển thị dấu câu theo đúng nghĩa đen: \*không phải chữ nghiêng\*.
  • Dấu ngoặc kép thông minh khác nhau tùy trình render. GitHub giữ nguyên chúng; Pandoc thì chuyển đổi.

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

CommonMark xác định phần lõi có tính tương thích cao, gồm tiêu đề, danh sách, liên kết và khối mã có rào với chuỗi thông tin tùy chọn. GFM bổ sung bảng, danh sách công việc, gạch ngang và tự động tạo liên kết cho URL thuần. Trình soạn thảo khác có thể chỉ hỗ trợ một phần hoặc thêm phần mở rộng riêng.

Markdown coi một lần xuống dòng đơn lẻ như một khoảng trắng. Để có <br>, hãy kết thúc dòng bằng hai khoảng trắng, hoặc dùng \ ở cuối dòng trong GFM.

Có, ở hầu hết các trình phân tích, các thẻ HTML cấp khối được truyền qua nguyên vẹn. Một số trình render sẽ làm sạch chúng (GitHub loại bỏ các script nội tuyến và thuộc tính sự kiện).

CommonMark không có cú pháp mục lục tích hợp. GitHub tạo neo tiêu đề và hiển thị dàn ý cho tệp có nhiều tiêu đề. Nền tảng khác có quy tắc riêng: MkDocs có thể dùng [TOC] khi bật phần mở rộng tương ứng, còn Docusaurus tạo mục lục trang từ các tiêu đề.

Các quy tắc của CommonMark và GFM thì có. Tuy nhiên, Obsidian bổ sung liên kết wiki ([[Tên trang]]), callout và các khối nhúng chỉ riêng Obsidian mới có, những yếu tố này không nằm trong bảng tra cứu này.

Công cụ liên quan