stoplightio
Spectral TS API Documentation
User Story
A user of the TS/JS library I want up to date documentation for how it works.
Details
There a lot of tools out there, but they generally product HTML which then needs to be styled and integrated somehow. Recently I noticed TypedProducts who have this great looking API ref section:
https://typedproject.github.io/ts-log-debug/#/api/index
It is populated by this Markdown file:
https://github.com/TypedProject/ts-log-debug/blob/master/docs/api/index.md
It is generated by a build script executed by travis, and is found here:
https://github.com/TypedProject/ts-log-debug/blob/master/docs/_build/build-api.js
If there are any tools which can produce TS/JS API reference docs for us as Markdown, then we can look into them. Regardless, Markdown should make it pretty easy to host on stoplight.io.
