add install guide

This commit is contained in:
Ash Keel 2023-03-01 10:15:30 +01:00
parent c0e4a66c5a
commit 8542bdcd3c
No known key found for this signature in database
GPG Key ID: BAD8D93E7314ED3E
6 changed files with 45 additions and 3 deletions

View File

@ -3,5 +3,3 @@ menu: main
title: User guide
weight: 10
---
TODO introduction to the user guide here

View File

@ -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.

View File

@ -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>

View File

@ -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;
}
}

View File

@ -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;
}
}

View File

@ -0,0 +1 @@
<h{{ .Level }} id="{{ .Anchor | safeURL }}"><a href="#{{ .Anchor | safeURL }}" class="heading-anchor">#</a> {{ .Text | safeHTML }}</h{{ .Level }}>