From e37dbec53addc9e077a6a5ca925c33261bce8136 Mon Sep 17 00:00:00 2001 From: asyncapi-bot Date: Mon, 27 Jan 2025 18:50:42 +0100 Subject: [PATCH] docs(generator): update latest generator documentation (#3613) --- markdown/docs/tools/generator/usage.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/markdown/docs/tools/generator/usage.md b/markdown/docs/tools/generator/usage.md index 344044680a57..10af036785e8 100644 --- a/markdown/docs/tools/generator/usage.md +++ b/markdown/docs/tools/generator/usage.md @@ -30,7 +30,7 @@ FLAGS --map-base-url= Maps all schema references from base url to local folder EXAMPLES - $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write + $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@3.0.0 --use-new-generator --param version=1.0.0 singleFile=true --output ./docs --force-write ``` All templates are installable npm packages. Therefore, the value of `template` can be anything supported by `npm install`. Here's a summary of the possibilities: @@ -60,29 +60,29 @@ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template **The shortest possible syntax:** ```bash -asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template +asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@3.0.0 --use-new-generator ``` **Generating from a URL:** ```bash -asyncapi generate fromTemplate https://bit.ly/asyncapi @asyncapi/html-template +asyncapi generate fromTemplate https://bit.ly/asyncapi @asyncapi/html-template@3.0.0 --use-new-generator ``` **Specify where to put the result:** ```bash -asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o ./docs +asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@3.0.0 --use-new-generator -o ./docs ``` **Passing parameters to templates:** ```bash -asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o ./docs -p title='Hello from param' +asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@3.0.0 --use-new-generator -o ./docs -p title='Hello from param' ``` In the template you can use it like this: ` {{ params.title }}` **Disabling the hooks:** ```bash -asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o ./docs -d generate:before generate:after=foo,bar +asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@3.0.0 --use-new-generator -o ./docs -d generate:before generate:after=foo,bar ``` The generator skips all hooks of the `generate:before` type and `foo`, `bar` hooks of the `generate:after` type. @@ -101,7 +101,7 @@ asyncapi generate fromTemplate asyncapi.yaml https://github.com/asyncapi/html-te **Map schema references from baseUrl to local folder:** ```bash -asyncapi generate fromTemplate test/docs/apiwithref.json @asyncapi/html-template -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/ +asyncapi generate fromTemplate test/docs/apiwithref.json @asyncapi/html-template@3.0.0 --use-new-generator -o ./build/ --force-write --map-base-url https://schema.example.com/crm/:./test/docs/ ``` The parameter `--map-base-url` maps external schema references to local folders. @@ -122,7 +122,7 @@ asyncapi/cli [COMMAND HERE] docker run --rm -it \ -v ${PWD}/test/fixtures/asyncapi_v1.yml:/app/asyncapi.yml \ -v ${PWD}/output:/app/output \ - asyncapi/cli generate fromTemplate -o /app/output /app/asyncapi.yml @asyncapi/html-template --force-write + asyncapi/cli generate fromTemplate -o /app/output /app/asyncapi.yml @asyncapi/html-template@3.0.0 --use-new-generator --force-write ``` Note: Use ``` ` ``` instead of `\` for Windows. @@ -133,7 +133,7 @@ Note: Use ``` ` ``` instead of `\` for Windows. Use the following npx command on your terminal: ```bash -npx -p @asyncapi/cli asyncapi generate fromTemplate ./asyncapi.yaml @asyncapi/html-template +npx -p @asyncapi/cli asyncapi generate fromTemplate ./asyncapi.yaml @asyncapi/html-template@3.0.0 --use-new-generator ``` ## Using as a module/package @@ -154,4 +154,4 @@ try { } ``` -See the [API documentation](api) for more examples and full API reference information. \ No newline at end of file +See the [API documentation](api) for more examples and full API reference information.