Skip to content

Commit 4c811d4

Browse files
amcdnlmmalerba
authored andcommitted
chore(docs): adds toc to api docs (#7827)
1 parent 97447f9 commit 4c811d4

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

tools/dgeni/templates/class.template.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
<h4 class="docs-api-h4 docs-api-class-name">
1+
<h4 id="{$ class.name $}" class="docs-header-link docs-api-h4 docs-api-class-name">
2+
<span header-link="{$ class.name $}"></span>
23
<code>{$ class.name $}</code>
34
</h4>
45

@@ -16,7 +17,7 @@ <h4 class="docs-api-h4 docs-api-class-name">
1617
{%- endif -%}
1718

1819
{%- if class.directiveExportAs -%}
19-
<span class="docs-api-h4 docs-api-class-export-label">Exported as:</span>
20+
<span class="docs-api-class-export-label">Exported as:</span>
2021
<span class="docs-api-class-export-name">{$ class.directiveExportAs $}</span>
2122
{%- endif -%}
2223

tools/dgeni/templates/componentGroup.template.html

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,31 @@ <h2>
3131
</p>
3232

3333
{%- if doc.services.length -%}
34-
<h3 class="docs-api-h3">Services</h3>
34+
<h3 id="services" class="docs-header-link docs-api-h3">
35+
<span header-link="services"></span>
36+
Services
37+
</h3>
3538
{% for service in doc.services %}
3639
{$ class(service) $}
3740
{% endfor %}
3841
{%- endif -%}
3942

4043

4144
{%- if doc.directives.length -%}
42-
<h3 class="docs-api-h3">Directives</h3>
45+
<h3 id="directives" class="docs-header-link docs-api-h3">
46+
<span header-link="directives"></span>
47+
Directives
48+
</h3>
4349
{% for directive in doc.directives %}
4450
{$ class(directive) $}
4551
{% endfor %}
4652
{%- endif -%}
4753

4854
{%- if doc.additionalClasses.length -%}
49-
<h3 class="docs-api-h3">Additional classes</h3>
55+
<h3 id="additional_classes" class="docs-header-link docs-api-h3">
56+
<span header-link="additional_classes"></span>
57+
Additional classes
58+
</h3>
5059
{% for other in doc.additionalClasses %}
5160
{$ class(other) $}
5261
{% endfor %}

tools/gulp/tasks/docs.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ task('markdown-docs', () => {
9191
const escapedText = text.toLowerCase().replace(/[^\w]+/g, '-');
9292
return `
9393
<h${level} id="${escapedText}" class="docs-header-link">
94-
<div header-link="${escapedText}"></div>
94+
<span header-link="${escapedText}"></span>
9595
${text}
9696
</h${level}>
9797
`;

0 commit comments

Comments
 (0)