Skip to content

Commit

Permalink
docs(nxdev): better api generator templates (nrwl#8109)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcabanes authored Dec 10, 2021
1 parent 3fa5385 commit ea0d65b
Show file tree
Hide file tree
Showing 865 changed files with 4,356 additions and 24 deletions.
5 changes: 5 additions & 0 deletions docs/angular/api-angular/executors/delegate-build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:delegate-build executor'
description: 'Delegates the build to a different target while supporting incremental builds.'
---

# @nrwl/angular:delegate-build

Delegates the build to a different target while supporting incremental builds.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/executors/ng-packagr-lite.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:ng-packagr-lite executor'
description: 'Builds a library with support for incremental builds.'
---

# @nrwl/angular:ng-packagr-lite

Builds a library with support for incremental builds.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/executors/package.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:package executor'
description: 'Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.'
---

# @nrwl/angular:package

Builds and packages an Angular library to be distributed as an NPM package. It supports incremental builds.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/executors/webpack-browser.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:webpack-browser executor'
description: 'Builds a browser application with support for incremental builds and custom webpack configuration.'
---

# @nrwl/angular:webpack-browser

Builds a browser application with support for incremental builds and custom webpack configuration.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/executors/webpack-server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:webpack-server executor'
description: 'Serves a browser application with support for a custom webpack configuration.'
---

# @nrwl/angular:webpack-server

Serves a browser application with support for a custom webpack configuration.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/application.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:application generator'
description: 'Creates an Angular application.'
---

# @nrwl/angular:application

Creates an Angular application.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:convert-tslint-to-eslint generator'
description: 'Converts a project from TSLint to ESLint.'
---

# @nrwl/angular:convert-tslint-to-eslint

Converts a project from TSLint to ESLint.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/downgrade-module.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:downgrade-module generator'
description: 'Sets up a Downgrade Module.'
---

# @nrwl/angular:downgrade-module

Sets up a Downgrade Module.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/karma-project.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:karma-project generator'
description: 'Adds Karma configuration to a project.'
---

# @nrwl/angular:karma-project

Adds Karma configuration to a project.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/karma.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:karma generator'
description: 'Adds Karma configuration to a workspace.'
---

# @nrwl/angular:karma

Adds Karma configuration to a workspace.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:library-secondary-entry-point generator'
description: 'Creates a secondary entry point for an Angular publishable library.'
---

# @nrwl/angular:library-secondary-entry-point

Creates a secondary entry point for an Angular publishable library.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/library.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:library generator'
description: 'Creates an Angular library.'
---

# @nrwl/angular:library

Creates an Angular library.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/move.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:move generator'
description: 'Moves an Angular application or library to another folder within the workspace and updates the project configuration.'
---

# @nrwl/angular:move

Moves an Angular application or library to another folder within the workspace and updates the project configuration.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/ngrx.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:ngrx generator'
description: 'Adds NgRx support to an application or library.'
---

# @nrwl/angular:ngrx

Adds NgRx support to an application or library.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/scam.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:scam generator'
description: 'Generate a component with an accompanying Single Component Angular Module (SCAM).'
---

# @nrwl/angular:scam

Generate a component with an accompanying Single Component Angular Module (SCAM).
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/setup-mfe.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:setup-mfe generator'
description: 'Generate a Module Federation configuration for a given Angular application.'
---

# @nrwl/angular:setup-mfe

Generate a Module Federation configuration for a given Angular application.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/stories.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:stories generator'
description: 'Creates stories/specs for all components declared in a project.'
---

# @nrwl/angular:stories

Creates stories/specs for all components declared in a project.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:storybook-configuration generator'
description: 'Adds Storybook configuration to a project.'
---

# @nrwl/angular:storybook-configuration

Adds Storybook configuration to a project.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:storybook-migrate-defaults-5-to-6 generator'
description: 'Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.'
---

# @nrwl/angular:storybook-migrate-defaults-5-to-6

Generates default Storybook configuration files using Storybook version >=6.x specs, for projects that already have Storybook instances and configurations of versions <6.x.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:storybook-migrate-stories-to-6-2 generator'
description: 'Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.'
---

# @nrwl/angular:storybook-migrate-stories-to-6-2

Migrates stories to match the new syntax in v6.2 where the component declaration should be in the default export.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/upgrade-module.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:upgrade-module generator'
description: 'Sets up an Upgrade Module.'
---

# @nrwl/angular:upgrade-module

Sets up an Upgrade Module.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-angular/generators/web-worker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/angular:web-worker generator'
description: 'Creates a Web Worker.'
---

# @nrwl/angular:web-worker

Creates a Web Worker.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-cypress/executors/cypress.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/cypress:cypress executor'
description: 'Run Cypress e2e tests'
---

# @nrwl/cypress:cypress

Run Cypress e2e tests
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-detox/executors/build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/detox:build executor'
description: 'Run the command defined in build property of the specified configuration.'
---

# @nrwl/detox:build

Run the command defined in build property of the specified configuration.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-detox/executors/test.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/detox:test executor'
description: 'Initiating your detox test suite.'
---

# @nrwl/detox:test

Initiating your detox test suite.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-detox/generators/application.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/detox:application generator'
description: 'Create a detox application'
---

# @nrwl/detox:application

Create a detox application
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-express/generators/application.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/express:application generator'
description: 'Create an express application'
---

# @nrwl/express:application

Create an express application
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-gatsby/executors/build.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:build executor'
description: 'Build a Gatsby app'
---

# @nrwl/gatsby:build

Build a Gatsby app
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-gatsby/executors/server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:server executor'
description: 'Starts server for app'
---

# @nrwl/gatsby:server

Starts server for app
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-gatsby/generators/application.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:application generator'
description: 'Create an application'
---

# @nrwl/gatsby:application

Create an application
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-gatsby/generators/component.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:component generator'
description: 'Create a component'
---

# @nrwl/gatsby:component

Create a component
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-gatsby/generators/page.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/gatsby:page generator'
description: 'Create a page'
---

# @nrwl/gatsby:page

Create a page
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-jest/executors/jest.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/jest:jest executor'
description: 'Run Jest unit tests'
---

# @nrwl/jest:jest

Run Jest unit tests
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-js/executors/tsc.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/js:tsc executor'
description: 'Build a project using TypeScript.'
---

# @nrwl/js:tsc

Build a project using TypeScript.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-js/generators/application.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/js:application generator'
description: 'Create a application'
---

# @nrwl/js:application

Create a application
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-js/generators/library.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/js:library generator'
description: 'Create a library'
---

# @nrwl/js:library

Create a library
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-linter/executors/eslint.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/linter:eslint executor'
description: 'Run ESLint on a project'
---

# @nrwl/linter:eslint

Run ESLint on a project
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-linter/executors/lint.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/linter:lint executor'
description: '**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0'
---

# @nrwl/linter:lint

**[DEPRECATED]**: Please use the eslint builder instead, an automated migration was provided in v10.3.0
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-linter/generators/workspace-rule.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/linter:workspace-rule generator'
description: 'Create a new workspace ESLint rule'
---

# @nrwl/linter:workspace-rule

Create a new workspace ESLint rule
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-nest/generators/application.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/nest:application generator'
description: 'Create a NestJS application.'
---

# @nrwl/nest:application

Create a NestJS application.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-nest/generators/class.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/nest:class generator'
description: 'Run the `class` NestJS generator with Nx project support.'
---

# @nrwl/nest:class

Run the `class` NestJS generator with Nx project support.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-nest/generators/controller.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/nest:controller generator'
description: 'Run the `controller` NestJS generator with Nx project support.'
---

# @nrwl/nest:controller

Run the `controller` NestJS generator with Nx project support.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-nest/generators/convert-tslint-to-eslint.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/nest:convert-tslint-to-eslint generator'
description: 'Convert a project from TSLint to ESLint.'
---

# @nrwl/nest:convert-tslint-to-eslint

Convert a project from TSLint to ESLint.
Expand Down
5 changes: 5 additions & 0 deletions docs/angular/api-nest/generators/decorator.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
title: '@nrwl/nest:decorator generator'
description: 'Run the `decorator` NestJS generator with Nx project support.'
---

# @nrwl/nest:decorator

Run the `decorator` NestJS generator with Nx project support.
Expand Down
Loading

0 comments on commit ea0d65b

Please sign in to comment.