Markdown Toolbox Logo Markdown Toolbox
Trang chủ
Blog

Tài liệu tóm tắt - Markdown kiểu GitHub

2023-12-12

Markdown có định dạng GitHub (GFM) mở rộng cú pháp Markdown chuẩn để bao gồm một số tính năng bổ sung cụ thể cho GitHub. Tài liệu tóm tắt này đề cập đến các khía cạnh chính của GFM, giúp dễ dàng hơn trong việc tạo ra README, vấn đề và tài liệu khác trên GitHub.

Cú Pháp Mở Rộng

Danh Sách Công Việc

  • Tạo danh sách công việc với - [ ] cho công việc chưa hoàn thành và - [x] cho công việc đã hoàn thành.

    -   [x] Công việc đã hoàn thành
    -   [ ] Công việc chưa hoàn thành
    

Gạch Đường

  • Sử dụng dấu ~ kép ~~ để gạch qua văn bản.

    ~~Gạch đường~~
    

Bảng

  • Tạo bảng sử dụng dấu gạch - và đường kẻ |.

    | Tiêu đề 1 | Tiêu đề 2 |
    | -------- | -------- |
    | Hàng 1    | Dữ liệu 1   |
    | Hàng 2    | Dữ liệu 2   |
    

Khối Mã Rào

  • Sử dụng ba dấu nháy ngược (```) và chỉ định một ngôn ngữ để làm nổi bật cú pháp.

    ```javascript console.log("Xin chào, thế giới!"); ```

Gợi Nhắc Người Dùng và Nhóm

  • Sử dụng @tênngười dùng để nhắc đến một người dùng hoặc nhóm.

Tham Chiếu Vấn Đề và Yêu Cầu Gộp

  • Tham chiếu vấn đề và yêu cầu gộp bằng cách sử dụng #.

Cú Pháp Markdown Chuẩn

Tiêu Đề

  • Sử dụng # cho tiêu đề. Nhiều # hơn có nghĩa là tiêu đề nhỏ hơn.

Định Dạng Văn Bản

  • Đậm: **đậm**
  • Nghiêng: *nghiêng*
  • Đậm và Nghiêng: ***đậm & nghiêng***

Danh Sách

  • Danh sách không có thứ tự: Bắt đầu bằng -, +, hoặc *.
  • Danh sách có thứ tự: Bắt đầu bằng số theo sau bởi ..

Liên Kết và Hình Ảnh

  • Liên kết: [Tiêu đề](URL)
  • Hình ảnh: ![Văn bản thay thế](URL)

Trích Dẫn

  • Sử dụng > cho các trích dẫn khối.

Markdown của GitHub cho phép tài liệu tương tác và động hơn, đặc biệt hữu ích trong bối cảnh của các dự án hợp tác.