donate-button icon indicating copy to clipboard operation
donate-button copied to clipboard

Automated documentation updates

Open osdiab opened this issue 3 years ago • 1 comments

Would be nice to generate the options/examples automatically from source with something like JSDoc.

osdiab avatar Feb 01 '21 09:02 osdiab

We can probably write TSDoc comments and then use microsoft's parser to parse them, dump them into the README (as opposed to something heavy-weight like using typedoc to generate an entire site). This library isn't that big, so just need to basically do the config object.

https://github.com/microsoft/tsdoc/tree/master/tsdoc

osdiab avatar Feb 09 '21 12:02 osdiab