@rxap/plugin-readme-generator (Nx/Ng Plugin)
A builder to generate readme files for libraries.
Installation
Add the plugin to your workspace:
ng add @rxap/plugin-readme-generator
Setup the package @rxap/plugin-readme-generator for the workspace.
Configure the builder @rxap/plugin-readme-generator for a project:
ng g @rxap/plugin-readme-generator:config [project]
Adds the @rxap/plugin-readme-generator builder to the specified project.
Schematics
config
Adds the @rxap/plugin-readme-generator builder to the specified project.
ng g @rxap/plugin-readme-generator:config
| Option | Type | Default | Description |
|---|---|---|---|
| project | string | The name of the project. | |
| type | string | library | Specify witch builder type should be added |
| overwrite | boolean | false | Whether to overwrite the readme handlebars file. |
| Required |
|---|
| project |
| type |
ng-add
Setup the package @rxap/plugin-readme-generator for the workspace.
ng g @rxap/plugin-readme-generator:ng-add
| Option | Type | Default | Description |
|---|---|---|---|
| project | string | Name of the project |
Builder
plugin
Readme generator for plugin libraries.
Builder name
@rxap/plugin-readme-generator:plugin
| Option | Type | Default | Description |
|---|
library
Readme generator for library libraries.
Builder name
@rxap/plugin-readme-generator:library
| Option | Type | Default | Description |
|---|