docs
docs copied to clipboard
Publish API Docs using the Docusaurus TypeDoc API plugin
This adds and configures TypeDoc for API Doc publishing using https://github.com/milesj/docusaurus-plugin-typedoc-api.
To run, make sure the xstate submodule is updated and built:
git co typedoc
git submodule init
git submodule update
cd xstate
yarn
cd ..
yarn
yarn docusaurus start
Package index is at /api/next
XState is at /api/next/core
Unfinished:
- [ ] Actually fix the issue with the
VersionBannercomponent which was preventing the docs from rendering (on this line). Disabled it viapatch-packagefor now. - [x] Use the name/label
coreinstead ofxstatefor xstate core in URI (e.g.:/api/next/xstate) - [x] Maybe just
/api/<package>instead of/api/next/<package>? - [ ] Switch from TSDoc syntax back to more familiar JSDoc (e.g.:
@remarks) - [ ] Fix missing links in
@see?
@audionerd is attempting to deploy a commit to the Stately Team on Vercel.
A member of the Team first needs to authorize it.
The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Updated (UTC) |
|---|---|---|---|
| docs | ✅ Ready (Inspect) | Visit Preview | Nov 30, 2023 10:35am |