IBM / marked-it-cli

marked-it-cli
MIT License
5 stars 15 forks source link

Extension points documentation #22

Open gdelory opened 3 years ago

gdelory commented 3 years ago

This is more of a question that really a bug, but is there any documentation at all on the marked-it-cli specific extension points? I see in the code and example some extension point like:

which seem convenient, but they don't seem to be documented anywhere, except barely in the changelogs. That makes is hard to use 😄

Thanks!

grant-g commented 3 years ago

Hi, there currently is not doc for these, though the example/ directory contains example uses of them. An update is in the works for marked-it (the md->html generator used by marked-it-cli), which should solidify commitments to APIs and extensions in marked-it and marked-it-cli, and enable these APIs to be more confidently documented.

Also note that marked-it supports extensions at the html-generation level, some of which are also demonstrated in marked-it-cli's example/ directory (eg.- html.onTable). These have some documentation at https://github.com/IBM/marked-it.

Keeping report open, will update here as docs improve.