Tạo tài liệu với các tệp Markdown bằng Docsify
Nếu bạn đang tạo một plugin, khung hoặc tập lệnh nguồn mở miễn phí bạn sẽ cần tài liệu. Nó rất quan trọng đối với tài liệu công việc của bạn, cả cho sự tỉnh táo của bạn và để giúp đỡ những người khác muốn tìm hiểu tài nguyên tuyệt vời của bạn.
Tuy nhiên, tạo tài liệu trực tuyến có thể là một nỗi đau thực sự. Rất may, Tài liệu hóa làm cho nó dễ dàng hơn bằng cách cung cấp một trình tạo tài liệu miễn phí chạy trên Markdown.
Đây là không phải là một trình tạo trang tĩnh và nó làm không yêu cầu các trang HTML / CSS tĩnh. Thay vào đó tải tập tin Markdown năng động và hiển thị chúng dưới dạng các trang web. Khá gọn gàng!
Kiểm tra trang chủ Docsify để biết xem trước bố cục, cùng với thêm chi tiết thiết lập.
Nó đòi hỏi bạn tự tạo tệp index.html, sau đó có thể được tải lên Trang GitHub hoặc được lưu trữ trên máy chủ của riêng bạn. Từ đó, bạn chỉ cần ghi tập tin Markdown cho mỗi trang và sử dụng chúng làm tài liệu chính của bạn.
Toàn bộ quá trình được phác thảo chi tiết trong hướng dẫn nhanh, Vì vậy, đó có lẽ là nơi tốt nhất để bắt đầu. Cái này có thể tất cả chạy qua npm, vì vậy nó thực sự giúp biết được dấu nhắc lệnh của bạn hoặc ít nhất là sẵn sàng học hỏi.
Có thể tự tạo một tệp HTML thô và chỉ cần sao chép / dán mẫu từ hướng dẫn thiết lập của Docsify. Nhưng, tôi khuyên bạn nên làm nó năng động, vì nó tiết kiệm rất nhiều thời gian - và đó không thực sự là vấn đề?
Khi bạn tìm hiểu hệ thống Docsify, bạn có thể thêm các tính năng bằng Markdown hoặc HTML thô. Những tính năng này bao gồm một thanh điều hướng tùy chỉnh và ngay cả trang bìa của riêng bạn với logo của dự án của bạn.
Docsify thậm chí đi kèm với một loạt các chủ đề miễn phí nếu bạn muốn bố trí được thiết kế sẵn để làm việc với. Hoặc bạn có thể duyệt qua bộ sưu tập giới thiệu của họ để xem dự án nào sử dụng Docsify cho tài liệu của họ.
Tất cả thông tin thiết lập cơ bản và tải tập tin có thể được tìm thấy trên GitHub, vì vậy hãy đến đó nếu bạn muốn thử.
Bạn cũng có thể xem bản demo trực tiếp trên trang tài liệu Docsify chính trong đó, chắc chắn, chạy trên Docsify. Vì vậy, nếu bạn thích bố cục trang web đó, bạn có thể sử dụng cùng một mẫu đó và chạy tất cả thông qua Docsify, miễn phí 100% và nguồn mở.
