Add generated API docs - Githubissues

bwrrp / slimdom.js

Fast, tiny, standards-compliant XML DOM implementation for node and the browser

MIT License

30 stars 8 forks source link

Open bwrrp opened 7 years ago

bwrrp commented 7 years ago

I've experimented with typedoc earlier to generate docs, but there are still a few issues:

[ ] Find a way to omit internal fields and types from the docs (some of these are public because they need to be accessed from other types, but internal to the library)
[x] Wait for a typedoc release for TypeScript 2.3.4
[x] TypeStrong/typedoc#513
[ ] Set up a gh-pages site and put docs there

bwrrp commented 7 years ago

@private may work to hide the internal properties and types.

bwrrp commented 5 years ago

I've moved over to Microsoft api-extractor / api-documenter, which seems to work well. TODO's at the top still apply.