devnote-dev / devnote-dev/docr

Solutions for missing dependencies

未關閉
#9 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
enhancement help wanted
主要語言
Crystal
星號
18
分支
3
PR 合併指標
30 天內沒有已合併 PR

描述

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).

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

Start by reading src/renderer.cr around line 101 to understand how Markd is used for doc content and type summaries. Compare the stated alternatives, Marker and Tartrazine, and verify the chosen direction against the reported missing formatting and code-block highlighting; done means the project has a production-ready dependency path for those cases.

由索引模型根據 Issue 內容生成。

評估

技術堆疊
crystal
領域
cli, documentation
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。