Merge pull request #1200 from maxmind/kevin/toc

Add table of contents to some API pages
maxmind · Oct 7, 2024 · b8e6dd5 · b8e6dd5
2 parents e5eb3d3 + 53ba67a
commit b8e6dd5
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 0 deletions.
diff --git a/assets/scss/_page.scss b/assets/scss/_page.scss
@@ -63,3 +63,26 @@
     margin-right: calc(var(--mm-spacing) / 3);
   }
 }
+
+.page__toc {
+  background-color: #F8FAFC;
+  border: 1px solid var(--mm-color-border);
+  border-radius: var(--mm-border-radius);
+  padding: calc(var(--mm-spacing) / 2);
+
+  ul {
+    margin: 0;
+  }
+
+  ul ul {
+    margin-top: calc(var(--mm-spacing) / 8);
+  }
+
+  li {
+    margin-bottom: calc(var(--mm-spacing) / 8);
+  }
+}
+
+.page__toc__title {
+  margin-top: 0;
+}
diff --git a/content/geoip/docs/web-services/requests.md b/content/geoip/docs/web-services/requests.md
@@ -1,6 +1,7 @@
 ---
 draft: false
 title: GeoIP and GeoLite API Requests
+type: "has-toc"
 ---
 
 ## Authorization and Security

diff --git a/content/geoip/docs/web-services/responses.md b/content/geoip/docs/web-services/responses.md
@@ -1,6 +1,7 @@
 ---
 draft: false
 title: GeoIP and GeoLite API Responses
+type: "has-toc"
 ---
 
 ## Headers

diff --git a/content/minfraud/api-documentation/requests.md b/content/minfraud/api-documentation/requests.md
@@ -1,6 +1,7 @@
 ---
 draft: false
 title: minFraud API Requests
+type: "has-toc"
 ---
 
 ## Authorization and Security

diff --git a/content/minfraud/api-documentation/responses.md b/content/minfraud/api-documentation/responses.md
@@ -1,6 +1,7 @@
 ---
 draft: false
 title: minFraud API Responses
+type: "has-toc"
 ---
 
 ## Headers

diff --git a/layouts/partials/page.html b/layouts/partials/page.html
@@ -4,6 +4,13 @@
   </div>
   <div class="page__content">
     <h1 class="page__title">{{ .Title }}</h1>
+    {{ if eq .Type "has-toc" }}
+    <div class="page__toc">
+      <h3 class="page__toc__title">On this page</h3>
+    {{ .TableOfContents }}
+    </div>
+    {{ end }}
+
     {{ .Content }}
 
     {{ if eq .Type "release-note" }}