DocFX - Hướng dẫn Markdown
Markdown là một ngôn ngữ đánh dấu đơn giản, được sử dụng rộng rãi để tạo tài liệu văn bản dễ đọc và dễ viết.
Last updated
Was this helpful?
Markdown là một ngôn ngữ đánh dấu đơn giản, được sử dụng rộng rãi để tạo tài liệu văn bản dễ đọc và dễ viết.
Last updated
Was this helpful?
Trong , Markdown là thành phần cốt lõi, giúp bạn viết nội dung tài liệu nhanh chóng với các tính năng mở rộng mạnh mẽ. Bài viết này sẽ hướng dẫn bạn cách sử dụng Markdown trong DocFX, bao gồm các cú pháp cơ bản, các mở rộng hỗ trợ và cách tùy chỉnh.
Các cú pháp Markdown phổ biến:
Tiêu đề:
Kết quả:
In đậm và in nghiêng:
Kết quả: In đậm và In nghiêng.
Danh sách:
Danh sách không thứ tự:
Danh sách có thứ tự:
Liên kết và hình ảnh:
Khối mã:
DocFX hỗ trợ các mở rộng Markdown để cung cấp thêm nhiều tính năng.
Sử dụng tab để hiển thị nội dung theo các tùy chọn khác nhau:
Hiển thị các ghi chú dạng cảnh báo, thông báo hoặc mẹo:
Dẫn liên kết giữa các trang hoặc tài liệu:
Hỗ trợ nhúng hình ảnh:
Và video:
Tạo bảng với Markdown:
YAML Metadata cho phép bạn thêm thông tin meta vào đầu file Markdown:
docfx.json
Bạn có thể cấu hình Markdown trong DocFX bằng cách thêm phần markdownEngine
vào file docfx.json
:
Markdown trong DocFX không chỉ dùng cho nội dung tùy chỉnh mà còn có thể được tích hợp với tài liệu API để thêm giải thích hoặc ví dụ. Điều này giúp cải thiện chất lượng tài liệu và trải nghiệm người dùng.
Ví dụ, bạn có thể thêm các phần mở rộng Markdown vào tài liệu API:
Để hiểu rõ hơn về Markdown trong DocFX, bạn có thể tham khảo thêm:
Markdown là công cụ đơn giản nhưng mạnh mẽ trong DocFX, giúp bạn tạo tài liệu chất lượng cao một cách nhanh chóng. Với các mở rộng và tùy chỉnh của DocFX, bạn có thể tận dụng Markdown để tăng tính chuyên nghiệp và dễ đọc của tài liệu.
Hãy thử sử dụng Markdown trong DocFX ngay hôm nay và chia sẻ trải nghiệm của bạn! 😊
Nếu bạn có câu hỏi hoặc cần hỗ trợ thêm, hãy để lại bình luận dưới bài viết nhé!