Skip to content

Hướng dẫn Cú pháp Markdown

Markdown là một ngôn ngữ đánh dấu. Markdown là một cú pháp định dạng cho văn bản có thể được đọc bởi con người và có thể dễ dàng chuyển đổi sang HTML, PDF, RTF, ...Các phần mềm sử dụng ngôn ngữ Markdown: GitHub, GitBook, Reddit, Diaspora, Stack Overflow, OpenStreetMap và các ứng dụng khác. Một tài liệu Markdown là một file văn bản với phần mở rộng là .md. Bạn có thể mở tệp tin markdown bằng một trình soạn thảo bất kỳ trên máy tính của bạn.

introduction

Định dạng Heading

Chọn kích thước chữ, đồng thời là cơ sở để đánh mục lục (Preferences Level) theo cấp độ từ 1 --> 6. Theo mặc định, các chỉ mục có level Heading là 1 hoặc 2 sẽ được đánh mục lục.

Cú pháp: # Heading 1 (Lưu ý: Phần mục lục (table of content) sẽ bị lỗi nếu có nhiều hơn 1 Heading 1 trong tệp tin .md )

Cú pháp: ## Heading 2

Cú pháp: ### Heading 3

Heading 3

Cú pháp: #### Heading 4

Heading 4

Cú pháp: ##### Heading 5

Heading 5

Cú pháp: ###### Heading 6

Heading 6

Định dạng Character styles

Định dạng cho văn bản các kiểu in đậm, in nghiêng, gạch chân, gạch ngang, thẻ code inline, thẻ code block

In đậm: kẹp trong cặp dấu in đậm

Cú pháp: **từ cần in đậm**

Đây là một văn bản cần in đậm.

In nghiêng: kẹp trong cặp dấu in nghiêng

Cú pháp: _từ cần in nghiêng_

Đây là một văn bản cần in nghiêng.

In vừa đậm vừa nghiêng: kẹp trong cặp dấu in vừa đậm vừa nghiêng

Cú pháp: **_từ cần in vừa đậm vừa nghiêng_** hoặc _**từ cần in vừa đậm vừa nghiêng**_

Đây là một văn bản cần in vừa đậm vừa nghiêng.

In gạch dưới: kẹp trong cặp dấu in gạch dưới

Cú pháp: <ins>từ cần in gạch dưới</ins>

Đây là một văn bản cần in gạch dưới.

In kiểu trích dẫn: đi sau dấu > trích dẫn

Cú pháp: > từ cần in kiểu trích dẫn

Đây là một văn bản được trích dẫn.

In kiểu thẻ code inline: kẹp trong cặp dấu code inline

Cú pháp: \`\` code inline \`\`

Đây là một văn bản được nằm trong thẻ code inline.

In kiểu code block: kẹp trong cặp dấu code block

Cú pháp: \`\`\` code block \`\`\`

Đây là một khối code block: 

def say_hi(): 
    print("Hello World!")
    return True

Định dạng kiểu danh sách

Để dùng danh sách có thứ tự (ordered list), cú pháp là <Số thứ tự> . Văn bản

Cú pháp như sau: 

1. Đây là văn bản thứ nhất
2. Đây là văn bản thứ hai
3. Đây là văn bản thứ ba

  1. Đây là văn bản thứ nhất
  2. Đây là văn bản thứ hai
  3. Đây là văn bản thứ ba

Để dùng danh sách không có thứ tự (unordered list), cú pháp là - Văn bản

Cú pháp như sau: 

- Đây là một văn bản 
- Đây là một văn bản 
- Đây là một văn bản
  • Đây là một văn bản
  • Đây là một văn bản
  • Đây là một văn bản

Các kiểu chèn đường dẫn và chèn hình ảnh

Chèn đường dẫn url

[Alt-Text](Url cần chèn)

VD: [Link Google ](https://www.google.com/) Đây là đường dẫn đến trang Google.

Chèn đường dẫn đến trang nội bộ khác

Cú pháp: [Trang hướng dẫn](tên file .md cần trỏ đến)

VD: ![đường dẫn](about.md)

Đây là đường dẫn đến trang giới thiệu.

Chèn hình ảnh từ url trực tiếp

Cú pháp: ![Alt-Text](Url của hình ảnh)

VD: ![Alt-Text](https://nghialagi.org/wp-content/uploads/2020/03/machine-learning-la-gi-1024x733.jpg)

Chèn hình ảnh (tải ảnh lên)

Cú pháp: ![Alt-Text](Đường dẫn (path) của ảnh)

VD: ![introduction](img/markdown-guide-og.jpg) introduction

Lưu ý: Khi tải hình ảnh lên, cần tổ chức file theo cấu trúc như sau: 

docs/
    markdown-syntax.md 
    img/  ==> Tạo folder img đồng cấp với file markdown sử dụng ảnh, ví dụ đây là file markdown-syntax.md thì cần tạo folder img/ đồng cấp. 
        markdown-guide-og.jpg

    Vue.JS 
        introduction.md 
        installation.md 
        img/ ==> Nếu file installation.md sử dụng ảnh tải lên, thì phải tạo folder img/ đồng cấp với nó (nằm trong folder Vue.JS) và tải ảnh cần dùng lên đây. 
            image_001.jpg 
            image_002.jpg