Skip to content

docs: move header link icon to the right to align with Angular style #33860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MeAkib wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: move header link icon to the right to align with Angular style #33860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/src/styles/_markdown.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,24 @@
color: var(--mat-sys-primary);
}

h1,
h2,
h3 {
font-weight: 400;
margin: 32px 0 16px;
}

h1 {
display: inline-block;
font-size: 32px;
font-weight: 400;
margin: 32px 0 16px;
}

h2 {
font-size: 28px;
margin: 32px 0 16px;
font-weight: 400;
}

h3 {
font-size: 24px;
margin: 32px 0 16px;
font-weight: 400;
}

h4 {
Expand Down Expand Up @@ -92,11 +93,10 @@

.docs-header-link {
header-link {
// deduct -30px so the anchor icon will be positioned outside the content
margin-left: -30px;
// Slight margin to try and center the icon better.
margin-top: 2px;
display: inline-block;
// Slight margin so the anchor icon isn't flush against the heading text.
margin-left: 8px;
display: inline-flex;
align-items: center;
vertical-align: middle;

// stylelint-disable-next-line material/no-prefixes
Expand Down
2 changes: 1 addition & 1 deletion tools/dgeni/templates/class.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
{% import "macros.html" as macros %}

<h4 id="{$ class.name $}" class="docs-header-link docs-api-h4 docs-api-class-name">
<span header-link="{$ class.name $}"></span>
<code>{$ class.name $}</code>
{% if class.extendedDoc %}
<span class="docs-api-class-extends-clauses">
Expand All @@ -11,6 +10,7 @@ <h4 id="{$ class.name $}" class="docs-header-link docs-api-h4 docs-api-class-nam
</a>
</span>
{% endif %}
<span header-link="{$ class.name $}"></span>
</h4>

{%- if class.description -%}
Expand Down
2 changes: 1 addition & 1 deletion tools/dgeni/templates/constant.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{% import "macros.html" as macros %}

<h4 id="{$ constant.name $}" class="docs-header-link docs-api-h4 docs-api-constant-name">
<span header-link="{$ constant.name $}"></span>
<code>{$ constant.name $}</code>
<span header-link="{$ constant.name $}"></span>
</h4>

{%- if constant.isDeprecated -%}
Expand Down
16 changes: 8 additions & 8 deletions tools/dgeni/templates/entry-point.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,8 @@ <h2>

{%- if doc.services.length -%}
<h3 id="{$ doc.name $}-services" class="docs-header-link docs-api-h3">
<span header-link="services"></span>
Services
<span header-link="services"></span>
</h3>
{% for service in doc.services %}
{$ class(service) $}
Expand All @@ -62,8 +62,8 @@ <h3 id="{$ doc.name $}-services" class="docs-header-link docs-api-h3">

{%- if doc.components.length -%}
<h3 id="{$ doc.name $}-components" class="docs-header-link docs-api-h3">
<span header-link="components"></span>
Components
<span header-link="components"></span>
</h3>
{% for component in doc.components %}
{$ class(component) $}
Expand All @@ -72,8 +72,8 @@ <h3 id="{$ doc.name $}-components" class="docs-header-link docs-api-h3">

{%- if doc.directives.length -%}
<h3 id="{$ doc.name $}-directives" class="docs-header-link docs-api-h3">
<span header-link="directives"></span>
Directives
<span header-link="directives"></span>
</h3>
{% for directive in doc.directives %}
{$ class(directive) $}
Expand All @@ -82,8 +82,8 @@ <h3 id="{$ doc.name $}-directives" class="docs-header-link docs-api-h3">

{%- if doc.classes.length -%}
<h3 id="{$ doc.name $}-classes" class="docs-header-link docs-api-h3">
<span header-link="classes"></span>
Classes
<span header-link="classes"></span>
</h3>
{% for other in doc.classes %}
{$ class(other) $}
Expand All @@ -92,8 +92,8 @@ <h3 id="{$ doc.name $}-classes" class="docs-header-link docs-api-h3">

{%- if doc.interfaces.length -%}
<h3 id="{$ doc.name $}-interfaces" class="docs-header-link docs-api-h3">
<span header-link="interfaces"></span>
Interfaces
<span header-link="interfaces"></span>
</h3>
{% for item in doc.interfaces %}
{$ interface(item) $}
Expand All @@ -102,8 +102,8 @@ <h3 id="{$ doc.name $}-interfaces" class="docs-header-link docs-api-h3">

{%- if doc.functions.length -%}
<h3 id="{$ doc.name $}-functions" class="docs-header-link docs-api-h3">
<span header-link="functions"></span>
Functions
<span header-link="functions"></span>
</h3>
{% for item in doc.functions %}
{#
Expand All @@ -116,8 +116,8 @@ <h3 id="{$ doc.name $}-functions" class="docs-header-link docs-api-h3">

{%- if doc.typeAliases.length -%}
<h3 id="{$ doc.name $}-type_aliases" class="docs-header-link docs-api-h3">
<span header-link="type_aliases"></span>
Type aliases
<span header-link="type_aliases"></span>
</h3>
{% for item in doc.typeAliases %}
{$ typeAlias(item) $}
Expand All @@ -126,8 +126,8 @@ <h3 id="{$ doc.name $}-type_aliases" class="docs-header-link docs-api-h3">

{%- if doc.constants.length -%}
<h3 id="{$ doc.name $}-constants" class="docs-header-link docs-api-h3">
<span header-link="constants"></span>
Constants
<span header-link="constants"></span>
</h3>
{% for item in doc.constants %}
{$ constant(item) $}
Expand Down
2 changes: 1 addition & 1 deletion tools/dgeni/templates/interface.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{% import "macros.html" as macros %}

<h4 id="{$ interface.name $}" class="docs-header-link docs-api-h4 docs-api-interface-name">
<span header-link="{$ interface.name $}"></span>
<code>{$ interface.name $}</code>
<span header-link="{$ interface.name $}"></span>
</h4>

{%- if interface.description -%}
Expand Down
2 changes: 1 addition & 1 deletion tools/dgeni/templates/type-alias.template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{% import "macros.html" as macros %}

<h4 id="{$ alias.name $}" class="docs-header-link docs-api-h4 docs-api-type-alias-name">
<span header-link="{$ alias.name $}"></span>
<code>{$ alias.name $}</code>
<span header-link="{$ alias.name $}"></span>
</h4>

{%- if alias.isDeprecated -%}
Expand Down
2 changes: 1 addition & 1 deletion tools/markdown-to-html/docs-marked-renderer.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ export class DocsMarkdownRenderer extends Renderer {
this._seenIds.add(headingId);
return `
<h${depth} id="${headingId}" class="docs-header-link">
<span header-link="${headingId}"></span>
${content}
<span header-link="${headingId}"></span>
</h${depth}>
`;
}
Expand Down
4 changes: 2 additions & 2 deletions tools/markdown-to-html/docs-marked-renderer.spec.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ describe('DocsMarkdownRenderer', () => {
`
<div class="docs-markdown">
<h3 id="header-3" class="docs-header-link">
<span header-link="header-3"></span>
header 3
<span header-link="header-3"></span>
</h3>
</div>
`,
Expand All @@ -35,8 +35,8 @@ describe('DocsMarkdownRenderer', () => {
`
<div class="docs-markdown">
<h4 id="header-4" class="docs-header-link">
<span header-link="header-4"></span>
header 4
<span header-link="header-4"></span>
</h4>
</div>
`,
Expand Down
Loading