document anchor settings

thegeeklab · Feb 26, 2020 · 977daa7 · 977daa7
1 parent 14567a6
commit 977daa7
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/exampleSite/content/usage/configuration.md b/exampleSite/content/usage/configuration.md
@@ -49,6 +49,9 @@
   # (Optional, default none) Add a link to your Privacy Policy page to the site footer.
   # It can be either a remote url or a local file path relative to your content directory.
   geekdocPrivacyPolicy = '/privacy'
+
+  # (Optional, default true) Add an anchor link to headlines.
+  geekdocAnchor = true
 ```
 
 {{< /tab >}}
@@ -101,6 +104,9 @@ params:
   # (Optional, default none) Add a link to your Privacy Policy page to the site footer.
   # It can be either a remote url or a local file path relative to your content directory.
   geekdocPrivacyPolicy: /privacy
+
+  # (Optional, default true) Add an anchor link to headlines.
+  geekdocAnchor: true
 ```
 
 {{< /tab >}}
@@ -140,6 +146,9 @@ geekdocFlatSection = true
 
 # Set true to hide page or section from side menu (file-tree menu only)
 geekdocHidden = true
+
+# Add an anchor link to headlines
+geekdocAnchor = true
 ```
 
 {{< /tab >}}
@@ -174,6 +183,9 @@ geekdocFlatSection: true
 
 # Set true to hide page or section from side menu (file-tree menu only)
 geekdocHidden: true
+
+# Add an anchor link to headlines
+geekdocAnchor: true
 ```
 
 {{< /tab >}}

diff --git a/layouts/partials/content.html b/layouts/partials/content.html
@@ -1,4 +1,4 @@
-{{ $showAnchor := (and (default true .Page.Params.geekdocAnchor) (default true .Site.Params.geekdocAnchor)) }}
+{{ $showAnchor := (and (default true .Page.Params.GeekdocAnchor) (default true .Site.Params.GeekdocAnchor)) }}
 
 {{ $.Scratch.Set "content" (.Content | replaceRE `<nav id="TableOfContents">\s*<ul>\s*<li>\s*<ul>` `<nav id="TableOfContents"><ul>` | replaceRE `</ul>\s*</li>\s*</ul>\s*</nav>` `</ul></nav>` | safeHTML) }}
 {{ if $showAnchor }}

diff --git a/layouts/partials/page-header.html b/layouts/partials/page-header.html
@@ -17,7 +17,7 @@
     {{ end }}
 {{ end }}
 
-{{ $showBreadcrumb := (and (default true .Page.Params.geekdocBreadcrumb) (default true .Site.Params.geekdocBreadcrumb)) }}
+{{ $showBreadcrumb := (and (default true .Page.Params.GeekdocBreadcrumb) (default true .Site.Params.GeekdocBreadcrumb)) }}
 {{ $showEdit := (and ($.Scratch.Get "geekdocFilePath") $geekdocRepo $geekdocEditPath) }}
 <div class="gdoc-page__header flex flex-wrap justify-between{{ if not $showEdit }} hidden-mobile{{ end }}{{ if (and (not $showBreadcrumb) (not $showEdit)) }} hidden {{ end }}" itemscope itemtype="http://data-vocabulary.org/Breadcrumb">
     <span>