Skip to content

Commit

Permalink
docs(generator): update latest generator documentation (#2957)
Browse files Browse the repository at this point in the history
  • Loading branch information
asyncapi-bot authored May 13, 2024
1 parent 593510c commit 6d29111
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion pages/docs/tools/generator/template-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ weight: 100
---

While using the generator tool, you may want dynamic values populated to your templates and rendered in the output. The generator can achieve that using the **template context**.
The **template context** allows you to access the contents of the [AsyncAPI document](asyncapi-document.md) and inject dynamic values to the template files passed to the asyncAPI CLI during the generation process. The render engine then displays these dynamically assigned values in the output.
The **template context** allows you to access the contents of the [AsyncAPI document](asyncapi-document) and inject dynamic values to the template files passed to the asyncAPI CLI during the generation process. The render engine then displays these dynamically assigned values in the output.

## Generation process
1. The **Generator** receives **Template** and **params** as input.
Expand Down
6 changes: 3 additions & 3 deletions pages/docs/tools/generator/template-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The above example will produce an `asyncapi.md` file where usage of the AsyncAPI
Before the generation process begins, the generator installs the template into its dependencies. A `package.json` file is necessary to identify the template name.
The following block shows an example `package.json` file that points to the [React Render Engine](react-render-engine.md) and necessary dependencies:
The following block shows an example `package.json` file that points to the [React Render Engine](react-render-engine) and necessary dependencies:
```json
{
Expand Down Expand Up @@ -64,7 +64,7 @@ You must configure the generator's `package.json` file to contain JSON objects w
|`parameters[param].default`| Any | Default value of the parameter if not specified. Shouldn't be used for mandatory `required=true` parameters.
|`parameters[param].required`| Boolean | Whether the parameter is required or not.
The above table lists some configuration options that help the generator achieve a specific set of tasks throughout the generation process. The `generator` property from 'package.json' contains all the configuration information. To learn more about template configuration and various supported parameters, read the [generator configuration file](configuration-file.md).
The above table lists some configuration options that help the generator achieve a specific set of tasks throughout the generation process. The `generator` property from 'package.json' contains all the configuration information. To learn more about template configuration and various supported parameters, read the [generator configuration file](configuration-file).
> Whenever you make a change to the package.json, make sure you perform an update by running `npm install`; this command synchronizes with the `package-lock.json` and validates the file.
Expand Down Expand Up @@ -137,7 +137,7 @@ The above configuration helps template users override the existing version with
## Hooks
[Hooks](hooks.md) enable templates to perform multiple tasks. You can add Hooks to your template as fractions of code. In the template, you must store it in the `hooks` directory under the template directory. You can also store it in other modules and external libraries or configure it inside the template. The generation process can perform multiple actions.
[Hooks](hooks) enable templates to perform multiple tasks. You can add Hooks to your template as fractions of code. In the template, you must store it in the `hooks` directory under the template directory. You can also store it in other modules and external libraries or configure it inside the template. The generation process can perform multiple actions.
**Templates** can perform multiple actions _before_ or _after_ the generation process with the help of **hooks**.
Expand Down
2 changes: 1 addition & 1 deletion pages/docs/tools/generator/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 50

## Template

A template is a project that specifies the generation process output by using the AsyncAPI generator and an [AsyncAPI document](asyncapi-document.md). These files describe the generation results depending on the AsyncAPI document's content.
A template is a project that specifies the generation process output by using the AsyncAPI generator and an [AsyncAPI document](asyncapi-document). These files describe the generation results depending on the AsyncAPI document's content.

Examples outputs:

Expand Down

0 comments on commit 6d29111

Please sign in to comment.