CÁCH VIẾT MARKDOWN

0. Thiết lập trong VSCode

Cài đặt Extension

Tiện ích cần tải trên VScode để giúp việc đánh tài liệu Markdown được nhanh hơn và có thể gõ tiếng Việt
1. Markdown All in One
2. Markdown Preview Enhance

Gõ tiếng Việt trong Markdown

Trong khung tìm kiếm của VSCode nhập >Preferences: Open Keyboard Shortcuts hoặc dùng phím tắt Ctrl + Shift + P nhập Preferences: Open Keyboard Shortcuts.
Tìm markdown.extension.onBackspaceKey và Delete.

Lưu ý

Enter không xuống dòng khi hiển thị trên web. Nhấn backspace 2 lần để xuống dòng.
Để giữ lại ký tự đặc biệt dùng dấu \
Đánh số tự động: >markdown: add and update section number
Tạo mục lục: >markdown: create table of content

1. Nút nhấn

Cú pháp:

Nút nhấn có thể dẫn đến trang local hoặc link bên ngoài.
{{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}}
{{</* button href="https://github.com/alex-shpak/hugo-book" */>}}Contribute{{</* /button */>}}

2. Code và khối code

Cú pháp:

Cú pháp 1:

Để nhấn mạnh 1 từ hay cụm từ dùng cặp dấu `và `
Nhấn mạnh từ `Code`

Cú pháp 2:

Để viết khối code, dùng cặp 3 dấu nháy ``` và ```, có thể mô tả ngôn ngữ sử dụng cạnh dấu nháy đầu tiên
```c++
#include <iostream>
using namespace std;
int main ()
{
//Vòng lặp for
for(int a = 5; a < 15; a = a + 1)
{
cout << "Gia tri cua a la: " << a << endl;
}
return 0;
}
```
Lưu ý: Khối code có thể tạo nhanh bằng Tab

Đầu ra:

Đầu ra 1:

Nhấn mạnh từ Code

Đầu ra 2:

#include <iostream> 

using namespace std; 

int main () 

{ 

    //Vòng lặp for 

    for(int a = 5; a < 15; a = a + 1) 

      { 

         cout << "Gia tri cua a la: " << a << endl; 

      } 

return 0; 

}

3. Comment

Cú pháp:

This is Line Number 1.
<!---This is Line Number 2 and would not be rendered as this is a comment. --->
This is Line Number 3.

Đầu ra:

This is Line Number 1.
This is Line Number 3.

4. Biểu đồ

Cú pháp:

Dùng mermaid Hoặc PlanUML
Additional syntax: TD means Top Down, LR means Left Right, BT means Bottom Top, RL means Right Left
```mermaid
graph RL;
A-->B;
B-->C;
C-->D;
D-->E;
```
Để ghi đè cấu hình khởi tạo cho Mermaid, hãy tạo tệp mermaid.json trong thư mục assets!

5. Dropdown

Cú pháp:

DropDown với mặc định open
<details open>
<summary>Want to know more? </summary>
<br>
This is called a DropDown.
<br>Yes! This is possible using Markdown.
<br>You can hide some content from the user.
<br>They can view the detailed message only when they click.
</details>
DropDown với mặc định không open
<details>
<summary>Want to know more? Click Here</summary>
<br>
This is called a DropDown.
<br>Yes! This is possible using Markdown.
<br>You can hide some content from the user.
<br>They can view the detailed message only when they click.
</details>

6. Phông chữ

Cú pháp:

**Đây là chữ in đậm**
*Chữ này* được _viết in nghiêng_
***In đậm và nghiêng***
~~Gạch bỏ ký tự~~

Đầu ra:

Đây là chữ in đậm

Chữ này được viết in nghiêng

In đậm và nghiêng

Gạch bỏ ký tự

7. FootNote

Cú pháp:

Chú thích cuối trang cho phép bạn thêm ghi chú và tài liệu tham khảo mà không làm lộn xộn nội dung tài liệu.
Khi bạn tạo chú thích cuối trang, số chỉ số trên cùng với liên kết sẽ xuất hiện tại nơi bạn đã thêm tham chiếu chú thích cuối trang.
Người đọc có thể nhấn vào link để chuyển đến nội dung chú thích cuối trang ở cuối trang.
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
[^1]: This is the first footnote.
[^bignote]: Here's one with multiple paragraphs and code.

Đầu ra:

Here's a simple footnote,[1] and here's a longer one.[2]

8. Tiêu đề

Cú pháp:

Cú pháp 1:

# H1 - Heading 1
## H2 - Heading 2
### H3 - Heading 3
#### H4 - Heading 4
##### H5 - Heading 5
###### H6 - Heading 6

Cú pháp 2:

Có thể dùng 3 dấu - hoặc * để tạo dấu gạch ngang phân cách các đoạn văn bản
# H1: sử dụng 3 dấu -
---
# H2: Sử dụng 3 dấu *
***

9. Chèn Link

Cú pháp:

Có thể chèn link đơn giản như sau và có thể sử dụng format lên link
Trang tìm kiếm [Google](https://www.google.com/)
Xem video trên [**Youtube**](https://www.youtube.com/)
Có cách viết chuyên nghiệp hơn như sau:
Tìm kiếm trên [Google][1] và xem video trên [Youtube][2].
[1]: <https://www.google.com/>
[2]: <https://www.youtube.com/>

Đầu ra:

Đầu ra 1:

Trang tìm kiếm Google
Xem video trên Youtube

Đầu ra 2:

Tìm kiếm trên Google và xem video trên Youtube.

10. Chèn hình ảnh

Cú pháp:

Để có thể chèn ảnh trong file .md, cần để ảnh trong thư mục local hoặc có thể up ảnh lên Imgur và lấy link của ảnh chèn vào.
Đây là ảnh local
![logo](/setup/logow.png)
Đây là ảnh imgur
![Imgur](https://imgur.com/GZL4iPM.png)

11. Biểu thức toán học

Cú pháp:

Để viết công thức toán cần đặt giữa 2 dấu $
$\alpha$
$x^2$
$x_{2n}$
$H_2SO_4$
$\to$
$\infty$
$\frac{1}{2n}$
$\sqrt[n]{k}$
Tuy nhiên, để hiển thị được trên trang web, cần sử dụng katex với cấu trúc sau
{{</* katex display */>}}
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
{{</* /katex */>}}

12. Văn bản trích dẫn

Cú pháp:

> Dùng dấu ">" khi muốn viết văn bản trích dẫn.

Đầu ra:

Dùng dấu ">" khi muốn viết văn bản trích dẫn.

13. Bảng và canh lề

Cú pháp:

Cú pháp 1:

Dưới đây là cách đơn giản để tạo bảng,
Có thể format bằng lệnh >Format Document
Có thể tạo bảng nhanh bằng lệnh >markdown preview enhanced: Insert Table
| Trái cây và màu sắc | Số lượng | Mô tả |
| ------------------- | -------- | ------------------ |
| Xoài vàng | 89 | Ngọt và chua |
| Chanh xanh | 103 | Chua, pha với nước |

Cú pháp 2:

Dùng dấu : để canh lề bảng
| Trái cây và màu sắc (trái) | Số lượng (giữa) | Mô tả (phải) |
| :------------------------- | :-------------: | -----------------: |
| Xoài vàng | 89 | Ngọt và chua |
| Chanh xanh | 103 | Chua, pha với nước |

14. Danh sách

Cú pháp:

Cú pháp 1:

Liệt kê danh sách không thứ tự
- Milk
- Tea
- Beer

Cú pháp 2:

Liệt kê danh sách theo thứ tự
1. Eat
1. Walk
1. Sleep

Cú pháp 3:

Liệt kê dùng checkbox
- [X] Code
- [ ] Review
- [ ] Commit

1 comment

  1. Metals
    Metals
    How to write Markdown