Skip to content

Commit ed09e45

Browse files
sserratasserrata
authored
docs: fix typos and tables (#1170)
1 parent 11f293f commit ed09e45

File tree

3 files changed

+32
-31
lines changed

3 files changed

+32
-31
lines changed

‎README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Key Features:
4848

4949
## Bootstrapping from Template (new Docusaurus site)
5050

51-
Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
51+
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5252

5353
```bash
5454
npx [email protected] my-website --package-manager yarn
@@ -192,13 +192,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
192192
193193
`versions` can be configured with the following options:
194194

195-
| Name | Type | Default | Description |
196-
| ------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
197-
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of micro OpenAPI specification files. |
198-
| `ouputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
199-
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |
200-
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. |
201-
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading OpenAPI specification for versioned. |
195+
| Name | Type | Default | Description |
196+
| ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
197+
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. |
198+
| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
199+
| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. |
200+
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. |
201+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. |
202202

203203
> All versions will automatically inherit `sidebarOptions` from the parent/base config.
204204
@@ -330,11 +330,11 @@ yarn docusaurus gen-api-docs:version petstore:all
330330

331331
> 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.
332332
333-
> 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.
333+
> 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.
334334
335335
## Developer Quick Start
336336

337-
> Looking to make a contribution? Make sure to checkout out our contributing guide.
337+
> Looking to make a contribution? Make sure to check out our contributing guide.
338338
339339
After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following:
340340

‎demo/docs/intro.mdx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,12 @@ Key Features:
6565

6666

6767
:::tip
68-
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).
68+
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).
6969
:::
7070

7171
## Bootstrapping from Template (new Docusaurus site)
7272

73-
Run the following to bootstrap a Docsaurus v2 site (classic theme) with `docusaurus-openapi-docs`:
73+
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
7474

7575
```bash
7676
npx [email protected] my-website --package-manager yarn
@@ -220,13 +220,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
220220
221221
`versions` can be configured with the following options:
222222

223-
| Name | Type | Default | Description |
224-
| ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
225-
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of micro OpenAPI specification files. |
226-
| `ouputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
227-
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |
228-
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. |
229-
223+
| Name | Type | Default | Description |
224+
| ----------- | -------- | ------- | ----------- |
225+
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. |
226+
| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
227+
| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. |
228+
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. |
229+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. |
230230
> All versions will automatically inherit `sidebarOptions` from the parent/base config.
231231
232232
### markdownGenerators
@@ -358,14 +358,14 @@ yarn docusaurus gen-api-docs:version petstore:1.0.0
358358
```
359359

360360
:::tip
361-
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.
361+
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.
362362
:::
363363

364-
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).
364+
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).
365365

366366
## Developer Quick Start
367367

368-
> Looking to make a contribution? Make sure to checkout out our contributing guide.
368+
> Looking to make a contribution? Make sure to check out our contributing guide.
369369
370370
After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following:
371371

‎packages/docusaurus-plugin-openapi-docs/README.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Key Features:
4848

4949
## Bootstrapping from Template (new Docusaurus site)
5050

51-
Run the following to bootstrap a Docsaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
51+
Run the following to bootstrap a Docusaurus v3 site (classic theme) with `docusaurus-openapi-docs`:
5252

5353
```bash
5454
npx [email protected] my-website --package-manager yarn
@@ -192,12 +192,13 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
192192
193193
`versions` can be configured with the following options:
194194

195-
| Name | Type | Default | Description |
196-
| ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------ |
197-
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or directory of micro OpenAPI specification files. |
198-
| `ouputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
199-
| `label` | `string` | `null` | _Optional:_ Version label used when generating version selector dropdown menu. |
200-
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating version selector dropdown menu. |
195+
| Name | Type | Default | Description |
196+
| ------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------- |
197+
| `specPath` | `string` | `null` | Designated URL or path to the source of an OpenAPI specification file or a directory of micro OpenAPI specification files. |
198+
| `outputDir` | `string` | `null` | Desired output path for versioned, generated MDX files. |
199+
| `label` | `string` | `null` | _Optional:_ Version label used when generating the version selector dropdown menu. |
200+
| `baseUrl` | `string` | `null` | _Optional:_ Version base URL used when generating the version selector dropdown menu. |
201+
| `downloadUrl` | `string` | `null` | _Optional:_ Designated URL for downloading the versioned OpenAPI specification. |
201202

202203
> All versions will automatically inherit `sidebarOptions` from the parent/base config.
203204
@@ -329,11 +330,11 @@ yarn docusaurus gen-api-docs:version petstore:all
329330

330331
> 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.
331332
332-
> 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.
333+
> 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.
333334
334335
## Developer Quick Start
335336

336-
> Looking to make a contribution? Make sure to checkout out our contributing guide.
337+
> Looking to make a contribution? Make sure to check out our contributing guide.
337338
338339
After [forking](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/fork) the main repository, run the following:
339340

0 commit comments

Comments
 (0)