Skip to content

Commit

Permalink
docs(generator): update latest generator docs
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot committed Jan 14, 2025
1 parent e3722be commit e99a5ce
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions markdown/docs/tools/generator/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ Reference API documentation for AsyncAPI Generator library.
* [.executeAfterHook()](#Generator+executeAfterHook)`Promise.<void>`
* [.parseInput()](#Generator+parseInput)
* [.configureTemplate()](#Generator+configureTemplate)
* ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString)`Promise`~~
* [.generateFromURL(asyncapiURL)](#Generator+generateFromURL)`Promise`
* [.generateFromFile(asyncapiFile)](#Generator+generateFromFile)`Promise`
* ~~[.generateFromString(asyncapiString, [parseOptions])](#Generator+generateFromString)`Promise.<(TemplateRenderResult|undefined)>`~~
* [.generateFromURL(asyncapiURL)](#Generator+generateFromURL)`Promise.<(TemplateRenderResult|undefined)>`
* [.generateFromFile(asyncapiFile)](#Generator+generateFromFile)`Promise.<(TemplateRenderResult|undefined)>`
* [.installTemplate([force])](#Generator+installTemplate)
* _static_
* [.getTemplateFile(templateName, filePath, [templatesDir])](#Generator.getTemplateFile)`Promise`
Expand Down
2 changes: 1 addition & 1 deletion markdown/docs/tools/generator/installation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ To uninstall the generator, use the following command:
npm uninstall @asyncapi/cli -g
```

> :memo: **Note:** To use the generator in your CI/CD pipeline to automate whatever you generate for your event-driven architecture apps, install the AsyncAPI CLI in your pipeline. If you are using GitHub Actions, use [Github Actions for Generator](https://github.com/marketplace/actions/generator-validator-converter-and-others-all-in-one-for-your-asyncapi-docs).
> :memo: **Note:** To use the generator in your CI/CD pipeline to automate whatever you generate for your event-driven architecture apps, install the AsyncAPI CLI in your pipeline. If you are using GitHub Actions, use [Github Actions for Generator](https://github.com/marketplace/actions/generator-for-asyncapi-documents).
## Generator library in Node.js apps
Use the generator library in your Node.js projects by installing it via the following command: `npm install @asyncapi/generator`.
Expand Down

0 comments on commit e99a5ce

Please sign in to comment.