Doctave

Doctave là một nền tảng tài liệu kết hợp sự linh hoạt của việc viết bằng Markdown với sức mạnh của việc lưu trữ tài liệu chuyên nghiệp. Bạn viết tài liệu của mình trong các tệp văn bản thuần túy, lưu trữ chúng trong Git cùng với mã nguồn, và Doctave sẽ biến chúng thành các trang web tài liệu đẹp mắt, có thể tìm kiếm được.

Nền tảng hỗ trợ cả hướng dẫn Markdown thông thường và các đặc tả OpenAPI cho tài liệu API. Nó tự động tạo các môi trường xem trước khi bạn thực hiện thay đổi, giúp nhóm của bạn có thể xem xét cập nhật trước khi xuất bản. Mọi thứ đều được lưu trữ trong kho Git của bạn, cho phép bạn kiểm soát phiên bản đầy đủ đối với tài liệu của mình.

Doctave Studio là ứng dụng máy tính để bàn đi kèm cung cấp xem trước theo thời gian thực, gợi ý tự động hoàn thành, kiểm tra liên kết hỏng và kiểm tra chính tả. Cùng nhau, các công cụ này giúp các nhóm tạo ra tài liệu luôn cập nhật và chính xác.

Bắt đầu với Doctave rất đơn giản. Dưới đây là cách sử dụng hiệu quả:

• Tạo một thư mục tài liệu trong kho mã của bạn và viết nội dung bằng các tệp Markdown. Bao gồm một tệp README.md làm trang bắt đầu của bạn.

• Cài đặt Doctave Studio trên máy tính để xem trước tài liệu của bạn cục bộ với cập nhật thời gian thực khi bạn viết.

• Thiết lập tệp cấu hình doctave.yml để định nghĩa cấu trúc tài liệu, màu chủ đề và các liên kết điều hướng.

• Kết nối kho Git của bạn với Doctave thông qua nền tảng của họ. Mỗi khi bạn đẩy thay đổi, Doctave sẽ tự động cập nhật tài liệu đã xuất bản của bạn.

• Đối với tài liệu API, thêm tệp đặc tả OpenAPI vào kho của bạn. Doctave sẽ tự động tạo các trang tham chiếu API tương tác.

• Sử dụng các nhánh Git để quản lý các phiên bản khác nhau của tài liệu. Tạo pull request để xem xét thay đổi trước khi xuất bản, và Doctave sẽ tạo liên kết xem trước cho mỗi pull request.

• Quy trình làm việc tài liệu dựa trên Git với kiểm soát phiên bản

• Trình soạn thảo Doctave Studio trên máy tính với xem trước thời gian thực

• Hỗ trợ đặc tả OpenAPI cho tài liệu API

• Môi trường xem trước tự động cho các yêu cầu kéo

• Quản lý tài liệu đa phiên bản

• Tìm kiếm tích hợp trên toàn bộ nội dung

• Tùy chọn thương hiệu và giao diện tùy chỉnh

• Phân tích người đọc và thu thập phản hồi

• Tích hợp CI/CD cho triển khai tự động

• Tùy chọn tài liệu được bảo vệ bằng mật khẩu