docs(*): blank lines before lists are good (#3474)
This commit is contained in:
parent
22918b40b5
commit
93d3db1fd4
|
@ -7,6 +7,7 @@ include ../_util-fns
|
||||||
a#toc
|
a#toc
|
||||||
:marked
|
:marked
|
||||||
# Contents
|
# Contents
|
||||||
|
|
||||||
- [Overview](overview)
|
- [Overview](overview)
|
||||||
- [Ahead-of-time (AOT) vs just-in-time (JIT)](#aot-jit)
|
- [Ahead-of-time (AOT) vs just-in-time (JIT)](#aot-jit)
|
||||||
- [Why do AOT compilation?](#why-aot)
|
- [Why do AOT compilation?](#why-aot)
|
||||||
|
|
|
@ -23,6 +23,7 @@ include ../_util-fns
|
||||||
[Inject the component's DOM element](#component-element)
|
[Inject the component's DOM element](#component-element)
|
||||||
|
|
||||||
[Define dependencies with providers](#providers)
|
[Define dependencies with providers](#providers)
|
||||||
|
|
||||||
* [The *provide* object literal](#provide)
|
* [The *provide* object literal](#provide)
|
||||||
* [useValue - the *value provider*](#usevalue)
|
* [useValue - the *value provider*](#usevalue)
|
||||||
* [useClass - the *class provider*](#useclass)
|
* [useClass - the *class provider*](#useclass)
|
||||||
|
@ -30,12 +31,14 @@ include ../_util-fns
|
||||||
* [useFactory - the *factory provider*](#usefactory)
|
* [useFactory - the *factory provider*](#usefactory)
|
||||||
|
|
||||||
[Provider token alternatives](#tokens)
|
[Provider token alternatives](#tokens)
|
||||||
|
|
||||||
* [class-interface](#class-interface)
|
* [class-interface](#class-interface)
|
||||||
* [OpaqueToken](#opaque-token)
|
* [OpaqueToken](#opaque-token)
|
||||||
|
|
||||||
[Inject into a derived class](#di-inheritance)
|
[Inject into a derived class](#di-inheritance)
|
||||||
|
|
||||||
[Find a parent component by injection](#find-parent)
|
[Find a parent component by injection](#find-parent)
|
||||||
|
|
||||||
* [Find parent with a known component type](#known-parent)
|
* [Find parent with a known component type](#known-parent)
|
||||||
* [Cannot find a parent by its base class](#base-parent)
|
* [Cannot find a parent by its base class](#base-parent)
|
||||||
* [Find a parent by its class-interface](#class-interface-parent)
|
* [Find a parent by its class-interface](#class-interface-parent)
|
||||||
|
|
|
@ -14,6 +14,7 @@ block includes
|
||||||
|
|
||||||
:marked
|
:marked
|
||||||
Declarations
|
Declarations
|
||||||
|
|
||||||
* [What classes should I add to _declarations_?](#q-what-to-declare)
|
* [What classes should I add to _declarations_?](#q-what-to-declare)
|
||||||
* [What is a _declarable_?](#q-declarable)
|
* [What is a _declarable_?](#q-declarable)
|
||||||
* [What classes should I _not_ add to _declarations_?](#q-what-not-to-declare)
|
* [What classes should I _not_ add to _declarations_?](#q-what-not-to-declare)
|
||||||
|
@ -21,17 +22,20 @@ block includes
|
||||||
* [What does "Can't bind to 'x' since it isn't a known property of 'y'" mean?](#q-why-cant-bind-to)
|
* [What does "Can't bind to 'x' since it isn't a known property of 'y'" mean?](#q-why-cant-bind-to)
|
||||||
|
|
||||||
Imports
|
Imports
|
||||||
|
|
||||||
* [What should I import?](#q-what-to-import)
|
* [What should I import?](#q-what-to-import)
|
||||||
* [Should I import _BrowserModule_ or _CommonModule_?](#q-browser-vs-common-module)
|
* [Should I import _BrowserModule_ or _CommonModule_?](#q-browser-vs-common-module)
|
||||||
* [What if I import the same module twice?](#q-reimport)
|
* [What if I import the same module twice?](#q-reimport)
|
||||||
|
|
||||||
Exports
|
Exports
|
||||||
|
|
||||||
* [What should I export?](#q-what-to-export)
|
* [What should I export?](#q-what-to-export)
|
||||||
* [What should I *not* export?](#q-what-not-to-export)
|
* [What should I *not* export?](#q-what-not-to-export)
|
||||||
* [Can I re-export imported classes and modules?](#q-re-export)
|
* [Can I re-export imported classes and modules?](#q-re-export)
|
||||||
* [What is the _forRoot_ method?](#q-for-root)
|
* [What is the _forRoot_ method?](#q-for-root)
|
||||||
|
|
||||||
Service Providers
|
Service Providers
|
||||||
|
|
||||||
* [Why is a service provided in a feature module visible everywhere?](#q-module-provider-visibility)
|
* [Why is a service provided in a feature module visible everywhere?](#q-module-provider-visibility)
|
||||||
* [Why is a service provided in a _lazy-loaded_ module visible only to that module?](#q-lazy-loaded-module-provider-visibility)
|
* [Why is a service provided in a _lazy-loaded_ module visible only to that module?](#q-lazy-loaded-module-provider-visibility)
|
||||||
* [What if two modules provide the same service?](#q-module-provider-duplicates)
|
* [What if two modules provide the same service?](#q-module-provider-duplicates)
|
||||||
|
@ -43,12 +47,14 @@ block includes
|
||||||
* [How can I tell if a module or service was previously loaded?](#q-is-it-loaded)
|
* [How can I tell if a module or service was previously loaded?](#q-is-it-loaded)
|
||||||
|
|
||||||
Entry Components
|
Entry Components
|
||||||
|
|
||||||
* [What is an _entry component_?](#q-entry-component-defined)
|
* [What is an _entry component_?](#q-entry-component-defined)
|
||||||
* [What is the difference between a _bootstrap_ component and an _entry component_?](#q-bootstrap_vs_entry_component)
|
* [What is the difference between a _bootstrap_ component and an _entry component_?](#q-bootstrap_vs_entry_component)
|
||||||
* [When do I add components to _entryComponents_?](#q-when-entry-components)
|
* [When do I add components to _entryComponents_?](#q-when-entry-components)
|
||||||
* [Why does Angular need _entryComponents_?](#q-why-entry-components)
|
* [Why does Angular need _entryComponents_?](#q-why-entry-components)
|
||||||
|
|
||||||
General
|
General
|
||||||
|
|
||||||
* [What kinds of modules should I have and how should I use them?](#q-module-recommendations)
|
* [What kinds of modules should I have and how should I use them?](#q-module-recommendations)
|
||||||
* [What's the difference between Angular and JavaScript Modules?](#q-ng-vs-js-modules)
|
* [What's the difference between Angular and JavaScript Modules?](#q-ng-vs-js-modules)
|
||||||
* [How does Angular find components, directives, and pipes in a template?](#q-template-reference)
|
* [How does Angular find components, directives, and pipes in a template?](#q-template-reference)
|
||||||
|
|
|
@ -15,16 +15,16 @@ a#toc
|
||||||
:marked
|
:marked
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
[_TypeScript_ to _ES6_ to _ES5_](#from-ts)<br>
|
* [_TypeScript_ to _ES6_ to _ES5_](#from-ts)<br>
|
||||||
[Modularity: imports and exports](#modularity)<br>
|
* [Modularity: imports and exports](#modularity)<br>
|
||||||
[Classes and Class Metadata](#class-metadata)<br>
|
* [Classes and Class Metadata](#class-metadata)<br>
|
||||||
[_ES5_ DSL](#dsl)<br>
|
* [_ES5_ DSL](#dsl)<br>
|
||||||
[Interfaces](#interfaces)<br>
|
* [Interfaces](#interfaces)<br>
|
||||||
[Input and Output Metadata](#io-decorators)<br>
|
* [Input and Output Metadata](#io-decorators)<br>
|
||||||
[Dependency Injection](#dependency-injection)<br>
|
* [Dependency Injection](#dependency-injection)<br>
|
||||||
[Host Binding](#host-binding)<br>
|
* [Host Binding](#host-binding)<br>
|
||||||
[View and Child Decorators](#view-child-decorators)<br>
|
* [View and Child Decorators](#view-child-decorators)<br>
|
||||||
[AOT compilation in _TypeScript_ Only](#aot)<br>
|
* [AOT compilation in _TypeScript_ Only](#aot)<br>
|
||||||
|
|
||||||
**Run and compare the live <live-example name="cb-ts-to-js">_TypeScript_</live-example> and <live-example name="cb-ts-to-js" lang="js">JavaScript</live-example>
|
**Run and compare the live <live-example name="cb-ts-to-js">_TypeScript_</live-example> and <live-example name="cb-ts-to-js" lang="js">JavaScript</live-example>
|
||||||
code shown in this cookbook.**
|
code shown in this cookbook.**
|
||||||
|
|
|
@ -12,6 +12,7 @@ block includes
|
||||||
and [how to use it](#angular-di) in an Angular app.
|
and [how to use it](#angular-di) in an Angular app.
|
||||||
:marked
|
:marked
|
||||||
# Contents
|
# Contents
|
||||||
|
|
||||||
- [Why dependency injection?](#why-di)
|
- [Why dependency injection?](#why-di)
|
||||||
- [Angular dependency injection](#angular-dependency-injection)
|
- [Angular dependency injection](#angular-dependency-injection)
|
||||||
- [Configuring the injector](#injector-config)
|
- [Configuring the injector](#injector-config)
|
||||||
|
|
|
@ -6,6 +6,7 @@ include ../_util-fns
|
||||||
a#toc
|
a#toc
|
||||||
:marked
|
:marked
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
* [Overview](#overview)
|
* [Overview](#overview)
|
||||||
* [Simplest deployment possible](#dev-deploy)
|
* [Simplest deployment possible](#dev-deploy)
|
||||||
* [Optimize for production](#optimize)
|
* [Optimize for production](#optimize)
|
||||||
|
|
|
@ -20,6 +20,7 @@ figure
|
||||||
+ifDocsFor('ts|js')
|
+ifDocsFor('ts|js')
|
||||||
:marked
|
:marked
|
||||||
## Contents
|
## Contents
|
||||||
|
|
||||||
* [Component lifecycle hooks overview](#hooks-overview)
|
* [Component lifecycle hooks overview](#hooks-overview)
|
||||||
* [Lifecycle sequence](#hooks-purpose-timing)
|
* [Lifecycle sequence](#hooks-purpose-timing)
|
||||||
* [Interfaces are optional (technically)](#interface-optional)
|
* [Interfaces are optional (technically)](#interface-optional)
|
||||||
|
|
|
@ -23,12 +23,14 @@ block includes
|
||||||
This page covers NgModules in greater depth.
|
This page covers NgModules in greater depth.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
<!-- CF: The titling for tables of contents in the advanced chapters is inconsistent:
|
<!-- CF: The titling for tables of contents in the advanced chapters is inconsistent:
|
||||||
- some are titled "Contents" while others are titled "Table of Contents" (should probably be sentence case as it's an H2
|
- some are titled "Contents" while others are titled "Table of Contents" (should probably be sentence case as it's an H2
|
||||||
- some headings are H2, some are H3
|
- some headings are H2, some are H3
|
||||||
- some pages don't have tables of contents
|
- some pages don't have tables of contents
|
||||||
I didn't make changes here as I'm not sure what the correct style is.
|
I didn't make changes here as I'm not sure what the correct style is.
|
||||||
-->
|
-->
|
||||||
|
|
||||||
* [Angular modularity](#angular-modularity "Add structure to the app with NgModule")
|
* [Angular modularity](#angular-modularity "Add structure to the app with NgModule")
|
||||||
* [The application root module](#root-module "The startup module that every app requires")
|
* [The application root module](#root-module "The startup module that every app requires")
|
||||||
* [Bootstrap](#bootstrap "Launch the app in a browser with the root module as the entry point") the root module
|
* [Bootstrap](#bootstrap "Launch the app in a browser with the root module as the entry point") the root module
|
||||||
|
|
|
@ -18,6 +18,7 @@ block includes
|
||||||
|
|
||||||
The !{_Angular_http_library} simplifies application programming with the **XHR** and **JSONP** APIs.
|
The !{_Angular_http_library} simplifies application programming with the **XHR** and **JSONP** APIs.
|
||||||
# Contents
|
# Contents
|
||||||
|
|
||||||
* [Demos](#demos)
|
* [Demos](#demos)
|
||||||
* [Providing HTTP Services](#http-providers)
|
* [Providing HTTP Services](#http-providers)
|
||||||
* [The Tour of Heroes *HTTP* client demo](#http-client)
|
* [The Tour of Heroes *HTTP* client demo](#http-client)
|
||||||
|
|
|
@ -14,6 +14,7 @@ block includes
|
||||||
a#top
|
a#top
|
||||||
:marked
|
:marked
|
||||||
# Contents
|
# Contents
|
||||||
|
|
||||||
* [Live examples](#live-examples "Live examples of the tests in this guide")
|
* [Live examples](#live-examples "Live examples of the tests in this guide")
|
||||||
<br><br>
|
<br><br>
|
||||||
* [Introduction to Angular testing](#testing-intro)
|
* [Introduction to Angular testing](#testing-intro)
|
||||||
|
|
Loading…
Reference in New Issue