diff --git a/.changeset/depreciate-nunjucks.md b/.changeset/depreciate-nunjucks.md index 257bc9685..defb5e224 100644 --- a/.changeset/depreciate-nunjucks.md +++ b/.changeset/depreciate-nunjucks.md @@ -2,4 +2,4 @@ "@asyncapi/generator": major --- -Migration guide for nunjucks render engine to react render engine \ No newline at end of file +Migrating from Nunjucks render engine to React render engine \ No newline at end of file diff --git a/README.md b/README.md index 79eaa1cae..11745b47b 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This is a Monorepo managed using [Turborepo](https://turbo.build/) and contains ![npm](https://img.shields.io/npm/v/@asyncapi/generator?style=for-the-badge) ![npm](https://img.shields.io/npm/dt/@asyncapi/generator?style=for-the-badge) [!IMPORTANT] -Deprecation Notice: The nunjucks renderer engine is depreciated and will be removed in the future releases.We strongly recommend using the react renderer engine instead, you can find how to migrate from nunjucks to react in the [migration guide](apps/generator/docs/nunjucks-depreciate.md) +Deprecation Notice: The Nunjucks renderer engine is deprecated and will be removed in future releases. We strongly recommend using the React renderer engine instead, you can find how to migrate from Nunjucks to React in the [migration guide](apps/generator/docs/nunjucks-depreciate.md) diff --git a/apps/generator/docs/file-templates.md b/apps/generator/docs/file-templates.md index a9ac23c27..3bdda56af 100644 --- a/apps/generator/docs/file-templates.md +++ b/apps/generator/docs/file-templates.md @@ -5,9 +5,9 @@ weight: 140 ## Generating files with the Nunjucks render engine -> **Note**: This section applies only to the Nunjucks render engine. For information on using the React render engine, refer to the [Generating files with the React render engine](#generating-files-with-the-react-render-engine) section below. +> **Note**: This section applies only to the Nunjucks render engine. For information on using the React render engine, please look at the [Generating files with the React render engine](#generating-files-with-the-react-render-engine) section below. -> **Note**: Nunjucks renderer engine will be depreciated in the future release and we strongly recommend using the react renderer engine instead. +> **Note**: Nunjucks renderer engine will be deprecated in the future release and we strongly recommend using the React renderer engine instead. It is possible to generate files for each specific object in your AsyncAPI documentation using the Nunjucks render engine. For example, you can specify a filename like `$$channel$$.js` to generate a file for each channel defined in your AsyncAPI. The following file-template names and extra variables are available: diff --git a/apps/generator/docs/nunjucks-depreciate.md b/apps/generator/docs/nunjucks-depreciate.md index 7c3f77fc6..8c932c018 100644 --- a/apps/generator/docs/nunjucks-depreciate.md +++ b/apps/generator/docs/nunjucks-depreciate.md @@ -1,5 +1,5 @@ -- -title: "Migration guide from nunjucks render engine" +title: "Migrating from Nunjucks to React render engine" weight: 170 --- @@ -23,7 +23,7 @@ Change your template configuration in `package.json`: } ``` -Once deprecation period is ended, and we remove default nunjucks engine, react will become default and this setting will no longer be needed to configure +Once the deprecation period has ended, and we remove the default Nunjucks, the React render engine will be used by default and this setting will no longer be needed to configure #### 2. Install dependencies