Prepare release v2.0.0 (#658)

* prepare release v2.0.0 * update docs * update compatibility matrix * Update announcement banner * Cherry-pick markdown generator changes #567 from v1 --------- Co-authored-by: Bryan <[email protected]>
PaloAltoNetworks · Nov 13, 2023 · ec57fe9 · ec57fe9
1 parent a5111bf
commit ec57fe9
Show file tree

Hide file tree

Showing 14 changed files with 350 additions and 245 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,17 @@
+## 2.0.0 (Nov 13, 2023)
+
+High level enhancements
+
+- First v2.0.0 stable release!
+
+> Currently only compatible with Docusaurus v2.4.1 -> v2.4.3
+
+Other enhancements and bug fixes
+
+- upgrade to react 18 and demo docusaurus to 2.4.3 ([#656](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/656))
+- allow upgrade to react 18 ([#651](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/651))
+- stop docusaurus support at v2.4.0 ([#650](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/pull/650))
+
 ## 2.0.0-beta.5 (Oct 23, 2023)
 
 High level enhancements

diff --git a/README.md b/README.md
diff --git a/demo/docs/customization/languagetabs.md b/demo/docs/customization/languagetabs.md
@@ -10,16 +10,17 @@ description: Configuring language tabs for the API Demo Panel.
 
 The Docusaurus OpenAPI docs plugin comes with support for 8 languages which you can render as code snippets on an API operation page. The languages currently supported are:
 
-| Language | Prism Highlighter | Variants                                         |
-| -------- | ----------------- | ------------------------------------------------ |
-| `curl`   | bash              | `curl`\*                                         |
-| `python` | python            | `requests`\*, `http.client`                      |
-| `go`     | go                | `native`\*                                       |
-| `nodejs` | javascript        | `axios`\*, `native`, `requests`, `unirest`       |
-| `ruby`   | ruby              | `net::http`\*                                    |
-| `csharp` | csharp            | `restsharp`\*, `httpclient`                      |
-| `php`    | php               | `curl`\*, `guzzle`, `pecl_http`, `http_request2` |
-| `java`   | java              | `okhttp`\*, `unirest`                            |
+| Language     | Prism Highlighter | Variants                                         |
+| ------------ | ----------------- | ------------------------------------------------ |
+| `curl`       | bash              | `curl`\*                                         |
+| `python`     | python            | `requests`\*, `http.client`                      |
+| `go`         | go                | `native`\*                                       |
+| `nodejs`     | javascript        | `axios`\*, `native`, `requests`, `unirest`       |
+| `ruby`       | ruby              | `net::http`\*                                    |
+| `csharp`     | csharp            | `restsharp`\*, `httpclient`                      |
+| `php`        | php               | `curl`\*, `guzzle`, `pecl_http`, `http_request2` |
+| `java`       | java              | `okhttp`\*, `unirest`                            |
+| `powershell` | powershell        | `RestMethod`\*                                   |
 
 \* Default variant
 
@@ -60,6 +61,7 @@ The demo site disables the `ruby` and `php` languages using the following `langu
           highlight: "python",
           language: "python",
           logoClass: "python",
+          variant: "requests",
         },
         {
           highlight: "go",
@@ -70,26 +72,34 @@ The demo site disables the `ruby` and `php` languages using the following `langu
           highlight: "javascript",
           language: "nodejs",
           logoClass: "nodejs",
+          variant: "axios",
+        },
+        {
+          highlight: "ruby",
+          language: "ruby",
+          logoClass: "ruby",
         },
-        // {
-        //   highlight: "ruby",
-        //   language: "ruby",
-        //   logoClass: "ruby",
-        // },
         {
           highlight: "csharp",
           language: "csharp",
           logoClass: "csharp",
+          variant: "httpclient",
+        },
+        {
+          highlight: "php",
+          language: "php",
+          logoClass: "php",
         },
-        // {
-        //   highlight: "php",
-        //   language: "php",
-        //   logoClass: "php",
-        // },
         {
           highlight: "java",
           language: "java",
           logoClass: "java",
+          variant: "unirest",
+        },
+        {
+          highlight: "powershell",
+          language: "powershell",
+          logoClass: "powershell",
         },
       ],
 ```
diff --git a/demo/docs/customization/styling.md b/demo/docs/customization/styling.md
@@ -19,54 +19,54 @@ The demo site uses the following CSS to add coloured labels to each request incl
 ```css
 /* API Menu Items */
 .api-method > .menu__link {
-  align-items: center;
-  justify-content: start;
+  align-items: center;
+  justify-content: start;
 }
 
 .api-method > .menu__link::before {
-  width: 50px;
-  height: 20px;
-  font-size: 12px;
-  line-height: 20px;
-  text-transform: uppercase;
-  font-weight: 600;
-  border-radius: 0.25rem;
-  border: 1px solid;
-  margin-right: var(--ifm-spacing-horizontal);
-  text-align: center;
-  flex-shrink: 0;
-  border-color: transparent;
-  color: white;
+  width: 50px;
+  height: 20px;
+  font-size: 12px;
+  line-height: 20px;
+  text-transform: uppercase;
+  font-weight: 600;
+  border-radius: 0.25rem;
+  border: 1px solid;
+  margin-right: var(--ifm-spacing-horizontal);
+  text-align: center;
+  flex-shrink: 0;
+  border-color: transparent;
+  color: white;
 }
 
 .get > .menu__link::before {
-  content: "get";
-  background-color: var(--ifm-color-primary);
+  content: "get";
+  background-color: var(--ifm-color-primary);
 }
 
 .post > .menu__link::before {
-  content: "post";
-  background-color: var(--openapi-code-green);
+  content: "post";
+  background-color: var(--openapi-code-green);
 }
 
 .delete > .menu__link::before {
-  content: "del";
-  background-color: var(--openapi-code-red);
+  content: "del";
+  background-color: var(--openapi-code-red);
 }
 
 .put > .menu__link::before {
-  content: "put";
-  background-color: var(--openapi-code-blue);
+  content: "put";
+  background-color: var(--openapi-code-blue);
 }
 
 .patch > .menu__link::before {
-  content: "patch";
-  background-color: var(--openapi-code-orange);
+  content: "patch";
+  background-color: var(--openapi-code-orange);
 }
 
 .head > .menu__link::before {
-  content: "head";
-  background-color: var(--ifm-color-secondary-darkest);
+  content: "head";
+  background-color: var(--ifm-color-secondary-darkest);
 }
 ```