Docusaurus

Docusaurus là một trình tạo trang tĩnh được xây dựng bằng React và Node.js. Nó lấy các tệp Markdown của bạn và tạo ra một trang web tài liệu hoàn chỉnh với tất cả các tính năng mà người dùng mong đợi. Khác với việc xây dựng một trang web từ đầu, Docusaurus xử lý những phần khó cho bạn.

Công cụ này sử dụng MDX, có nghĩa là bạn có thể thêm các thành phần React tương tác ngay bên trong các tệp Markdown của mình. Điều này làm cho tài liệu của bạn trở nên hấp dẫn hơn mà không cần thêm công sức. Nó đi kèm với chức năng tìm kiếm tích hợp được hỗ trợ bởi Algolia, quản lý phiên bản cho các bản phát hành sản phẩm khác nhau, và hỗ trợ hơn 70 ngôn ngữ thông qua các công cụ dịch thuật.

Vì nó tạo ra các tệp tĩnh, tài liệu của bạn tải nhanh và có thể được lưu trữ ở bất cứ đâu. Các trang web hoạt động tốt trên thiết bị di động và tuân theo các tiêu chuẩn web hiện đại về tốc độ và khả năng truy cập.

Bắt đầu với Docusaurus rất đơn giản và chỉ mất vài phút:

• Cài đặt Node.js phiên bản 20 trở lên trên máy tính của bạn, sau đó chạy lệnh thiết lập trong terminal để tạo một trang web mới.

• Viết tài liệu của bạn trong các tệp Markdown bên trong thư mục docs. Mỗi tệp sẽ trở thành một trang trên trang web của bạn.

• Tùy chỉnh giao diện bằng cách chỉnh sửa tệp cấu hình. Bạn có thể thay đổi màu sắc, thêm logo và thiết lập menu điều hướng.

• Sử dụng lệnh xem trước cục bộ để thấy các thay đổi ngay lập tức trên trình duyệt khi bạn làm việc.

• Thêm bài viết blog bằng cách tạo các tệp Markdown trong thư mục blog với ngày tháng trong tên tệp.

• Khi sẵn sàng xuất bản, chạy lệnh build để tạo các tệp tĩnh, sau đó tải chúng lên bất kỳ dịch vụ lưu trữ web nào như GitHub Pages, Netlify hoặc Vercel.

Công cụ bao gồm các hướng dẫn chi tiết và một cộng đồng hỗ trợ hữu ích nếu bạn gặp khó khăn.

• Miễn phí và mã nguồn mở với giấy phép MIT

• Xây dựng bằng React và Node.js

• Viết nội dung bằng Markdown và MDX

• Tìm kiếm tích hợp với Algolia DocSearch

• Quản lý phiên bản cho các bản phát hành sản phẩm

• Hỗ trợ hơn 70 ngôn ngữ

• Blog và tài liệu trong cùng một trang

• Chế độ tối và thiết kế đáp ứng

• Tạo trang tĩnh nhanh

• Dễ dàng triển khai lên bất kỳ máy chủ nào