From c629f776abf78dceb8fd7199ac83a3593cfa7816 Mon Sep 17 00:00:00 2001 From: Steven Serrata <9343811+sserrata@users.noreply.github.com> Date: Wed, 25 Jun 2025 16:47:07 -0500 Subject: [PATCH] docs: fix typos and tables --- README.md | 20 ++++++++-------- demo/docs/intro.mdx | 24 +++++++++---------- .../docusaurus-plugin-openapi-docs/README.md | 19 ++++++++------- 3 files changed, 32 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index bbfc72ede..98777c6af 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ Key Features: ## Bootstrapping from Template (new Docusaurus site) -Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`: +Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash npx create-docusaurus@3.7.0 my-website --package-manager yarn @@ -192,13 +192,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following `versions` can be configured with the following options: -| Name | Type | Default | Description | -| ------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | -| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of micro OpenAPI specification files. | -| `ouputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. | -| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. | -| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. | -| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification for versioned. | +| Name | Type | Default | Description | +| ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | +| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. | +| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. | +| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. | +| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. | +| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. | > All versions will automatically inherit `sidebarOptions` from the parent/base config. @@ -330,11 +330,11 @@ yarn docusaurus gen-api-docs:version petstore:all > This will generate API docs for all of the OpenAPI specification (OAS) files referenced in your `versions` config and will also generate a `versions.json` file. -> Substitue `all` with a specific version ID to generate/clean a specific version. Generating for `all` or a specific version ID will automatically update the `versions.json` file. +> Substitute `all` with a specific version ID to generate or clean a specific version. Generating for `all` or a single version ID will automatically update the `versions.json` file. ## Developer Quick Start -> Looking to make a contribution? Make sure to checkout out our contributing guide. +> Looking to make a contribution? Make sure to check out our contributing guide. After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following: diff --git a/demo/docs/intro.mdx b/demo/docs/intro.mdx index 418ed39f7..7a55c2a30 100644 --- a/demo/docs/intro.mdx +++ b/demo/docs/intro.mdx @@ -65,12 +65,12 @@ Key Features: :::tip -If you"re building a Docusaurus site from scratch the easiest way to get started is by [installing from template](#bootstrapping-from-template-new-docusaurus-site). +If you're building a Docusaurus site from scratch, the easiest way to get started is by [installing from template](#bootstrapping-from-template-new-docusaurus-site). ::: ## Bootstrapping from Template (new Docusaurus site) -Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`: +Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash npx create-docusaurus@3.7.0 my-website --package-manager yarn @@ -220,13 +220,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following `versions` can be configured with the following options: -| Name | Type | Default | Description | -| ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | -| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of micro OpenAPI specification files. | -| `ouputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. | -| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. | -| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. | - +| Name | Type | Default | Description | +| ----------- | -------- | ------- | ----------- | +| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. | +| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. | +| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. | +| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. | +| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. | > All versions will automatically inherit `sidebarOptions` from the parent/base config. ### markdownGenerators @@ -358,14 +358,14 @@ yarn docusaurus gen-api-docs:version petstore:1.0.0 ``` :::tip -Substitue `all` with a specific version ID to generate/clean a specific version. Generating for `all` or a specific version ID will automatically update the `versions.json` file. +Substitute `all` with a specific version ID to generate or clean a specific version. Generating for `all` or a single version ID will automatically update the `versions.json` file. ::: -See [versions options](#versions) for a list of available options. For a complete example of how to configure versining see the [demo configuration](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/demo/docusaurus.config.js#L190). +See [versions options](#versions) for a list of available options. For a complete example of how to configure versioning see the [demo configuration](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/demo/docusaurus.config.js#L190). ## Developer Quick Start -> Looking to make a contribution? Make sure to checkout out our contributing guide. +> Looking to make a contribution? Make sure to check out our contributing guide. After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following: diff --git a/packages/docusaurus-plugin-openapi-docs/README.md b/packages/docusaurus-plugin-openapi-docs/README.md index 4fdc077f4..e6ad85375 100644 --- a/packages/docusaurus-plugin-openapi-docs/README.md +++ b/packages/docusaurus-plugin-openapi-docs/README.md @@ -48,7 +48,7 @@ Key Features: ## Bootstrapping from Template (new Docusaurus site) -Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`: +Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`: ```bash npx create-docusaurus@3.7.0 my-website --package-manager yarn @@ -192,12 +192,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following `versions` can be configured with the following options: -| Name | Type | Default | Description | -| ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ | -| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of micro OpenAPI specification files. | -| `ouputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. | -| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. | -| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. | +| Name | Type | Default | Description | +| ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- | +| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. | +| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. | +| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. | +| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. | +| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. | > All versions will automatically inherit `sidebarOptions` from the parent/base config. @@ -329,11 +330,11 @@ yarn docusaurus gen-api-docs:version petstore:all > This will generate API docs for all of the OpenAPI specification (OAS) files referenced in your `versions` config and will also generate a `versions.json` file. -> Substitue `all` with a specific version ID to generate/clean a specific version. Generating for `all` or a specific version ID will automatically update the `versions.json` file. +> Substitute `all` with a specific version ID to generate or clean a specific version. Generating for `all` or a single version ID will automatically update the `versions.json` file. ## Developer Quick Start -> Looking to make a contribution? Make sure to checkout out our contributing guide. +> Looking to make a contribution? Make sure to check out our contributing guide. After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following: