Tạo mục lục Markdown
Tạo mục lục cho README hay bất kỳ tài liệu Markdown nào. Công cụ đọc các tiêu đề, dựng danh sách lồng nhau với liên kết neo chạy đúng trên GitHub, và có thể chèn thẳng vào tài liệu. Mọi thứ chạy ngay trên trình duyệt.
Các bước sử dụng
- Dán Markdown vào ô Markdown, hoặc dùng thanh nhập liệu ở đầu ô: Mở file, Dán, Dữ liệu mẫu (Ví dụ của công cụ này, README, Tài liệu API có bảng & code, Biên bản họp, Bài blog) và Xoá. Bạn cũng có thể kéo thả file
.mdvào ô. - Chọn khoảng cấp tiêu đề bằng Từ và đến — ví dụ H2 đến H3 cho một README thông thường.
- Chọn Kiểu danh sách (Gạch đầu dòng hoặc Đánh số), Thụt lề (2 dấu cách hoặc 4 dấu cách), có thêm Liên kết hay không, và bật Bỏ H1 đầu tiên nếu không muốn tên tài liệu xuất hiện trong mục lục.
- Xem kết quả bên phải: Mục lục chỉ hiện danh sách, Tài liệu kèm mục lục hiện toàn bộ tài liệu với mục lục chèn sau H1 đầu tiên, còn Xem trước dựng tài liệu để bạn bấm thử liên kết xem có nhảy đúng tiêu đề không.
- Bấm Sao chép mục lục hoặc Sao chép tài liệu, hay Tải .md để lưu tài liệu kèm mục lục.
Mẹo
- Neo liên kết theo quy tắc của GitHub: chữ thường, bỏ dấu câu, khoảng trắng thành gạch nối, tiêu đề trùng được đánh số
-1,-2. Chữ tiếng Việt có dấu được giữ nguyên như trên GitHub. - Cấp tiêu đề bị nhảy vẫn xử lý được — H4 nằm ngay dưới H2 chỉ thụt vào một bậc, danh sách không bị vỡ.
- Tiêu đề trong khối code bị bỏ qua; tiêu đề nằm trong danh sách hay trích dẫn vẫn được tính, giống cách GitHub đánh số.
- Đang viết trong Soạn thảo Markdown? Menu Công cụ ở đó chèn hoặc cập nhật đúng mục lục này mà không cần rời trang.
<!-- toc --> và <!-- tocstop -->, không hiện ra khi hiển thị. Sau khi sửa tiêu đề, hãy dán lại tài liệu vào và sao chép lần nữa — mục lục cũ được thay thế chứ không bị chèn thêm.
Câu hỏi thường gặp
Mục lục được chèn vào đâu?
Ngay sau tiêu đề H1 đầu tiên. Nếu không có H1, mục lục nằm ở đầu tài liệu (sau YAML front matter nếu có). Nếu tài liệu đã có hai dấu <!-- toc -->, mục lục được đặt giữa chúng.
Liên kết có chạy ngoài GitHub không?
Có, ở mọi nơi tạo id tiêu đề theo kiểu GitHub: GitHub, GitLab, phần lớn trình tạo trang tĩnh và các công cụ Markdown của trang này. Một số nền tảng tạo id khác; khi đó hãy tắt Liên kết để lấy dàn ý thuần.
Tài liệu của tôi có bị tải lên không?
Không. Mục lục được tạo ngay trên trình duyệt của bạn.