Skip to content

Commit 061e50f

Browse files
chalinkwalrath
authored andcommitted
docs: adjust page heading levels (angular#2813)
* docs: adjust page heading levels Only the page TOC should be at heading level 1. All other headings should start at level 2. This commit also removes duplicate headings, in continuation of angular#2796. (This fix is necessary to support an auto-TOC feature.)
1 parent 31e0101 commit 061e50f

13 files changed

+102
-110
lines changed

public/docs/ts/_cache/glossary.jade

-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ block includes
99
- var _decoratorLink = '<a href="#' + _decorator + '">' + _decorator + '</a>'
1010

1111
:marked
12-
# Angular 2 Glossary
13-
1412
Angular 2 has a vocabulary of its own.
1513
Most Angular 2 terms are everyday English words
1614
with a specific meaning within the Angular system.

public/docs/ts/_cache/guide/lifecycle-hooks.jade

+6-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@ block includes
33

44
- var top="vertical-align:top"
55

6+
figure
7+
img(src="/resources/images/devguide/lifecycle-hooks/hooks-in-sequence.png" alt="Us" align="left" style="width:200px; margin-left:-40px;margin-right:30px")
8+
69
:marked
7-
# Component Lifecycle
8-
A Component has a lifecycle managed by Angular itself. Angular creates it, renders it, creates and renders its children,
10+
A component has a lifecycle managed by Angular itself.
11+
12+
Angular creates it, renders it, creates and renders its children,
913
checks it when its data-bound properties change, and destroys it before removing it from the DOM.
1014

1115
Angular offers **component lifecycle hooks**

public/docs/ts/_cache/guide/server-communication.jade

+3-3
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ block includes
3838

3939
.l-main-section
4040
:marked
41-
# Demos
41+
## Demos
4242

4343
This chapter describes server communication with the help of the following demos
4444

@@ -139,7 +139,7 @@ figure.image-display
139139
a#oninit
140140
a#HeroListComponent
141141
:marked
142-
## The *HeroListComponent* class
142+
### The *HeroListComponent* class
143143
Here's the component class:
144144
+makeExample('server-communication/ts/app/toh/hero-list.component.ts','component', 'app/toh/hero-list.component.ts (class)')
145145
:marked
@@ -219,7 +219,7 @@ a#HeroService
219219

220220
.l-main-section
221221
:marked
222-
# RxJS Library
222+
## RxJS Library
223223
[RxJS](https://github.com/ReactiveX/RxJS) ("Reactive Extensions") is a 3rd party library, endorsed by Angular,
224224
that implements the [*asynchronous observable*](https://www.youtube.com/watch?v=UHI0AzD_WfY "Rob Wormald on observables") pattern.
225225

public/docs/ts/latest/cookbook/index.jade

-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
include ../_util-fns
22

33
:marked
4-
# Angular Cookbook
5-
64
The *Cookbook* offers answers to common implementation questions.
75

86
Each cookbook chapter is a collection of recipes focused on a particular Angular feature or application challenge

public/docs/ts/latest/cookbook/ngmodule-faq.jade

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ block includes
22
include ../_util-fns
33

44
:marked
5-
# FAQs
6-
75
**Angular Modules** help organize an application into cohesive blocks of functionality.
86

97
The [Angular Modules chapter](../guide/ngmodule.html) covers the concepts and takes you step by step

public/docs/ts/latest/glossary.jade

-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ block includes
99
- var _decoratorLink = '<a href="#' + _decorator + '">' + _decorator + '</a>'
1010

1111
:marked
12-
# Angular Glossary
13-
1412
Angular has a vocabulary of its own.
1513
Most Angular terms are everyday English words
1614
with a specific meaning within the Angular system.

public/docs/ts/latest/guide/browser-support.jade

+4-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ block includes
33
- var _at_angular = '@angular'
44

55
:marked
6-
# Browser support #
76
Angular supports most recent browsers. This includes the following specific versions:
87

98
table
@@ -61,7 +60,7 @@ table
6160
<a href="https://www.browserstack.com" target="_blank">Browserstack</a>.
6261

6362
:marked
64-
# Polyfills #
63+
## Polyfills #
6564
Angular is built on the latest standards of the web platform.
6665
Targeting such a wide range of browsers is challenging because they do not support all features of modern browsers.
6766

@@ -81,7 +80,7 @@ table
8180
Note that polyfills cannot magically transform an old, slow browser into a modern, fast one.
8281

8382
:marked
84-
## Mandatory polyfills ##
83+
### Mandatory polyfills ##
8584
These are the polyfills required to run an Angular application on each supported browser:
8685

8786
table
@@ -103,7 +102,7 @@ table
103102
[ES6<br>classList](#classlist)
104103

105104
:marked
106-
## Optional browser features to polyfill ##
105+
### Optional browser features to polyfill ##
107106
Some features of Angular may require additional polyfills.
108107

109108
For example, the animations library relies on the standard web animation API, which is only available in Chrome and Firefox today.
@@ -156,7 +155,7 @@ table
156155
td IE 9
157156

158157
:marked
159-
## Suggested polyfills ##
158+
### Suggested polyfills ##
160159
Below are the polyfills which are used to test the framework itself. They are a good starting point for an application.
161160

162161
table

public/docs/ts/latest/guide/change-log.jade

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@ block includes
22
include ../_util-fns
33

44
:marked
5-
# Documentation Change Log
6-
75
The Angular documentation is a living document with continuous improvements.
86
This log calls attention to recent significant changes.
97

public/docs/ts/latest/guide/index.jade

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ figure
1010
<br style="clear:left;">
1111

1212
:marked
13-
# Organization
13+
## Organization
1414

1515
The documentation is divided into major thematic sections, each
1616
a collection of pages devoted to that theme.
@@ -53,7 +53,7 @@ table(width="100%")
5353
:marked
5454
Recipes for specific application challenges, mostly code snippets with a minimum of exposition.
5555
:marked
56-
# Learning path
56+
## Learning path
5757
You don't have to read the guide straight through. Most pages stand on their own.
5858

5959
For those new to Angular, the recommended learning path runs through the *Guide* section:
@@ -81,7 +81,7 @@ table(width="100%")
8181
After reading the above sections, you can skip to any other pages on this site.
8282

8383
:marked
84-
# Code samples
84+
## Code samples
8585

8686
Each page includes code snippets that you can reuse in your applications.
8787
These snippets are excerpts from a sample application that accompanies the page.
@@ -98,15 +98,15 @@ block example-links
9898
The rest of the pages highlight key points in code rather than explain each step necessary to build the sample.
9999
You can always get the full source through the #{_liveLink}.
100100

101-
# Reference pages
101+
## Reference pages
102102

103103
The [Cheat Sheet](cheatsheet.html) lists Angular syntax for common scenarios.
104104

105105
The [Glossary](glossary.html) defines terms that Angular developers should know.
106106

107107
The [API Reference](../api/) is the authority on every public-facing member of the Angular libraries.
108108

109-
# Feedback
109+
## Feedback
110110

111111
We welcome feedback!
112112

public/docs/ts/latest/guide/lifecycle-hooks.jade

+2-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ block includes
33

44
- var top="vertical-align:top"
55

6-
:marked
7-
# Component Lifecycle
86
figure
9-
img(src="/resources/images/devguide/lifecycle-hooks/hooks-in-sequence.png" alt="Us" align="left" style="width:200px; margin-left:-40px;margin-right:30px" )
7+
img(src="/resources/images/devguide/lifecycle-hooks/hooks-in-sequence.png" alt="Us" align="left" style="width:200px; margin-left:-40px;margin-right:30px")
8+
109
:marked
1110
A component has a lifecycle managed by Angular itself.
1211

public/docs/ts/latest/guide/server-communication.jade

+3-3
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ block http-providers
102102
Loading its module now saves time.
103103
.l-main-section#http-client
104104
:marked
105-
# The Tour of Heroes HTTP client demo
105+
## The Tour of Heroes HTTP client demo
106106

107107
The first demo is a mini-version of the [tutorial](../tutorial)'s "Tour of Heroes" (ToH) application.
108108
This version gets some heroes from the server, displays them in a list, lets the user add new heroes, and saves them to the server.
@@ -128,7 +128,7 @@ figure.image-display
128128
a#oninit
129129
a#HeroListComponent
130130
:marked
131-
## The *HeroListComponent* class
131+
### The *HeroListComponent* class
132132
Here's the component class:
133133
+makeExample('server-communication/ts/app/toh/hero-list.component.ts','component', 'app/toh/hero-list.component.ts (class)')
134134
:marked
@@ -205,7 +205,7 @@ a#HeroService
205205

206206
.l-main-section
207207
:marked
208-
# RxJS library
208+
## RxJS library
209209
[RxJS](https://github.com/ReactiveX/RxJS) ("Reactive Extensions") is a 3rd party library, endorsed by Angular,
210210
that implements the [*asynchronous observable*](https://www.youtube.com/watch?v=UHI0AzD_WfY "Rob Wormald on observables") pattern.
211211

0 commit comments

Comments
 (0)