xyd

xyd là một khung tài liệu cho phép bạn tạo các trang web tài liệu chuyên nghiệp mà không phải vật lộn với các công cụ phức tạp. Nó đi kèm với sáu chủ đề đẹp mắt tích hợp sẵn mà bạn có thể sử dụng ngay lập tức, hoặc bạn có thể tùy chỉnh mọi phần để phù hợp với thương hiệu của mình. Khung này tự động tạo tài liệu từ các đặc tả mã OpenAPI, GraphQL, TypeScript và React của bạn.

Không giống như các công cụ tài liệu khác, xyd bao gồm tất cả những gì bạn cần ngay từ đầu. Bạn có tìm kiếm toàn văn với các đề xuất thông minh, phân tích tích hợp để theo dõi cách mọi người sử dụng tài liệu của bạn, tích hợp chat trực tiếp và thậm chí khả năng thử nghiệm A/B. Máy chủ phát triển khởi động ngay lập tức với tính năng tải lại nóng, vì vậy bạn thấy các thay đổi ngay lập tức. Được xây dựng bởi các nhà phát triển dành cho các nhà phát triển, xyd loại bỏ những phần nhàm chán trong việc tạo tài liệu để bạn có thể tập trung vào việc viết nội dung tuyệt vời.

Bắt đầu với xyd rất đơn giản. Dưới đây là các bước để tạo tài liệu của bạn:

• Cài đặt xyd toàn cục bằng lệnh bun add -g xyd-js hoặc trình quản lý gói bạn ưa thích. Bạn cần cài đặt Node.js phiên bản 22.12 trở lên trên máy tính của mình.

• Chạy xyd trong thư mục dự án của bạn để khởi động máy chủ phát triển. Nó khởi chạy ngay lập tức với tính năng tải lại nóng, nghĩa là bạn có thể thấy các thay đổi xuất hiện ngay mà không cần khởi động lại.

• Chọn từ sáu chủ đề tích hợp sẵn hoặc tạo thiết kế tùy chỉnh của riêng bạn. Mỗi chủ đề cung cấp phong cách và bố cục khác nhau để phù hợp với nhu cầu dự án của bạn.

• Viết tài liệu của bạn bằng khung nội dung phong phú hỗ trợ các thành phần tương tác, ví dụ mã trực tiếp và các yếu tố động giúp tài liệu của bạn trở nên hấp dẫn hơn.

• Đối với tài liệu API, chỉ cần trỏ xyd đến các đặc tả OpenAPI, GraphQL, TypeScript hoặc React của bạn và nó sẽ tự động tạo ra tài liệu đẹp mắt.

• Chạy xyd build khi đã sẵn sàng để tạo các tệp tĩnh phục vụ triển khai lên bất kỳ dịch vụ lưu trữ nào.

• Sáu chủ đề tích hợp đẹp mắt có sẵn

• Tài liệu API tự động từ OpenAPI, GraphQL, TypeScript, React

• Máy chủ phát triển tải lại nhanh không cần cấu hình

• Tùy chỉnh đầy đủ tất cả các thành phần và bố cục

• Hệ sinh thái plugin phong phú cho tìm kiếm, phân tích, trò chuyện

• Ví dụ mã tương tác và nội dung động

• Hỗ trợ phân tích tích hợp và kiểm thử A/B

• Chức năng tìm kiếm toàn văn siêu nhanh

• Mã nguồn mở và hoàn toàn miễn phí

• Công cụ di chuyển từ các framework khác