devnote-dev / devnote-dev/docr

Solutions for missing dependencies

Đang mở
#9 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement help wanted
Ngôn ngữ chính
Crystal
Star
18
Fork
3
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Docr is currently using [Markd](https://github.com/icyleaf/markd) to handle markdown parsing for doc content. This is not ideal as the API is poorly documented and [is not reusable](https://github.com/devnote-dev/docr/blob/1c8abfa34594f885d477d904be5fa466a411b702/src/renderer.cr#L101). On top of that, the API itself is difficult to work with; there are many bugs with the current formatting of doc content due to this. At present there is no markdown formatting applied to type summary text, this is likely the cause. It's safe to say this will not be sustainable for the long-term.

I have put effort into [Marker](https://github.com/devnote-dev/marker), an alternative token-based markdown parser, but it is still far from production ready. Until then there should be another alternative Docr can use before it can be released. As a last resort the HTML content may have to be stripped from type summary text and just grin-and-bear Markd until Marker is ready.

Markdown code blocks are currently tinted with a dark-ish brown (?) colour. Ideally this should be highlighted as Crystal code so I am exploring integrating [Tartrazine](https://github.com/ralsina/tartazine).

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Hướng nghiên cứu

Bắt đầu bằng cách đọc src/renderer.cr quanh dòng 101 để hiểu cách Markd được sử dụng cho nội dung tài liệu và các bản tóm tắt kiểu. So sánh các phương án thay thế đã nêu, Marker và Tartrazine, đồng thời kiểm tra hướng đã chọn dựa trên tình trạng thiếu định dạng và tô sáng khối mã được báo cáo; được xem là hoàn tất khi dự án có một đường dẫn dependency sẵn sàng cho production cho các trường hợp đó.

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

Đánh giá

Công nghệ
crystal
Lĩnh vực
cli, documentation
Loại issue
Tính năng
Độ 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
25/100

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.