From eabcb96db014502c7c38e1d1296bee6c7252cb6b Mon Sep 17 00:00:00 2001 From: Victor Savkin Date: Tue, 26 Feb 2019 10:26:27 -0500 Subject: [PATCH] feat(nx): update docs --- docs/api-schematics/ng-new.md | 3 ++- docs/api-schematics/workspace.md | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/api-schematics/workspace.md diff --git a/docs/api-schematics/ng-new.md b/docs/api-schematics/ng-new.md index c2dd6559b9..3a110b3a10 100644 --- a/docs/api-schematics/ng-new.md +++ b/docs/api-schematics/ng-new.md @@ -1,6 +1,6 @@ # ng-new -Create an empty workspace +Create a workspace ## Usage @@ -20,3 +20,4 @@ ng generate ng-new ... | `skipInstall` | | Skip installing dependency packages. | boolean | `false` | | `skipGit` | g | Skip initializing a git repository. | boolean | `false` | | `commit` | | Initial repository commit information. | boolean | `true` | +| `preset` | | What to create in the new workspace | string | `empty` | diff --git a/docs/api-schematics/workspace.md b/docs/api-schematics/workspace.md new file mode 100644 index 0000000000..cb61812898 --- /dev/null +++ b/docs/api-schematics/workspace.md @@ -0,0 +1,22 @@ +# workspace [hidden] + +Create an empty workspace + +## Usage + +```bash +ng generate workspace ... + +``` + +### Options + +| Name | Alias | Description | Type | Default value | +| ------------- | ----- | ---------------------------------------------- | ------- | ------------- | +| `name` | | The name of the workspace. | string | `undefined` | +| `style` | | The file extension to be used for style files. | string | `css` | +| `directory` | | The directory name to create the workspace in. | string | `` | +| `npmScope` | | Npm scope for importing libs. | string | `undefined` | +| `skipInstall` | | Skip installing dependency packages. | boolean | `false` | +| `skipGit` | g | Skip initializing a git repository. | boolean | `false` | +| `commit` | | Initial repository commit information. | boolean | `true` |