From c0e4a66c5a8b3d84403706e3ab28333e80eab563 Mon Sep 17 00:00:00 2001 From: Ash Keel Date: Tue, 28 Feb 2023 17:59:26 +0100 Subject: [PATCH] rework menus, add wip guide --- content/api/_index.md | 1 + content/guide/_index.md | 7 +++++ content/guide/getting-started/_index.md | 6 ++++ content/guide/getting-started/installation.md | 8 ++++++ content/guide/index.md | 0 layouts/api/list.html | 1 + layouts/guide/list.html | 8 ++++++ layouts/guide/single.html | 8 ++++++ layouts/partials/header.html | 16 ++++++++++- layouts/partials/menu.html | 28 +++++++++++++++++++ .../assets/scss/{api.scss => guide.scss} | 28 +++++++++++++++---- themes/strimertul/assets/scss/layout.scss | 11 ++++++++ themes/strimertul/assets/scss/main.scss | 3 +- themes/strimertul/assets/scss/pages.scss | 4 +++ 14 files changed, 121 insertions(+), 8 deletions(-) create mode 100644 content/guide/_index.md create mode 100644 content/guide/getting-started/_index.md create mode 100644 content/guide/getting-started/installation.md delete mode 100644 content/guide/index.md create mode 100644 layouts/guide/list.html create mode 100644 layouts/guide/single.html create mode 100644 layouts/partials/menu.html rename themes/strimertul/assets/scss/{api.scss => guide.scss} (82%) create mode 100644 themes/strimertul/assets/scss/pages.scss diff --git a/content/api/_index.md b/content/api/_index.md index 11dc954..d0976d6 100644 --- a/content/api/_index.md +++ b/content/api/_index.md @@ -1,6 +1,7 @@ --- menu: main title: API reference +weight: 100 --- TODO Talk about kilovolt and explain event and RPCs diff --git a/content/guide/_index.md b/content/guide/_index.md new file mode 100644 index 0000000..cf98b06 --- /dev/null +++ b/content/guide/_index.md @@ -0,0 +1,7 @@ +--- +menu: main +title: User guide +weight: 10 +--- + +TODO introduction to the user guide here diff --git a/content/guide/getting-started/_index.md b/content/guide/getting-started/_index.md new file mode 100644 index 0000000..1eac9b1 --- /dev/null +++ b/content/guide/getting-started/_index.md @@ -0,0 +1,6 @@ +--- +menu: + guides: + identifier: gettingstarted +title: Getting started +--- diff --git a/content/guide/getting-started/installation.md b/content/guide/getting-started/installation.md new file mode 100644 index 0000000..4e86dd4 --- /dev/null +++ b/content/guide/getting-started/installation.md @@ -0,0 +1,8 @@ +--- +title: Installation +menu: + guides: + parent: gettingstarted +--- + +TODO install guide here diff --git a/content/guide/index.md b/content/guide/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/layouts/api/list.html b/layouts/api/list.html index abf642b..2d72ac7 100644 --- a/layouts/api/list.html +++ b/layouts/api/list.html @@ -57,6 +57,7 @@ {{ $keys := .Site.Data.api.v310.api }}
diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html new file mode 100644 index 0000000..571f67b --- /dev/null +++ b/layouts/partials/menu.html @@ -0,0 +1,28 @@ + diff --git a/themes/strimertul/assets/scss/api.scss b/themes/strimertul/assets/scss/guide.scss similarity index 82% rename from themes/strimertul/assets/scss/api.scss rename to themes/strimertul/assets/scss/guide.scss index 527662e..fb102f4 100644 --- a/themes/strimertul/assets/scss/api.scss +++ b/themes/strimertul/assets/scss/guide.scss @@ -1,4 +1,5 @@ -.apidocs { +.apidocs, +.guide { display: grid; grid-template-rows: 1fr; grid-template-columns: 250px 1fr; @@ -20,6 +21,12 @@ background-color: $gray2; padding: 0; grid-column: 1; + header { + font-weight: bold; + padding: 0.6rem 0.9rem; + border-bottom: 1px solid $gray4; + margin-top: 0.5rem; + } ul { list-style-type: none; margin: 0; @@ -29,19 +36,28 @@ align-items: stretch; justify-content: stretch; transition: all 100ms; - &:nth-child(odd) { - background-color: rgba(255, 255, 255, 0.02); + font-size: 14px; + &.active { + pointer-events: none; + background-color: $gray5; + a { + color: $teal11; + } } &:hover { background-color: rgba(255, 255, 255, 0.05); } a { flex: 1; - padding: 0.5rem; - color: $teal10; + padding: 0.6rem 1rem; + color: $teal12; + text-decoration: none; + &:first-of-type { + padding-top: 0.8rem; + } } a:hover { - color: $teal12; + color: $teal11; } } } diff --git a/themes/strimertul/assets/scss/layout.scss b/themes/strimertul/assets/scss/layout.scss index 74c00ff..92c41a4 100644 --- a/themes/strimertul/assets/scss/layout.scss +++ b/themes/strimertul/assets/scss/layout.scss @@ -87,3 +87,14 @@ a.appname { .hidden { display: none; } + +html, +body, +.content { + min-height: 100vh; +} + +.content { + display: flex; + flex-direction: column; +} diff --git a/themes/strimertul/assets/scss/main.scss b/themes/strimertul/assets/scss/main.scss index 355a560..30fe110 100644 --- a/themes/strimertul/assets/scss/main.scss +++ b/themes/strimertul/assets/scss/main.scss @@ -5,4 +5,5 @@ @import "_vars.scss"; @import "layout.scss"; @import "landing.scss"; -@import "api.scss"; +@import "guide.scss"; +@import "pages.scss"; diff --git a/themes/strimertul/assets/scss/pages.scss b/themes/strimertul/assets/scss/pages.scss new file mode 100644 index 0000000..e2a3ec7 --- /dev/null +++ b/themes/strimertul/assets/scss/pages.scss @@ -0,0 +1,4 @@ +main.apidocs, +main.guide { + flex: 1; +}