Skip to content

Commit 8a20303

Browse files
Mike BrocchiMike Brocchi
authored andcommitted
chore: move the new wiki docs to main repo
This move will allow other devs to contribute and allow for pull requests and reviews against docs changes.
1 parent 5b2a0fb commit 8a20303

File tree

18 files changed

+360
-0
lines changed

18 files changed

+360
-0
lines changed

docs/documentation/build.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# ng build
2+
3+
## Overview
4+
`ng build` compiles the application into an output directory
5+
6+
## Options
7+
`--target` (`-t`, `-dev`, `prod`) define the build target
8+
9+
`--environment` (`-e`)
10+
11+
`--output-path` (`-o`) path where output will be placed
12+
13+
`--watch` (`-w`) flag to run builds when files change
14+
15+
`--surpress-sizes` flag to suppress sizes from build output
16+
17+
`--base-href` (`-bh`) base url for the application being built
18+
19+
`--aot` flag whether to build using Ahead of Time compilation

docs/documentation/config.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
`ng get`
2+
`ng set`

docs/documentation/doc.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# ng doc
2+
3+
## Overview
4+
`ng doc [search term]` searches documentation on [angular.io](https://angular.io)

docs/documentation/e2e.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# ng e2e
2+
3+
## Overview
4+
`ng e2e` executes end-to-end tests

docs/documentation/generate.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ng generate
2+
3+
## Overview
4+
`ng generate [name]` generates the specified blueprint
5+
6+
## Available blueprints:
7+
- [class](class)
8+
- [component](component)
9+
- [directive](directive)
10+
- [enum](enum)
11+
- [interface](interface)
12+
- [module](module)
13+
- [pipe](pipe)
14+
- [service](service)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ng generate class
2+
3+
## Overview
4+
`ng generate class [name]` generates a class
5+
6+
## Options
7+
`--spec` specifies if a spec file is generated
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# ng generate component
2+
3+
## Overview
4+
`ng generate component [name]` generates a component
5+
6+
## Options
7+
`--flat` flag to indicate if a dir is created
8+
9+
`--inline-template` (`-it`) specifies if the template will be in the ts file
10+
11+
`--inline-style` (`-is`) specifies if the style will be in the ts file
12+
13+
`--prefix` specifies whether to use the prefix
14+
15+
`--spec` specifies if a spec file is generated
16+
17+
`--view-encapsulation` (`-ve`) set the view encapsulation strategy
18+
19+
`--change-detection` (`-cd`) set the change detection strategy
20+
21+
`--skip-import` allows for skipping the module import
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ng generate directive
2+
3+
## Overview
4+
`ng generate directive [name]` generates a directive
5+
6+
## Options
7+
`--flat` flag to indicate if a dir is created
8+
9+
`--prefix` specifies whether to use the prefix
10+
11+
`--spec` specifies if a spec file is generated
12+
13+
`--skip-import` allows for skipping the module import
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# ng generate enum
2+
3+
## Overview
4+
`ng generate enum [name]` generates an enumeration
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ng generate interface
2+
3+
## Overview
4+
`ng generate interface [name] <type>` generates an interface
5+
6+
## Arguments
7+
8+
`type` optional string to specify the type of interface

0 commit comments

Comments
 (0)