DocFX là công cụ mạnh mẽ để tạo tài liệu API và tài liệu website tĩnh từ Markdown. Để tăng hiệu quả, việc sử dụng script batch giúp tự động hóa quá trình build và quản lý tài liệu trở nên dễ dàng hơn.
Last updated
Was this helpful?
Trong bài viết này, bạn sẽ học cách cài đặt, cấu hình, khởi tạo DocFX và sử dụng script batch để build nhanh chóng.
Truy cập .
Tải phiên bản mới nhất từ .
Giải nén file .zip và thêm thư mục chứa DocFX vào biến môi trường PATH.
Điều kiện tiên quyết:
Làm quen với dòng lệnh
Cài đặt .NET SDK 8.0 trở lên
Cài đặt Node.js v20 trở lên (Tùy chọn: Bắt buộc khi sử dụng Tạo tệp PDF)
Mở terminal/cmd và chạy lệnh:
Nếu hiển thị phiên bản, DocFX đã được cài đặt thành công.
Trong thư mục dự án, chạy lệnh:
Lệnh này tạo ra file docfx.json và các thư mục cần thiết:
api/
articles/
toc.yml
docfx.jsonCập nhật file docfx.json để chỉ định nguồn tài liệu và output:
docfx-build.batFile batch tự động hóa quá trình build DocFX, serve tài liệu, và tích hợp Git. Dưới đây là nội dung chính:
Biến cấu hình:
PROJECT_DIR: Thư mục hiện tại.
CONFIG_PATH: Đường dẫn file docfx.json.
OUTPUT_DIR: Thư mục chứa tài liệu sau khi build.
Lệnh chính:
--build: Build tài liệu.
--serve: Khởi chạy tài liệu trên trình duyệt.
--git: Commit và push tài liệu lên Git.
Build tài liệu: Chạy lệnh:
Tài liệu sẽ được xuất ra thư mục artifacts/docfx.
Serve tài liệu trên trình duyệt: Chạy lệnh:
Hỗ trợ Git: Nếu file batch có tích hợp Git, bạn có thể sử dụng:
Xem hướng dẫn:
Tự động hóa: Giảm thao tác thủ công.
Tích hợp Git: Đảm bảo tài liệu luôn được cập nhật trên repository.
Dễ dàng mở rộng: Thêm các chức năng khác như kiểm tra lỗi, nén tài liệu, v.v.
Sử dụng DocFX cùng script batch là cách tuyệt vời để quản lý tài liệu cho các dự án .NET. Hy vọng bài viết đã cung cấp cho bạn kiến thức cần thiết để triển khai DocFX hiệu quả trong dự án của mình.
Hãy thử ngay và chia sẻ trải nghiệm của bạn!
Nếu bạn có thắc mắc hoặc cần thêm hỗ trợ, đừng ngần ngại để lại bình luận. 😊