AI Cho Mọi Người

AI Cho Mọi Người

Viết tài liệu kỹ thuật dùng Markdown

Giới thiệu markdown

Trong bài này, chúng ta sẽ làm quen với cách viết tài liệu kỹ thuật sử ngôn ngữ markdown. Chúng ta có thể soạn tài liệu markdown trên jupyter notebook hay những chương trình chuyên biệt như markdown editor. Ở đây, chúng ta sẽ học cách viết tài liệu markdown trên trang https://dillinger.io.

Tiêu đề với dấu #

Chúng ta sử dụng dấu # để đánh dấu đoạn chữ dạng tiêu đề. Chúng ta cùng xem ví dụ về cách dùng # như sau

Kết quả output của đoạn mã markdown ở trên là

Chèn mã code lập trình

Chúng ta dùng cặp dấu `` để làm nổi bật phần code. Chúng ta cùng quan sát ví dụ sau

Mã markdown:

Kết quả của đoạn mã markdown trên:

Phần code python ở ví dụ trên được đặt trong cặp ```python ... ```.

Chèn công thức toán

Để chèn công thức toán, đầu tiên chúng ta cần dùng một editor để tạo công thức dùng mã latex. Các editor hỗ trợ việc tạo công thức mà không cần chúng ta phải nhớ mã latex. Trong bài này, chúng ta sẽ sử dụng trang web https://www.codecogs.com/latex/eqneditor.php để xây dựng công thức.

Đây là ví dụ tạo công thức từ trang web. Công thức được hiện thị ở phần dưới, và code latex tương ứng ở trong khung. Việc tạo công thức khá trực quan, các bạn thao tác với nó khoảng 30 là thành thạo.

 

Bước tiếp theo, chúng ta sẽ copy mã latex vào markdown và để trong cặp dấu $$ ... $$ như sau

Mã markdown

Kết quả hiển thị

 

Như vậy chúng ta đã học qua cách viết tài liệu có chứa code lập trình và công thức toán. Những tiện ích khác của markdown các bạn xem thêm ở link dưới nhé.

Phần đọc thêm: https://guides.github.com/features/mastering-markdown/