[mkdocs] - explore how to move away from multiple .html files to just one .md file per page
Đang mở
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- JavaScript
- Star
- 18.3k
- Fork
- 2k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 28
Mô tả
We should move away from having .html files as the files that you edit to make changes to the docs. Ideally to edit the docs you'd edit a .md file and everything for a specific page is in the one .md file.
Having multiple html files for one page like we have in our existing docs, makes it challenging to create new content and edit existing content.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách xem xét tài liệu hiện có được chia thành nhiều tệp .html cho mỗi trang như thế nào và các tệp đó được build ra sao. Xác định phương án migration để mỗi trang có thể được chỉnh sửa trong một tệp .md, đồng thời giữ nguyên nội dung tài liệu và output hiện có.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- markdown
- Lĩnh vực
- documentation
- Loại issue
- Tái cấu trúc
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 30/100