Make Complete How-to from Running Hyde, Writing Documentation to Serving in Jekyll

Đang mở
  • Có gì không ổn?
#62 2 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ó
4/5
Thời gian dự kiến
3-5 ngày
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ệ
jekyll
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu từ quy trình build Hyde và phân phối bằng Jekyll hiện có được mô tả trong issue, tập trung vào cách Markdown do Hyde tạo ra được truyền cho Jekyll. Một hướng dẫn hoàn chỉnh cần chỉ ra cách ghi tài liệu cho các phương thức và lớp C++, chạy Hyde và phân phối tài liệu thu được thông qua Jekyll.

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

Mô tả

Dear Authors.

I am very interested in documenting my C++ code in a different approach than the normal "XML/Doxygen inline" mess and as such have found Hyde. Unfortunately, I have a hard time using Hyde in conjunction with Jekyll.

I have build and run Hyde just fine, installed and served Jekyll fine, but still I dont know how to actually serve the markdown generated by Hyde and how to write documentation on the methods.

I would suggest a full end to end example on how to document code.

If somebody can help me getting to actually serve documentation with Jekyll with method and class codumentation written by me, I will be happy to write such a tutorial.

Ngôn ngữ chính
C++
Star
341
Fork
45
Không có pull request nào được merge trong 30 ngày

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

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 adobe/hyde

Tất cả issue của adobe/hyde

Issue tương tự

Thêm issue về C++

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.