docs: generate API docs from typedoc, insert in README

salesforce / kagekiri

Shadow DOM-piercing query APIs for the browser.

BSD 3-Clause "New" or "Revised" License

86 stars 9 forks source link

docs: generate API docs from typedoc, insert in README #49

Closed nolanlawson closed 4 years ago

nolanlawson commented 4 years ago

Generates markdown API docs using typedoc (based on kagekiri.d.ts) and inserts them into the README. Makes it so we only have to update kagekiri.d.ts and the docs flow from there.

I didn't make it part of npm run build because it seems like something we'd only occasionally have to do, and it takes a bit of time to run.