Hướng dẫn sử dụng markdown để viết bài Tutorial

Giới thiệu

Tính năng bài viết (hay còn gọi là Tutorial) trong chuyên trang Cộng đồng của 123HOST sử dụng cú pháp Markdown để viết bài. Vì vậy bạn phải thành thạo sử dụng cú pháp markdown khi viết. Sẽ có một chút khó khăn ban đầu để làm quen, nhưng sau này bạn sẽ thích.

Dưới đây là một số định dạng markdown thường gặp

Thẻ Heading

Heading là các mục chính trong bài viết. Tại tutorial chỉ được sử dụng H2 đến H3 (H1 là tiêu đề nên không được sử dụng). Khai báo heading bạn chỉ cần để dấu # ở trước.

Ví dụ:

• Khai báo H2: ## Đây là H2
• Khai báo H3: ### Đây là H3
• Khai báo H4: #### Đây là H4

Lưu ý: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.

Thẻ heading H2 được hệ thống sử dụng cho mục lục bên trái của bài viết.

Lệnh bởi user thường

Dòng lệnh bằng user thường (không phải root) trong markdown cần được khai báo như sau:

```command {.language-shell} [label bash]
df -h
```

Trong đó:

• command để khai báo đây là lệnh thực hiện bằng non-root user.

• {.language-shell} để khai báo ngôn ngữ để hệ thống highlight là shell.

• [label bash] để hệ thống hiện label trên thanh terminal.

Kết quả sẽ hiển thị như sau:

df -h
_

Lệnh bởi user root

Dòng lệnh bằng user root cần được khai báo như sau:

```command_root {.language-shell} [label bash]
touch /root/test.txt
```

Trong đó:

• command_root để khai báo đây là lệnh thực hiện bằng root user.

• {.language-shell} để khai báo ngôn ngữ để hệ thống highlight là shell.

• [label bash] để hệ thống hiện label trên thanh terminal.

Kết quả sẽ hiển thị như sau:

touch /root/test.txt
_

Nếu lệnh khai báo cho non-root user, hệ thống sẽ tự thêm prefix là $, nếu là root user, hệ thống sẽ tự thêm prefix là #

Lệnh với custom prefix

Một số trường hợp như lệnh trong MySQL, lệnh trong FTP... bạn cần khai báo prefix. Cú pháp:

```command_prefix {language-sql} [label mysql>]
select count(*) from tb_student where type="test";
```

Kết quả:

select count(*) from tb_student where type="test";
_

Chú thích:

• command_prefix để khai báo hiển thị lệnh có prefix

• {language-sql} để khai báo ngôn ngữ của lệnh là SQL, bạn có thể thay thế bằng ngôn ngữ khác nếu bạn muốn.

• [label mysql>] để khai báo prefix là mysql>. Thay mysql> bằng ftp> hoặc các prefix khác tùy trường hợp.

Nội dung file

Khi cần thể hiện nội dung file nào đó, như file cấu hình dịch vụ, file script python... bạn cần sử dụng cú pháp sau:

```file {.language-ini} [label /etc/vsftpd.conf]
. . .
# Allow anonymous FTP? (Disabled by default).
anonymous_enable=NO
#
# Uncomment this to allow local users to log in.
local_enable=YES
. . .
```

Kết quả sẽ là:

. . .
# Allow anonymous FTP? (Disabled by default).
anonymous_enable=NO
#
# Uncomment this to allow local users to log in.
local_enable=YES
. . .

Giải thích:

• file: Khai báo đây là nội dung một file

• {.language-ini} ngôn ngữ để hiện thị highlight đây là file cấu hình (ini). Ngoài ini, bạn có thể thay bằng sql, php, python, html hoặc bất cứ ngôn ngữ lập trình nào khác.

• [label /etc/vsftpd.conf] để hệ thống hiện label trên thanh terminal là đường dẫn file

• . . . để cho người dùng biết đây chỉ là trích đoạn, file cấu hình còn nhiều nội dung khác.

Output kết quả lệnh

Kết quả của một lệnh có thể khai báo bằng các cách như sau:

Cách 1: Tách riêng output, không để chung với lệnh

Cú pháp:

```output {.language-shell}
Filesystem      Size  Used Avail Use% Mounted on
/dev/simfs       80G   60G   20G  76% /
none            4.0G  4.0K  4.0G   1% /dev
none            4.0G     0  4.0G   0% /dev/shm
```

Kết quả hiển thị sẽ là:

Filesystem      Size  Used Avail Use% Mounted on
/dev/simfs       80G   60G   20G  76% /
none            4.0G  4.0K  4.0G   1% /dev
none            4.0G     0  4.0G   0% /dev/shm

Cách 2: Để chung với dòng lệnh

Cú pháp:

```command_root {.language-shell} [label bash]
df-h
Filesystem      Size  Used Avail Use% Mounted on
/dev/simfs       80G   60G   20G  76% /
none            4.0G  4.0K  4.0G   1% /dev
none            4.0G     0  4.0G   0% /dev/shm
```

Kết quả:

df-h
Filesystem      Size  Used Avail Use% Mounted on
/dev/simfs       80G   60G   20G  76% /
none            4.0G  4.0K  4.0G   1% /dev
none            4.0G     0  4.0G   0% /dev/shm
_

Ảnh

Khai báo:

![logo 123HOST](https://123host.vn/uploads/tutorial/8423649987.png)

Kết quả:

Ảnh trong tutorial bạn không cần phải căn chỉnh. Mặc định hệ thống sẽ căn chỉnh center.

Link

Khai báo:

[Cộng đồng](https://123host.vn/community)

Kết quả: Cộng đồng

Hộp cảnh báo

Cú pháp:

<$>[warning]
**Lưu ý**: Bạn cần sao lưu dữ liệu trước khi thực hiện thao tác trên.
<$>

<$>[info]
**Thông tin**: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.
<$>

<$>[warning]
**Lưu ý**: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.
<$>

<$>[danger]
**Cảnh báo**: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.
<$>

Kết quả:

Lưu ý: Bạn cần sao lưu dữ liệu trước khi thực hiện thao tác trên.

Thông tin: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.

Lưu ý: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.

Cảnh báo: Không nên sử dụng quá nhiều thẻ heading. Chỉ nên dùng cho ý chính của bài viết. Thẻ heading phải ngắn gọi để phần Mục lục được thể hiện hợp lý.

Ngoài warning, bạn có thể sử dụng info, primary, danger.

In đậm và in nghiêng

In đậm: Rào từ cần in đậm bởi dấu **

Câu này có từ **in đậm**

Kết quả: Câu này có từ in đậm

In nghiêng: Rào từ cần in đậm bởi dấu _

Câu này có từ _in nghiêng_

Kết quả: Câu này có từ in nghiêng

Highligh từ

Cú pháp: Rào bởi dấu `. Ví dụ

Từ `này` được highlight

Kết quả: Từ này được highlight

Blockquote

Cú pháp: Sử dụng dấu > trước câu

> Đây là câu dùng blockquote

Kết quả:

Đây là câu dùng blockquote

Tổng kết

Bạn có thể sử dụng VSCode hoặc các markdown editor online để soạn thảo bằng markdown dễ dàng hơn. Tuy nhiên một số format như file, command, hộp cảnh báo... là format 123HOST tự phát triển, vì vậy có thể sẽ không hiển thị đúng trên các công cụ trên.

Chúc bạn thành công.