Convert to Markdown

Đang mở
  • Có gì không ổn?
#105 4 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
github-actions, markdown
Lĩnh vực
build-system, documentation

Hướng nghiên cứu

Bắt đầu bằng cách xem xét nguồn tài liệu và cấu hình build hiện tại của repository, sau đó so sánh workflow tài liệu helloSystem được tham chiếu trong issue. Xác định Markdown, Sphinx, MyST và GitHub Actions sẽ kết hợp với nhau như thế nào. Công việc được xem là hoàn tất khi tài liệu đã được chuyển đổi và site được tạo có thể build thành công bằng workflow đã chọn.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

This is a proposal to convert the documentation to Markdown since many people are familiar with it (myself included) but are not familiar with ReStructuredText. Personally I don't have the time nor interest in learning another markup language when Markdown is the standard on GitHub. As a result, I have not been involved with the documentation lately.

https://hellosystem.github.io/docs/ uses Sphinx, recommonmark, and GitHub Actions to produce documentation from the Markdown source files in this repository: https://github.com/helloSystem/docs

Maybe we can use a similar tooling for this documentation?

NOTE: recommonmark is now deprecated. Its developers recommend using MyST for a docutils bridge going forward. See this issue for background and discussion.

Ngôn ngữ chính
HTML
Star
50
Fork
46
Merge trung bình
5 giờ 11 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

  • Có Dockerfile hoặc tệp Docker Compose
  • Không có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của AppImage/docs.appimage.org

Tất cả issue của AppImage/docs.appimage.org

Issue tương tự

Thêm issue về Build System

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.