Skip to content

Commit 3894009

Browse files
authored
Update re-gen example (#188)
1 parent ff681ce commit 3894009

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Diff for: README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
<h1>Docusaurus OpenAPI Doc Generator for Elastic Path APIs</h1>
1+
<h1>OpenAPI Doc Generator for Elastic Path APIs</h1>
22

33
<div>
4-
<img alt="docusaurus" width="200" src="https://user-images.githubusercontent.com/9343811/165975569-1bc29814-884c-4931-83df-860043b625b7.svg" />
4+
<img alt="Elastic Path" width="200" src="https://raw.githubusercontent.com/elasticpath/elasticpath-dev/main/static/logo/light.svg" />
55
</div>
66

77
<div>
@@ -71,7 +71,7 @@ Partials are stored in the standard Docusaurus location of `/docs/partials` usin
7171

7272
Update HeroSectionAPIs.tsx located at `/src/components/api/HeroSectionAPIs.tsx`. Be sure to include a new icon for every service being added. We utilize [!FluentUI Icons Regular (not filled)](https://react.fluentui.dev/?path=/docs/icons-catalog--page)
7373

74-
## PaloAlto Networks OpenAPI Docs Overview
74+
## OpenAPI Docs Overview
7575

7676
The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with commands for generating MDX using the OpenAPI specification as the source. The resulting MDX is fully compatible with [plugin-content-docs](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs) and can be used to render beautiful reference API docs by setting `docItemComponent` to `@theme/ApiItem`, a custom component included in the `docusaurus-theme-openapi-docs` theme.
7777

@@ -214,10 +214,10 @@ yarn docusaurus gen-api-docs <id>
214214
Example:
215215

216216
```bash
217-
yarn docusaurus gen-api-docs burgers
217+
yarn docusaurus gen-api-docs commerceextensions
218218
```
219219

220-
> The example above will only generate API docs relative to `burgers`.
220+
> The example above will only generate API docs relative to `commerceextensions`.
221221
222222
### Cleaning API Docs
223223

@@ -236,10 +236,10 @@ yarn docusaurus clean-api-docs <id>
236236
Example:
237237

238238
```bash
239-
yarn docusaurus clean-api-docs burgers
239+
yarn docusaurus clean-api-docs commerceextensions
240240
```
241241

242-
> The example above will remove all API docs relative to `burgers`.
242+
> The example above will remove all API docs relative to `commerceextensions`.
243243
244244
### Versioning OpenAPI docs
245245

@@ -269,9 +269,9 @@ After [forking](https://github.com/elasticpath/elasticpath-dev) the main reposit
269269
git clone https://github.com/<your account>/elasticpath-dev.git
270270
cd elasticpath-dev
271271
yarn
272-
yarn build-packages
273-
yarn watch:demo
272+
yarn start
274273
```
274+
This will start the development server on localhost.
275275

276276
## Credits
277277

0 commit comments

Comments
 (0)