Apidog không chỉ dừng lại ở tài liệu API bằng cách cho phép bạn tích hợp nội dung Markdown phong phú trực tiếp trong tài liệu của mình. Điều này cho phép bạn tạo các hướng dẫn người dùng toàn diện, kết hợp liền mạch tài liệu tham chiếu API với văn bản giải thích, hướng dẫn thực hành và ví dụ. Tài liệu Markdown có thể được thêm ở nhiều cấp độ và hiển thị cùng với tài liệu API để mang lại trải nghiệm tài liệu hoàn chỉnh.Tài liệu Markdown độc lập#
Thêm tài liệu Markdown độc lập vào bất kỳ thư mục endpoint nào bằng cách nhấp vào nút dấu cộng (+). Viết nội dung Markdown trong trình chỉnh sửa và xem trước ngay kết quả đã được hiển thị ở khung bên phải.Markdown trong Endpoint#
Markdown cũng được hỗ trợ trong trường Description của mỗi endpoint. Bất kỳ Markdown nào bạn thêm tại đây sẽ được hiển thị dưới dạng văn bản đã định dạng trong tài liệu API, giúp phần mô tả endpoint của bạn rõ ràng và hấp dẫn về mặt trực quan.Markdown cấp thư mục#
Thêm nội dung Markdown ở cấp thư mục để cung cấp ngữ cảnh và thông tin tổng quan. Khi người đọc nhấp vào tên thư mục trong tài liệu, họ sẽ thấy nội dung Markdown của thư mục đó. Nếu không có Markdown cấp thư mục, việc nhấp vào một thư mục chỉ đơn giản là mở rộng thư mục đó để hiển thị nội dung bên trong.Để thêm Markdown cấp thư mục:Tiện ích mở rộng Markdown của Apidog#
Apidog Markdown hỗ trợ nhiều kiểu mở rộng, bao gồm Card, Accordion, Frame và nhiều kiểu khác. Các thành phần tùy chỉnh này cho phép bạn tạo trải nghiệm tài liệu phong phú hơn và có tính tương tác cao hơn.Dễ dàng chèn các kiểu này thông qua trình chỉnh sửa Markdown bằng cách nhấp vào nút Insert, nút này cung cấp một tập hợp các phần tử có sẵn. Modified at 2026-06-11 10:23:06
