From 8542bdcd3c2699451a68c53f9bba7fc70307e03f Mon Sep 17 00:00:00 2001
From: Ash Keel <ash@nebula.cafe>
Date: Wed, 1 Mar 2023 10:15:30 +0100
Subject: [PATCH] add install guide

---
 content/guide/_index.md                       |  2 --
 content/guide/getting-started/installation.md | 12 ++++++++++-
 layouts/guide/single.html                     |  1 +
 themes/strimertul/assets/scss/guide.scss      | 11 ++++++++++
 themes/strimertul/assets/scss/layout.scss     | 21 +++++++++++++++++++
 .../_default/_markup/render-heading.html      |  1 +
 6 files changed, 45 insertions(+), 3 deletions(-)
 create mode 100644 themes/strimertul/layouts/_default/_markup/render-heading.html

diff --git a/content/guide/_index.md b/content/guide/_index.md
index cf98b06..8b09c7b 100644
--- a/content/guide/_index.md
+++ b/content/guide/_index.md
@@ -3,5 +3,3 @@ menu: main
 title: User guide
 weight: 10
 ---
-
-TODO introduction to the user guide here
diff --git a/content/guide/getting-started/installation.md b/content/guide/getting-started/installation.md
index 4e86dd4..11ba19b 100644
--- a/content/guide/getting-started/installation.md
+++ b/content/guide/getting-started/installation.md
@@ -5,4 +5,14 @@ menu:
     parent: gettingstarted
 ---
 
-TODO install guide here
+To install strimertül, choose one of the following methods. If you're not a developer or have particular needs, you should follow the recommended method.
+
+## Recommended: Pre-built binaries
+
+Download the executable for your platform from the [main page](/), put it into a folder of your choosing and run it!
+
+The executable will create files in the folder it's run from, so it's heavily discouraged from running it in default locations like your desktop or your Downloads folder.
+
+## Build from source
+
+To build from source, go to the [project page on GitHub](https://github.com/strimertul/strimertul) and follow the "Development" and "Building" sections in the README file.
diff --git a/layouts/guide/single.html b/layouts/guide/single.html
index 8eb6e13..5578462 100644
--- a/layouts/guide/single.html
+++ b/layouts/guide/single.html
@@ -2,6 +2,7 @@
   <main class="guide">
     {{ partial "menu.html" (dict "context" . "menu" $.Site.Menus.guides) }}
     <div class="doc">
+      <header><h1>{{ .Title }}</h1></header>
       <section class="copy">{{ .Content }}</section>
     </div>
   </main>
diff --git a/themes/strimertul/assets/scss/guide.scss b/themes/strimertul/assets/scss/guide.scss
index fb102f4..c27ced0 100644
--- a/themes/strimertul/assets/scss/guide.scss
+++ b/themes/strimertul/assets/scss/guide.scss
@@ -12,6 +12,9 @@
       padding: 1rem;
     }
   }
+  @media (min-width: 1200px) {
+    grid-template-columns: 1fr 1000px 1fr;
+  }
   & > nav,
   & > .doc {
     grid-row: 1;
@@ -150,3 +153,11 @@
     color: $grass10;
   }
 }
+
+.doc {
+  h2 {
+    border-bottom: 1px solid $gray5;
+    padding-bottom: 0.4rem;
+    margin-top: 2rem;
+  }
+}
diff --git a/themes/strimertul/assets/scss/layout.scss b/themes/strimertul/assets/scss/layout.scss
index 92c41a4..be55ac2 100644
--- a/themes/strimertul/assets/scss/layout.scss
+++ b/themes/strimertul/assets/scss/layout.scss
@@ -98,3 +98,24 @@ body,
   display: flex;
   flex-direction: column;
 }
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+  position: relative;
+}
+a.heading-anchor {
+  text-decoration: none;
+  position: absolute;
+  left: -0.9em;
+  font-weight: normal;
+  font-size: 0.9em;
+  top: 0.1em;
+  color: $gray8;
+  &:hover {
+    color: $teal9;
+  }
+}
diff --git a/themes/strimertul/layouts/_default/_markup/render-heading.html b/themes/strimertul/layouts/_default/_markup/render-heading.html
new file mode 100644
index 0000000..0ad5803
--- /dev/null
+++ b/themes/strimertul/layouts/_default/_markup/render-heading.html
@@ -0,0 +1 @@
+<h{{ .Level }} id="{{ .Anchor | safeURL }}"><a href="#{{ .Anchor | safeURL }}" class="heading-anchor">#</a> {{ .Text | safeHTML }}</h{{ .Level }}>