diff --git a/pages/docs/tools/generator/api.md b/pages/docs/tools/generator/api.md index 1e53742b7cd1..d0ffba142d41 100644 --- a/pages/docs/tools/generator/api.md +++ b/pages/docs/tools/generator/api.md @@ -342,3 +342,20 @@ const content = await Generator.getTemplateFile('@asyncapi/html-template', 'part const Generator = require('@asyncapi/generator'); const content = await Generator.getTemplateFile('@asyncapi/html-template', 'partials/content.html', '~/my-templates'); ``` + +--- + + diff --git a/pages/docs/tools/generator/asyncapi-document.md b/pages/docs/tools/generator/asyncapi-document.md index 8e487ab74e2c..b845370ca157 100644 --- a/pages/docs/tools/generator/asyncapi-document.md +++ b/pages/docs/tools/generator/asyncapi-document.md @@ -85,3 +85,20 @@ In the sample code snippet below, notice how you can access the contents of the ``` > To learn about the various instances you can use to access the documents' content, look at the API of the AsyncAPI JavaScript Parser and the structure of [AsyncAPIDocument](https://github.com/asyncapi/parser-js/blob/master/API.md#module_@asyncapi/parser+AsyncAPIDocument) + +--- + + diff --git a/pages/docs/tools/generator/configuration-file.md b/pages/docs/tools/generator/configuration-file.md index 37650fef5c70..bf3195cc9617 100644 --- a/pages/docs/tools/generator/configuration-file.md +++ b/pages/docs/tools/generator/configuration-file.md @@ -75,4 +75,20 @@ There are some template parameters that have a special meaning: |---|---| |`server`| It is used to let the template know which server from the AsyncAPI specification file you want to use. In some cases, this may be required. For instance, when generating code that connects to a specific server. Use this parameter in case your template relies on users' information about what server from the specification file they want to use during generation. You also need this parameter if you want to use `server.protocol` notation within `conditionalFiles` configuration option. Once you decide to specify this parameter for your template, it is recommended you make it a mandatory parameter otherwise a feature like `conditionalFiles` is not going to work if your users do not use this parameter obligatory. +--- + + diff --git a/pages/docs/tools/generator/file-templates.md b/pages/docs/tools/generator/file-templates.md index d84c7d3a37a4..483eb197ca81 100644 --- a/pages/docs/tools/generator/file-templates.md +++ b/pages/docs/tools/generator/file-templates.md @@ -64,4 +64,21 @@ export default function({ asyncapi }) { Content ] } -``` \ No newline at end of file +``` + +--- + + diff --git a/pages/docs/tools/generator/hooks.md b/pages/docs/tools/generator/hooks.md index 5d294a1c01a7..222eabfa7992 100644 --- a/pages/docs/tools/generator/hooks.md +++ b/pages/docs/tools/generator/hooks.md @@ -78,4 +78,21 @@ module.exports = { return currentFilename.replace('-', '_') }; }; -``` \ No newline at end of file +``` + +--- + + diff --git a/pages/docs/tools/generator/index.md b/pages/docs/tools/generator/index.md index 2789cc747875..d4c8c69bc199 100644 --- a/pages/docs/tools/generator/index.md +++ b/pages/docs/tools/generator/index.md @@ -50,4 +50,21 @@ graph LR D --> J[Java Spring Boot] D --> K[Anything else] ``` -**`params`** are template-specific options passed to the `asyncapi generate fromTemplate` CLI command to customize the generated output. \ No newline at end of file +**`params`** are template-specific options passed to the `asyncapi generate fromTemplate` CLI command to customize the generated output. + +--- + + diff --git a/pages/docs/tools/generator/installation-guide.md b/pages/docs/tools/generator/installation-guide.md index 69e81b53ff43..48ba6b7c8645 100644 --- a/pages/docs/tools/generator/installation-guide.md +++ b/pages/docs/tools/generator/installation-guide.md @@ -79,3 +79,20 @@ npm uninstall @asyncapi/cli -g Use the generator library in your Node.js projects by installing it via the following command: `npm install @asyncapi/generator`. > Don't include the `-g` flag in the installation command above since you're not installing the generator library globally but in your Node.js project. + +--- + + diff --git a/pages/docs/tools/generator/nunjucks-render-engine.md b/pages/docs/tools/generator/nunjucks-render-engine.md index 727cd2121883..ddbf5b020410 100644 --- a/pages/docs/tools/generator/nunjucks-render-engine.md +++ b/pages/docs/tools/generator/nunjucks-render-engine.md @@ -75,4 +75,20 @@ async function asyncCamelCase(str, callback) { In case you have more than one template and want to reuse filters, you can put them in a single library. You can configure such a library in the template configuration under `filters` property. You can also use the official AsyncAPI [filters library](https://github.com/asyncapi/generator-filters). To learn how to add such filters to configuration [read more about the configuration file](#configuration-file). +--- + + diff --git a/pages/docs/tools/generator/parser.md b/pages/docs/tools/generator/parser.md index 2ff57070adeb..7f5075585ca9 100644 --- a/pages/docs/tools/generator/parser.md +++ b/pages/docs/tools/generator/parser.md @@ -94,3 +94,19 @@ graph TD > To learn more about the Parser and access all of its features, check out the AsyncAPI [Parser’s GitHub repository](https://github.com/asyncapi/parser-js). +--- + + diff --git a/pages/docs/tools/generator/react-render-engine.md b/pages/docs/tools/generator/react-render-engine.md index b985bee7f380..5ffbf49d92ab 100644 --- a/pages/docs/tools/generator/react-render-engine.md +++ b/pages/docs/tools/generator/react-render-engine.md @@ -77,4 +77,21 @@ With React, it enables you to debug your templates. For Visual Studio Code, we h Now replace `./asyncapi.yml` with your document of choice. Replace `./template` with the path to your React template. You can now debug your template by adding any breakpoints you want and inspect your code. +--- + + + diff --git a/pages/docs/tools/generator/template-context.md b/pages/docs/tools/generator/template-context.md index b8f5c93409f9..38a8b1f5d63a 100644 --- a/pages/docs/tools/generator/template-context.md +++ b/pages/docs/tools/generator/template-context.md @@ -38,4 +38,21 @@ The extra context passed to the render engine during the generation process and - **`originalAsyncAPI`** is a stringified version of the original AsyncAPI document that the user passed to the Generator. - **`asyncapi`** is a parsed AsyncAPI document with helper functions and properties. You should use it to access document contents e.g `asyncapi.title`. -- **`params`** is an object with all the parameters passed to the Generator by the user. \ No newline at end of file +- **`params`** is an object with all the parameters passed to the Generator by the user. + +--- + + diff --git a/pages/docs/tools/generator/template-development.md b/pages/docs/tools/generator/template-development.md index 28d921526b38..1711a67089a6 100644 --- a/pages/docs/tools/generator/template-development.md +++ b/pages/docs/tools/generator/template-development.md @@ -151,3 +151,20 @@ The updated template looks like the following: App name: **{ asyncapi.info().title() }** Version: **{asyncapi.info.version()}** ``` + +--- + + diff --git a/pages/docs/tools/generator/template.md b/pages/docs/tools/generator/template.md index a08688e78ae0..77ed84b66b30 100644 --- a/pages/docs/tools/generator/template.md +++ b/pages/docs/tools/generator/template.md @@ -71,3 +71,20 @@ Template Name | Description | Source code > Check out all our community [generator templates](https://github.com/search?q=topic%3Aasyncapi+topic%3Agenerator+topic%3Atemplate) +--- + + + diff --git a/pages/docs/tools/generator/typescript-support.md b/pages/docs/tools/generator/typescript-support.md index 5c785cd3ca2c..ff850f02101d 100644 --- a/pages/docs/tools/generator/typescript-support.md +++ b/pages/docs/tools/generator/typescript-support.md @@ -10,4 +10,20 @@ The AsyncAPI generator has TypeScript support for [hooks](#hooks) and Nunjucks's - Each package related to the typings for TypeScript like `@types/node` must be installed in the template under `dependencies` array. This is because the Generator transpiles the TypeScript code on-the-fly while rendering the template, and cannot use packages under `devDependencies`. - Each template should have `@types/node` package installed to enable support for typings for Node. +--- + + diff --git a/pages/docs/tools/generator/usage.md b/pages/docs/tools/generator/usage.md index 3315bf0fcaac..cb86bb431514 100644 --- a/pages/docs/tools/generator/usage.md +++ b/pages/docs/tools/generator/usage.md @@ -148,4 +148,21 @@ try { } ``` -See the [API documentation](api.md) for more examples and full API reference information. \ No newline at end of file +See the [API documentation](api.md) for more examples and full API reference information. + +--- + + diff --git a/pages/docs/tools/generator/versioning.md b/pages/docs/tools/generator/versioning.md index 6c31eb3930a0..d38419b43f6e 100644 --- a/pages/docs/tools/generator/versioning.md +++ b/pages/docs/tools/generator/versioning.md @@ -28,4 +28,21 @@ npm install -g @asyncapi/cli@0.20.0 asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template@0.7.0 -o ./docs ``` -> Before using newer versions of the template, always look at the [changelog](https://github.com/asyncapi/html-template/releases) first. If the generator's features are not important to you, just make sure to use a version compatible with your template. \ No newline at end of file +> Before using newer versions of the template, always look at the [changelog](https://github.com/asyncapi/html-template/releases) first. If the generator's features are not important to you, just make sure to use a version compatible with your template. + +--- + + diff --git a/pages/docs/tools/index.md b/pages/docs/tools/index.md index 1cdad63aeaf3..b7ce01ead964 100644 --- a/pages/docs/tools/index.md +++ b/pages/docs/tools/index.md @@ -174,8 +174,8 @@ The following is a list of tools that compare AsyncAPI documents. type:'back', }, { - href: '/docs/guides', - title: 'Guides - Overview', + href: '/docs/tools/generator/', + title: 'Generator', type:'next', } ]}