\n\n\n\n
\n\n## Installation\n\nInstall the preset in your docusaurus project by running:\n\n```sh\n// with npm\nnpm install docusaurus-preset-openapi\n\n// with yarn\nyarn add docusaurus-preset-openapi\n```\n\n## Usage\n\n1. Add your OpenAPI definition to the root of your site dir as `openapi.json` (See [Configuration](#Configuration) options below).\n\n2. The OpenAPI preset can be used as a drop-in replacement for `@docusaurus/preset-classic`, replace it as follows:\n\n ```js\n /* docusaurus.config.js */\n\n {\n presets: [\n [\n \"docusaurus-preset-openapi\",\n {\n // docs: { ... },\n // blogs: { ... },\n // theme: { ... },\n },\n ],\n ],\n }\n ```\n\n3. Add a link to the API section of your site by updating `themeConfig.navbar.items`:\n\n ```js\n /* docusaurus.config.js */\n\n {\n themeConfig: {\n navbar: {\n items: [\n // ... other items\n { to: \"/api\", label: \"API\", position: \"left\" },\n // ... other items\n ],\n },\n },\n }\n ```\n\n## Configuration\n\nThe OpenAPI plugin can be configured with the following options:\n\n| Name | Type | Default | Description |\n| ---------------------------- | --------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |\n| `path` | `string` | `'openapi.json'` | Path to OpenAPI definition (`json` or `yaml`) on filesystem relative to site dir. |\n| `routeBasePath` | `string` | `'api'` | URL route for the API section of your site. **DO NOT** include a trailing slash. Use `/` for shipping API without base path. |\n| `sidebarCollapsible` | `boolean` | `true` | Whether sidebar categories are collapsible by default. |\n| `sidebarCollapsed` | `boolean` | `true` | Whether sidebar categories are collapsed by default. |\n| `apiLayoutComponent` | `string` | `'@theme/ApiPage'` | Root Layout component of each API page. |\n| `apiItemComponent` | `string` | `'@theme/ApiItem'` | Main API container, with demo panel, pagination, etc. |\n| `remarkPlugins` | `any[]` | `[]` | Remark plugins passed to MDX. |\n| `rehypePlugins` | `any[]` | `[]` | Rehype plugins passed to MDX. |\n| `beforeDefaultRemarkPlugins` | `any[]` | `[]` | Custom Remark plugins passed to MDX before the default Docusaurus Remark plugins. |\n| `beforeDefaultRehypePlugins` | `any[]` | `[]` | Custom Rehype plugins passed to MDX before the default Docusaurus Rehype plugins. |\n\nExample:\n\n```js\n/* docusaurus.config.js */\n\n{\n presets: [\n [\n \"docusaurus-preset-openapi\",\n {\n api: {\n path: \"api/cars.yaml\",\n routeBasePath: \"cars\",\n // ... other options\n }\n },\n ],\n ],\n}\n```\n","readmeFilename":"README.md"}