ngrok / ngrok-javascript

Embed ngrok secure ingress into your Node.js apps with a single line of code.
https://ngrok.com
Apache License 2.0
94 stars 18 forks source link

add docs generated by typedoc #15

Closed bobzilladev closed 1 year ago

bobzilladev commented 1 year ago

The first commit contains the code and configuration changes to enable typedoc. The second commit contains the generated docs, which will be served by github pages. After that will need to set up a cname similar to https://typescript-api.docs.ngrok.com/

bobzilladev commented 1 year ago

Wait, does npm not generate docs for every package like we get for free with docs.rs, pkg.go.dev, etc? 😔

Not that I can see. I'm emulating what we have for ngrok-api. https://www.npmjs.com/package/@ngrok/ngrok-api links to a cname'd github page: https://typescript-api.docs.ngrok.com/