Hướng dẫn viết file markdown (readme.md)

File markdown thường được sử dụng để viết hướng dẫn trong các repository. VD: https://github.com/viscomsolution/ipssbike

Ngoài ra còn ứng dụng trong viết file Jupyter Notebook. Bài viết này hướng dẫn viết file markdown (readme.md) với các format của file MD thường gặp nhất

Kích cỡ chữ

# tương đương tag h1, ## tương đương tag h2,…

# Đây là tiêu đề

## Đây là mục 01

### Đây là mục 1.1

List

Dùng – (dấu trừ) hoặc dấu + (cộng) hoặc * (dấu sao) để tạo ra list có dấu chấm đầu dòng. Trong trường hợp muốn tạo thêm lớp level thấp hơn thì thêm 2 khoảng trắng vào nữa.

  • – Dòng 1
  • – Dòng 1
  • – Dòng 1

Url/link

[thigiacmaytinh.com](https://thigiacmaytinh.com) sẽ cho ra kết quả:
thigiacmaytinh.com

Embed image

![](images_dir/image_path.jpg)
Kết quả

Checkbox

[ ] dùng để vẽ checkbox unchecked
[x] dùng để vẽ checkbox checked

Font style

1 dấu sao ở đầu và cuối để in nghiêng
*in nghiêng*

2 dấu sao ở đầu và cuối để in đậm
**in đậm**

3 dấu sao ở đầu và cuối để vừa in nghiêng vừa in đậm
***vừa in nghiêng vừa in đậm***

2 dấu ~ ở đầu và cuối để gạch ngang chữ
~~gạch ngang chữ~~

Chèn code

Sử dụng ` hoặc ``` ở đầu và cuối đoạn text (nằm cùng với dấu ~)
```print(‘hello world’)``` cho ra kết quả:
print('hello world')

Quote

Viết dấu > (dấu lớn) để hiển thị quote (trích dẫn):

Kẻ ngang

Dùng 3 dấu sao *** để kẻ 1 đường ngang


Tạo bảng

| STT | Cột 1 | Cột 2 |
| :—– | :———- | :————– |
| 1 | Dòng 11 | Dòng 21 |
| 2 | Dòng 12 | Dòng 22 |
| 3 | Dòng 13 | Dòng 23 |
| 4 | Dòng 14 | Dòng 24 |

Kết quả như hình dưới

Leave a Reply