Use render-heading to implement self links (grpc#458)

Closes grpc#443
dfawley · Oct 13, 2020 · f31fedf · f31fedf
1 parent 16192e4
commit f31fedf
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 23 deletions.
diff --git a/assets/sass/style.sass b/assets/sass/style.sass
@@ -297,19 +297,14 @@ $colors: mergeColorMaps(("secondary": ($secondary, $white), "twitter-blue": ($tw
     & + li
       margin-top: 0.75rem
 
-.hashlink
-  @extend .icon
-  height: 1rem
-  width: 1rem
-  margin-left: 0.25rem
-
-.headline-hash
-  display: none
+.heading-self-link
+  @extend .is-hidden-desktop // On touch devices, always show self-link
+  margin-left: .3rem
 
 @for $i from 1 through 6
-  h#{$i}
-    &:hover > .headline-hash
-      display: inline
+  h#{$i}[id]
+    &:hover > .heading-self-link
+      display: initial !important
 
 // Currently (2020-05-29), the external-link character is used as an icon in the
 // top navbar. The "a >" prefix is used in the next rule only as a simple means

diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_default/_markup/render-heading.html
@@ -0,0 +1,3 @@
+<h{{ .Level }} id="{{ .Anchor | safeURL }}">
+{{- .Text | safeHTML -}}
+<a aria-hidden="true" class="heading-self-link is-size-5-touch" href="#{{ .Anchor | safeURL }}"><i class="fas fa-hashtag"></i></a></h{{ .Level }}>
diff --git a/layouts/partials/content.html b/layouts/partials/content.html
@@ -1,5 +1,5 @@
-{{ $size        := .size | default "normal" }}
-{{ $constrained := .constrained | default false }}
+{{ $size        := .size | default "normal" -}}
+{{ $constrained := .constrained | default false -}}
 <div class="content is-{{ $size }} has-bottom-padding{{ if $constrained }} is-constrained{{ end }}">
-  {{ partial "headline-hash.html" .content }}
+  {{ .content }}
 </div>
diff --git a/layouts/partials/docs/article.html b/layouts/partials/docs/article.html
@@ -1,5 +1,5 @@
-{{ $desc   := .Params.description }}
-{{ $source := printf "https://github.com/grpc/grpc.io/tree/%s/content/%s" $.Site.Params.branch .File.Path }}
+{{ $desc   := .Params.description -}}
+{{ $source := printf "https://github.com/grpc/grpc.io/tree/%s/content/%s" $.Site.Params.branch .File.Path -}}
 <section class="section">
   <div class="container">
     <div class="columns is-variable is-8">

diff --git a/layouts/partials/headline-hash.html b/layouts/partials/headline-hash.html
diff --git a/layouts/partials/navbar-menu.html b/layouts/partials/navbar-menu.html
@@ -1,6 +1,6 @@
 {{ $menu  := site.Menus.main -}}
 
-{{ range $menu -}}
+{{ range $menu }}
 {{ $name := .Name -}}
 {{ if .HasChildren -}}
 {{ $url := .URL | relLangURL -}}
@@ -11,9 +11,8 @@
       <i class="fas fa-caret-down"></i>
     </span>
   </a>
-
   <div class="navbar-dropdown">
-    {{ range .Children -}}
+    {{- range .Children }}
     {{ $name       := .Name -}}
     {{ $url        := .URL -}}
     {{ $isExternal := hasPrefix .URL "http" -}}
@@ -25,7 +24,7 @@
       <span class="icon has-text-secondary">
         <i class="fas fa-sm fa-external-link-alt"></i>
       </span>
-      {{- end }}
+      {{- end -}}
     </a>
     {{- end }}
   </div>
@@ -42,7 +41,7 @@
   <span class="icon has-text-secondary">
     <i class="fas fa-xs fa-external-link-alt"></i>
   </span>
-  {{- end }}
+  {{- end -}}
 </a>
 {{- end }}
 {{- end -}}