Publish API Docs using the Docusaurus TypeDoc API plugin #288
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
|
@audionerd is attempting to deploy a commit to the Stately Team on Vercel. A member of the Team first needs to authorize it. |
This was referenced Nov 29, 2023
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
`yarn docusaurus api:version 4`
VersionBanner was failing here: https://github.com/milesj/docusaurus-plugin-typedoc-api/blob/9169c0e9ab804e6cac5f915665e0efd041ab46f0/packages/plugin/src/components/VersionBanner.tsx#L20 Patching for now until we have time to find a fix.
- `/api/xstate` instead of `/api/core` - `/api/@xstate/react` instead of `/api/xstate-react`
Merged
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 adds and configures TypeDoc for API Doc publishing using https://github.com/milesj/docusaurus-plugin-typedoc-api.
To run, make sure the
xstatesubmodule is updated and built:Package index is at
/api/nextXState is at
/api/next/coreUnfinished:
VersionBannercomponent which was preventing the docs from rendering (on this line). Disabled it viapatch-packagefor now.coreinstead ofxstatefor xstate core in URI (e.g.:/api/next/xstate)/api/<package>instead of/api/next/<package>?@remarks)@see?