From f3783856ad9ce3a5e3c4358b97092f9cc229851d Mon Sep 17 00:00:00 2001
From: Jimmy Cai <hi@jimmycai.com>
Date: Thu, 2 May 2024 23:27:17 +0200
Subject: [PATCH] feat: add `article.headingAnchor` parameter and use CSS
 pseudo-element to display `#` symbol of heading anchor  (#1016)

* feat: add `article.headingAnchor` parameter

* feat: use CSS pseudo-element to display `#` symbol of heading anchor

This prevents RSS feed readers and screen readers from seeing an extra `#`.

* Deactivate `article.headingAnchor` by default
---
 assets/scss/partials/layout/article.scss     | 4 ++++
 config.yaml                                  | 1 +
 layouts/_default/_markup/render-heading.html | 4 +++-
 3 files changed, 8 insertions(+), 1 deletion(-)

diff --git a/assets/scss/partials/layout/article.scss b/assets/scss/partials/layout/article.scss
index 54c69eb..2a61423 100644
--- a/assets/scss/partials/layout/article.scss
+++ b/assets/scss/partials/layout/article.scss
@@ -232,6 +232,10 @@
             width: var(--card-padding);
             text-align: center;
             color: var(--accent-color);
+
+            &:before {
+                content: "#";
+            }
         }
 
         &:hover,
diff --git a/config.yaml b/config.yaml
index ece0ecb..b1a0bff 100644
--- a/config.yaml
+++ b/config.yaml
@@ -28,6 +28,7 @@ params:
             src: img/avatar.png
 
     article:
+        headingAnchor: false
         math: false
         toc: true
         readingTime: true
diff --git a/layouts/_default/_markup/render-heading.html b/layouts/_default/_markup/render-heading.html
index af79692..f79308a 100644
--- a/layouts/_default/_markup/render-heading.html
+++ b/layouts/_default/_markup/render-heading.html
@@ -1,4 +1,6 @@
 <h{{ .Level }} id="{{ .Anchor }}">
-    <a href="#{{ .Anchor }}" class="header-anchor">#</a>
+    {{- if site.Params.Article.HeadingAnchor -}}
+        <a href="#{{ .Anchor }}" class="header-anchor"></a>
+    {{- end -}}
     {{ .Text | safeHTML }}
 </h{{ .Level }}>
\ No newline at end of file