Publish API docs to GitHub Pages #18
Merged
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
🦋 Changeset detectedLatest commit: a9bf219 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
georgechoustoulakis
approved these changes
Apr 5, 2024
|
We now also run tests on CI (finally)! 😁 |
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.
This sets up TypeDoc with the
packagesentry point strategy to generate a single API documentation website for all connectors. It'll look something like this:In order to correctly resolve type references between connectors (e.g. for
ConvivaConnector.connect(connector: YospaceConnector)), TypeDoc expects individual.d.tsfiles rather than one big bundle. So I decided to throw outrollup-plugin-dtsand use TypeScript's regular.d.tsemit.I also added a README for the monorepo itself. This will show up both on GitHub and in TypeDoc.
The API docs will be published to GitHub Pages, and should become available at https://theoplayer.github.io/web-connectors/api/.