icyleaf / markd

Yet another markdown parser, Compliant to CommonMark specification, written in Crystal.
MIT License
109 stars 30 forks source link

Improve documentation #55

Open devnote-dev opened 1 year ago

devnote-dev commented 1 year ago

I think it's safe to say that the majority of the library is undocumented or is lacking sufficient documentation. This isn't really useful if you're trying to implement a custom renderer which has many methods, or even make use of the parsers. Adding doc comments to the necessary classes/methods/etc would resolve this (maybe with examples too?), then possibly having the docs hosted? Of course, this isn't required, but it's definitely a plausible solution.