starlight-openapi/README.md

Starlight plugin to generate documentation from OpenAPI/Swagger specifications.

<div align="center">
  <h1>starlight-openapi 🧭</h1>
  <p>Starlight plugin to generate documentation from OpenAPI/Swagger specifications.</p>
  <p>
    <a href="https://i.imgur.com/pbOqvMT.png" title="Screenshot of starlight-openapi">
      <img alt="Screenshot of starlight-openapi" src="https://i.imgur.com/pbOqvMT.png" width="520" />
    </a>
  </p>
</div>

<div align="center">
  <a href="https://github.com/HiDeoo/starlight-openapi/actions/workflows/integration.yml">
    <img alt="Integration Status" src="https://github.com/HiDeoo/starlight-openapi/actions/workflows/integration.yml/badge.svg" />
  </a>
  <a href="https://github.com/HiDeoo/starlight-openapi/blob/main/LICENSE">
    <img alt="License" src="https://badgen.net/github/license/HiDeoo/starlight-openapi" />
  </a>
  <br />
</div>

## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-openapi.vercel.app/getting-started/) or check out the [demo](https://starlight-openapi.vercel.app/api/petstore/operations/addpet/) to see the plugin in action.

## Features

A [Starlight](https://starlight.astro.build) plugin to generate documentation from OpenAPI/Swagger specifications.

- Support for [Swagger 2.0](https://swagger.io/specification/v2/), [OpenAPI 3.0](https://swagger.io/specification/v3/) and [OpenAPI 3.1](https://swagger.io/specification/) specifications.
- Support for local and remote schemas.
- Configurable sidebar label and sidebar group collapsing.

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-openapi/blob/main/LICENSE) for more information.