Add typescript documentation #28
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #15
This PR sets up TypeDoc to automatically generate docs from JSDOC/TSDOC strings.
There are some small issues like TypeDoc mistakenly assuming source files are "External". For now I'm just hacking the Handlebars theme to solve it (could find any working solution in TypeDoc's github issues).
Also for now docs are generated by
npm run docs-build, would be nice to plug it into CI, but that's another issue altogether.One "side-effect" in this PR is that I change Options type declaration in core.ts from Type to Interface. Types don't generate proper documentation automatically and Type is supposed to be just for aliases in recent TS revisions, Interfaces are used for most things nowadays. (see this and this)
You can see docs and in my fork, just go to /docs directory.
Feel free to suggest changes. :)