docusaurus-plugin-openapi-docs 5.0.0 → 5.0.1

package/README.md

@@ -47,24 +47,14 @@ Key Features:
 | 2.2.3 (end-of-support)  | `2.4.1 - 2.4.3` |
 | 1.7.3 (end-of-support)  | `2.0.1 - 2.2.0` |
 
-## Bootstrapping from Template (new Docusaurus site)
+## Quick Start (new Docusaurus site)
 
 Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
 
 ```bash
-npx create-docusaurus@3.10.0 my-website --package-manager yarn
+npx create-docusaurus-openapi-docs my-website
 ```
 
-> When prompted to select a template choose `Git repository`.
-
-Template Repository URL:
-
-```bash
-https://github.com/PaloAltoNetworks/docusaurus-template-openapi-docs.git
-```
-
-> When asked how the template repo should be cloned choose "copy".
-
 ```bash
 cd my-website
 yarn start
@@ -72,6 +62,13 @@ yarn start
 
 If all goes well, you should be greeted by a brand new Docusaurus site that includes API reference docs for the ubiquitous Petstore API!
 
+### CLI Options
+
+| Option                            | Description                                           |
+| --------------------------------- | ----------------------------------------------------- |
+| `-p, --package-manager <manager>` | Use a specific package manager (yarn, npm, pnpm, bun) |
+| `-s, --skip-install`              | Skip automatic dependency installation                |
+
 ## Installation (existing Docusaurus site)
 
 > Both the plugin and theme are currently designed to pair with a specific Docusaurus release. The Docusaurus badge in the `README.md` and at the top of this page will always reflect the current compatible versions.

package/lib/markdown/createDeprecationNotice.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDeprecationNotice = createDeprecationNotice;
 const utils_1 = require("./utils");
 function createAdmonition({ children }) {
-    return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
+    return `:::caution[deprecated]\n\n${(0, utils_1.render)(children)}\n\n:::`;
 }
 function createDeprecationNotice({ deprecated, description, }) {
     return (0, utils_1.guard)(deprecated, () => createAdmonition({

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -65,5 +65,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "516bd48c628fb16b7fe90d8f996168ab75ce5562"
+  "gitHead": "467fb6d5e1e78e0fd2ce5aaa2904aef701fe87e3"
 }

package/src/markdown/createDeprecationNotice.ts

@@ -8,7 +8,7 @@
 import { clean, guard, Props, render } from "./utils";
 
 function createAdmonition({ children }: Props) {
-  return `:::caution deprecated\n\n${render(children)}\n\n:::`;
+  return `:::caution[deprecated]\n\n${render(children)}\n\n:::`;
 }
 
 interface DeprecationNoticeProps {