docs(angular): add downgrade module docs (#12495)

This commit is contained in:
Colum Ferry 2022-10-10 16:40:54 +01:00 committed by GitHub
parent 7f9185efa0
commit c697767b0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 1 deletions

View File

@ -635,6 +635,7 @@
},
"additionalProperties": false,
"required": ["name", "project"],
"examplesFile": "## Examples\n\nBelow are some examples of how to generate configuration and setup for using `ngUpgrade`'s `DowngradeModule` for your application.\n\n{% tabs %}\n\n{% tab label=\"Basic Usage\" %}\n\n```bash\nnx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp\n```\n\n{% /tab %}\n\n{% tab label=\"Setup Router\" %}\n\nAllow a setup that configures routing for `DowngradeModule`.\n\n```bash\nnx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp --router=true\n```\n\n{% /tab %}\n\n{% /tabs %}\n",
"presets": []
},
"description": "Sets up a Downgrade Module.",

View File

@ -0,0 +1,25 @@
## Examples
Below are some examples of how to generate configuration and setup for using `ngUpgrade`'s `DowngradeModule` for your application.
{% tabs %}
{% tab label="Basic Usage" %}
```bash
nx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp
```
{% /tab %}
{% tab label="Setup Router" %}
Allow a setup that configures routing for `DowngradeModule`.
```bash
nx g @nrwl/angular:downgrade-module --name=myAngularJsModule --project=myapp --router=true
```
{% /tab %}
{% /tabs %}

View File

@ -34,5 +34,6 @@
}
},
"additionalProperties": false,
"required": ["name", "project"]
"required": ["name", "project"],
"examplesFile": "../../../docs/downgrade-module-examples.md"
}