Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Publish API Docs using the Docusaurus TypeDoc API plugin #288

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Publish API Docs using the Docusaurus TypeDoc API plugin #288

wants to merge 7 commits into from

Commits on Nov 30, 2023

  1. add docusaurus-plugin-typedoc-api

    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    22c2cbc View commit details
    Browse the repository at this point in the history

  2. add xstate as a submodule

    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    6164955 View commit details
    Browse the repository at this point in the history

  3. configure typedoc for version-4 

    `yarn docusaurus api:version 4`
    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    8273bee View commit details
    Browse the repository at this point in the history

  4. patch to disable VersionBanner 

    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.
    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    281dc40 View commit details
    Browse the repository at this point in the history

  5. link to api/next

    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    91db41f View commit details
    Browse the repository at this point in the history

  6. available at api instead of api/next

    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    6120ffc View commit details
    Browse the repository at this point in the history

  7. customize url slug for each package 

    - `/api/xstate` instead of `/api/core`
- `/api/@xstate/react` instead of `/api/xstate-react`
    @audionerd
    audionerd committed Nov 30, 2023
    Configuration menu
    Copy the full SHA
    c257337 View commit details
    Browse the repository at this point in the history