Web docs styling (#1350)

* Group members are doctors too. * Hide edit links, and don't bother rewriting in CI. * Clarify target deployment version, rename destination dirs. * Full version extraction. * Change text in docs index according to deployment type. * Style documentation banner depending on deployment type. * Update example index text to remove version-specifics.
disorderedmaterials · Mar 20, 2023 · 43924dc · 43924dc
1 parent bbd6297
commit 43924dc
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 3 deletions.
diff --git a/web/assets/scss/_content.scss b/web/assets/scss/_content.scss
@@ -10,7 +10,7 @@
 }
 
 .navbar {
-  background-color: #17132a;
+  background-color: $navbar-background-color;
 }
 
 /*

diff --git a/web/assets/scss/_styles_project.scss b/web/assets/scss/_styles_project.scss
@@ -0,0 +1,8 @@
+/*
+ * Disable GitHub links
+ */
+
+.td-page-meta--view { display: none !important; }
+.td-page-meta--edit { display: none !important; }
+.td-page-meta--child { display: none !important; }
+.td-page-meta--issue { display: none !important; }
diff --git a/web/assets/scss/_variables_project.scss b/web/assets/scss/_variables_project.scss
@@ -11,6 +11,9 @@ body {
 // Set colours
 $primary: #238fa8;
 $secondary: #6d3671;
+$navbar-background-color: #17132a;
+$navbar-background-color-dev: #b33100;
+$navbar-background-color-legacy: #0076af;
 
 // Adjust page description ("lead") to have more distinct space before actual content
 .lead {

diff --git a/web/docs/_index.md b/web/docs/_index.md
@@ -16,7 +16,7 @@ cascade:
 - V. Ionica (February 2022 - May 2022)
 - S. Smith (March 2021 - June 2021)
 - E. Devlin (August 2021), C. Green (August 2020 - August 2021), Simona (September 2019 - August 2020), J. Busch (October 2019 - December 2019)
-- Contributions, testing, and guidance from D. T. Bowron, T. F. Headen, S. G&auml;rtner, T.-L. Hughes, and O. Alderman.
+- Contributions, testing, and guidance from Dr D. T. Bowron, Dr T. F. Headen, Dr S. G&auml;rtner, Dr T.-L. Hughes, and Dr O. Alderman.
 
 Dissolve is a classical simulation code intended to help in analysing experimental scattering (diffraction) measurements through generating representative atomic configurations consistent with supplied reference data. Its primary use is for disordered systems such as those comprised of (or containing) liquids and glasses, but it can be applied to much more complex systems. See [What is Dissolve?]({{< ref "whatisdissolve" >}}}}) for more information.
 

diff --git a/web/docs/examples/_index.md b/web/docs/examples/_index.md
@@ -4,7 +4,7 @@ weight: 2
 type: docs
 ---
 
-Here you can find various usage examples, tutorials, and step-by-step walkthroughs for the current release of Dissolve (the latest version being {{< releaseversion >}}). Examples for earlier versions can be [found here](previous/0.8/).
+Here you can find various usage examples, tutorials, and step-by-step walkthroughs for Dissolve.
 
 ### Instructions
 

diff --git a/web/layouts/shortcodes/documentationinfo.html b/web/layouts/shortcodes/documentationinfo.html
@@ -0,0 +1,10 @@
+{{ $target := .Get "target" }}
+{{ if (eq $target "release") }}
+<p>{{ with .Site.Params.docinfo.release }} {{ . | markdownify }}{{ end }}</p>
+{{ end }}
+{{ if (eq $target "development") }}
+<p>{{ with .Site.Params.docinfo.development }} {{ . | markdownify }}{{ end }}</p>
+{{ end }}
+{{ if (eq $target "legacy") }}
+<p>{{ with .Site.Params.docinfo.legacy }} {{ . | markdownify }}{{ end }}</p>
+{{ end }}