Skip to content

Link style for external and anchor links #254

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

Merged
merged 5 commits into from
Oct 11, 2023
Merged

Link style for external and anchor links #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
37736e1
Use internal link style also for external and anchor links
Simran-B Sep 29, 2023
a1bdbc1
Remove console.log
Simran-B Oct 10, 2023
233b623
Merge branch 'main' of https://github.com/arangodb/docs-hugo into ext…
Simran-B Oct 10, 2023
51602d2
Adjust new line of code from .link-internal to .link
Simran-B Oct 10, 2023
8fb6a71
Exclude external links when handling versions/aliases in links
Simran-B Oct 11, 2023
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
5 changes: 2 additions & 3 deletions site/themes/arangodb-docs-theme/layouts/_default/_markup/render-link.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
{{- end }}

{{- $permalink := "" }}
{{- $class := "" }}
{{- $isRemote := ne $url.Scheme "" }}

{{ if $isRemote -}}
Expand All @@ -21,7 +20,6 @@
{{ $page := .Page.GetPage $path -}}
{{ with $page -}}
{{ $permalink = printf "%s%s" $page.RelPermalink $fragment -}}
{{ $class = "link-internal" }}
{{ else -}}
{{ if ne $currentPage "/" -}}
{{ $currentFile := .Page.File.Path -}}
Expand All @@ -37,7 +35,8 @@

<a href="{{ $permalink | safeURL }}"
{{- with .Title }} title="{{ . }}"{{ end }}
{{- if $isRemote }} target="_blank" rel="noopener noreferrer"{{ else }} class="{{ $class }}"{{ end }}>
{{- if $isRemote }} target="_blank" rel="noopener noreferrer"{{ end }} class="link">
{{- .Text | safeHTML -}}
</a>
{{- if $isRemote }}&nbsp;<i class="fas fa-external-link-alt"></i>{{ end }}
{{- /* whitespace control */ -}}
4 changes: 2 additions & 2 deletions site/themes/arangodb-docs-theme/layouts/partials/breadcrumbs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{{ if not .IsHome }}
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">
<meta itemprop="position" content="{{ .Params.menuTitle }}" />
<a itemprop="item" class="link-internal" href="{{ .RelPermalink }}">
<a itemprop="item" class="link" href="{{ .RelPermalink }}">
<span itemprop="name" class="breadcrumb-entry">{{- if eq (len .Ancestors) 1 }}{{ template "getVersionLong" dict "page" .Page }}{{ else }}{{ .Params.menuTitle | markdownify }}{{ end }}</span>
</a>
<i class="fas fa-chevron-right fa-fw"></i>
Expand All @@ -15,7 +15,7 @@
{{ if not .IsHome }}
<li itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement">
<meta itemprop="position" content="{{ .Params.menuTitle }}" />
<a itemprop="item" class="link-internal" href="{{ .RelPermalink }}">
<a itemprop="item" class="link" href="{{ .RelPermalink }}">
<span itemprop="name" class="breadcrumb-entry">{{- if eq (len .Ancestors) 1 }}{{ template "getVersionLong" dict "page" .Page }}{{ else }}{{ .Params.menuTitle | markdownify }}{{ end }}</span>
</a>
</li>
Expand Down
6 changes: 3 additions & 3 deletions site/themes/arangodb-docs-theme/layouts/partials/content-footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,10 @@
<span class="prev">
{{ with $prev }}
{{- if eq (len .Ancestors) 1 }}
<a class="nav nav-prev link-internal" href="" title="">
<a class="nav nav-prev link" href="" title="">
</a>
{{ else }}
<a class="nav nav-prev link-internal" href="{{.RelPermalink}}" title="{{.Params.menuTitle}}">
<a class="nav nav-prev link" href="{{.RelPermalink}}" title="{{.Params.menuTitle}}">
<i class="fas fa-chevron-left fa-fw"></i><p>{{.Params.menuTitle | markdownify}}</p></a>
{{- end}}
{{ end }}
Expand All @@ -74,7 +74,7 @@

<span class="next">
{{ with $next }}
<a class="nav nav-next link-internal" href="{{.RelPermalink}}" title="{{.Params.menuTitle}}">
<a class="nav nav-next link" href="{{.RelPermalink}}" title="{{.Params.menuTitle}}">
<p>{{.Params.menuTitle | markdownify}}</p><i class="fas fa-chevron-right fa-fw"></i></a>
{{- end }}
</span>
2 changes: 1 addition & 1 deletion site/themes/arangodb-docs-theme/layouts/partials/shortcodes/card.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
{{ $destinationPage = $context.Page.GetPage $link -}}
{{ end }}

<a href="{{ $destinationPage.RelPermalink }}" class="link-internal">
<a href="{{ $destinationPage.RelPermalink }}" class="link">
<div class="card">
<div class="card-head">
{{ with $image }}<img
Expand Down
2 changes: 1 addition & 1 deletion site/themes/arangodb-docs-theme/layouts/shortcodes/cloudbanner.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<div>
<div class="ag-info">
Experience the shortest time to value for a hosted graph DB.</div>
<a class="link-internal" href="https://cloud.arangodb.com/home" target="_agCloud">
<a class="link" href="https://cloud.arangodb.com/home" target="_agCloud">
Get Started Today!
</a>
</div>
Expand Down
18 changes: 9 additions & 9 deletions site/themes/arangodb-docs-theme/static/css/theme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,27 +189,27 @@ ul ul, ul ol, ol ul, ol ol {
margin-bottom: .5rem;
}

.link-internal {
.link {
text-decoration: none;
border-bottom: 2px solid var(--green-600);
}

.link-internal:hover{
.link:hover{
border-bottom: 2px solid var(--green-600);
color: var(--gray-950);
}

.link-internal > * {
.link > * {
text-decoration: none;
pointer-events: none;
}

.link-internal > p {
.link > p {
border-bottom: 2px solid var(--green-600);
color: var(--gray-950);
}

.link-internal:has(code) {
.link:has(code) {
border-bottom: 2px solid var(--green-600);
font-size: 14px;
overflow: auto;
Expand All @@ -222,12 +222,12 @@ ul ul, ul ol, ol ul, ol ol {
box-shadow: none;
color: var(--gray-950);
}
.link-internal > code {
.link > code {
background-color: transparent;
border: none;
}

.link-internal > i {
.link > i {
color: var(--gray-950);
text-decoration: none;
}
Expand Down Expand Up @@ -390,7 +390,7 @@ table.fixed code {
box-shadow: rgb(149 157 165 / 20%) 0px 8px 24px;
} */

.cards > a.link-internal {
.cards > a.link {
border-bottom: 0px;
}

Expand Down Expand Up @@ -1989,7 +1989,7 @@ nav.pagination .next {
.nav-prev {
display: inherit;
}
.nav-prev.link-internal, .nav-next.link-internal {
.nav-prev.link, .nav-next.link {
border-bottom: 0;
}

Expand Down
8 changes: 6 additions & 2 deletions site/themes/arangodb-docs-theme/static/js/theme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,11 @@ function loadPage(target) {
}

function internalLinkListener() {
$('.link-internal').click(function(event) {
$('.link').click(function(event) {
if (event.target.getAttribute("target")) {
// external link
return;
}
event.preventDefault();
updateHistory("", event.target.getAttribute('href'))
})
Expand All @@ -199,7 +203,7 @@ function initArticle(url) {
styleImages();
internalLinkListener();
codeShowMoreListener();
aliazeLinks('article', 'a.link-internal');
aliazeLinks('article', 'a.link:not([target])');
aliazeLinks('article', 'a.header-link');
aliazeLinks('#breadcrumbs', 'a')
}
Expand Down