markd icon indicating copy to clipboard operation
markd copied to clipboard

Improve documentation

Open devnote-dev opened this issue 2 years ago • 0 comments

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.

devnote-dev avatar Apr 09 '23 08:04 devnote-dev