Docusaurus: Một công cụ tuyệt vời để ghi lại các dự án

Một trong những nhiệm vụ quan trọng nhất khi tạo phần mềm là tài liệu, thật không may cho những người trong chúng ta, những người phát triển công việc này đôi khi nó có vẻ tẻ nhạt, nhưng không có gì bí mật đối với bất kỳ ai rằng tài liệu tốt có thể là điểm thành công của bất kỳ công cụ nào, vì sự trợ giúp được cung cấp cho người dùng để hiểu hoạt động chính xác của ứng dụng hoặc thông tin được cung cấp cho các nhà phát triển khác để cải thiện nó.

Có những ứng dụng khá tốt cho phép chúng ta ghi lại các dự án của mình một cách đơn giản, một số có xu hướng cung cấp nhiều hơn những gì chúng ta thực sự muốn và những ứng dụng khác yêu cầu cài đặt phức tạp, a công cụ để lập hồ sơ dự án phù hợp và khá đơn giản để sử dụng và cài đặt là Docusaurus.

Docusaurus là gì?

D Focusaurus là một dự án cho xây dựng, triển khai và duy trì tài liệu web về các công cụ nguồn mở, nó cho phép sử dụng ngôn ngữ Markdown Để viết tài liệu sau này sẽ được xuất bản dưới dạng trang web html, theo cách tương tự, công cụ này cho phép chúng tôi mở rộng và tùy chỉnh thiết kế trang web tài liệu của mình bằng cách sử dụng React.

Nhìn chung, công cụ mã nguồn mở này được phát triển bởi nhóm lập trình Facebook cho phép chúng tôi dễ dàng tạo ra các trang web đẹp và nhẹ, nơi chúng tôi có thể hiển thị đúng tài liệu của bất kỳ dự án nào.

Công cụ này được trang bị các chức năng để xác định đúng phiên bản của tài liệu, công cụ tìm kiếm nâng cao, khả năng tạo tài liệu và thiết kế lại trang web tài liệu của chúng tôi trong thời gian thực, tích hợp với bản dịch và nhiều tính năng khác sẽ giúp bạn bớt lo lắng về việc lập tài liệu hoặc thay vì tạo quy trình tài liệu dễ dàng hơn và với một kết thúc dễ chịu hơn.

Việc sử dụng dễ dàng Docusaurus có thể được nhìn thấy trong gif sau do các nhà phát triển của nó phân phối

Làm thế nào để cài đặt Docusaurus?

Mục tiêu chính của Docusaurus là trở thành công cụ hoàn hảo để tạo tài liệu cho các ứng dụng nguồn mở được lưu trữ trên github, vì vậy việc cài đặt và chạy trang web tài liệu của bạn trên nền tảng này thực sự dễ dàng.

Để bắt đầu thưởng thức Docusaurus trên Github, chỉ cần làm theo các bước được nhóm phát triển chỉ ra và chúng tôi trích dẫn bên dưới:

  1. Đi tới thư mục gốc của thư mục kho lưu trữ GitHub nơi bạn sẽ tạo tài liệu và chạy các lệnh sau:
  2. yarn global add docusaurus-init or npm install --global docusaurus-init
  3. docusaurus-init

Kết quả cuối cùng sẽ là tạo ra một tệp và cấu trúc thư mục như hình dưới đây:

công cụ để lập hồ sơ dự án


Nội dung bài viết tuân thủ các nguyên tắc của chúng tôi về đạo đức biên tập. Để báo lỗi, hãy nhấp vào đây.

Một bình luận, để lại của bạn

Để lại bình luận của bạn

địa chỉ email của bạn sẽ không được công bố. Các trường bắt buộc được đánh dấu bằng *

*

*

  1. Chịu trách nhiệm về dữ liệu: Miguel Ángel Gatón
  2. Mục đích của dữ liệu: Kiểm soát SPAM, quản lý bình luận.
  3. Hợp pháp: Sự đồng ý của bạn
  4. Truyền thông dữ liệu: Dữ liệu sẽ không được thông báo cho các bên thứ ba trừ khi có nghĩa vụ pháp lý.
  5. Lưu trữ dữ liệu: Cơ sở dữ liệu do Occentus Networks (EU) lưu trữ
  6. Quyền: Bất cứ lúc nào bạn có thể giới hạn, khôi phục và xóa thông tin của mình.

  1.   Juan José dijo

    Lỗi thú vị để thử!