From: Alyssa Ross <hi@alyssa.is>
To: ~qaul/community@lists.sr.ht
Cc: Katharina Fey <kookie@spacekookie.de>
Subject: [PATCH 1/3] docs/website: use semantic structure elements
Date: Fri, 26 Feb 2021 13:50:44 +0000
Message-Id: <20210226135046.32283-2-hi@alyssa.is>
In-Reply-To: <20210226135046.32283-1-hi@alyssa.is>
References: <20210226135046.32283-1-hi@alyssa.is>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit

HTML has dedicated elements for lots of these kinds of things, so we
can improve readability and semantic meaning by using those instead of
divs.

I changed the .header and .footer styles to body > header and body >
footer, because I don't think it's worth having a special class that
would just be identical to the element names, but we might want to
have inner headers and footers at some point, so I think it's worth
restricting to just ones that are direct body descendants.
---
 docs/website/layouts/index.html                      | 12 ++++++------
 .../themes/qaul-theme/layouts/_default/baseof.html   |  4 ++--
 .../themes/qaul-theme/layouts/_default/learning.html |  4 ++--
 .../themes/qaul-theme/layouts/_default/page.html     |  4 ++--
 .../themes/qaul-theme/layouts/partials/footer.html   |  4 ++--
 docs/website/themes/qaul-theme/static/css/qaul.css   |  2 +-
 6 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/docs/website/layouts/index.html b/docs/website/layouts/index.html
index b6d488ef..ac49e189 100644
--- a/docs/website/layouts/index.html
+++ b/docs/website/layouts/index.html
@@ -12,7 +12,7 @@
 
 {{ define "main" }}
 {{ with .Site.GetPage "home/intro" }}
-<div class="intro-block">
+<section class="intro-block">
   <div class="wrap">
     <div class="intro-item">
       <img src="{{ "img/cube.svg" | relURL }}" />
@@ -36,11 +36,11 @@
       </div>
     </div>
   </div>
-</div>
+</section>
 {{ end }}
 
 {{ with .Site.GetPage "home/about" }}
-<div class="content">
+<section class="content">
   <div class="wrap">
     <h1>{{ .Params.Introduction_Title }}</h1>
 
@@ -49,15 +49,15 @@
     <h1>{{ .Params.Meshing_Title }}</h1>
     {{ .Params.Meshing | markdownify }}
   </div>
-</div>
+</section>
 {{ end }}
 
 {{ with .Site.GetPage "home/contribute" }}
-<div class="contribute-block">
+<section class="contribute-block">
   <div class="wrap">
     <h1>{{ .Params.Contribute_Title }}</h1>
     {{ .Params.Contribute | markdownify }}
   </div>
-</div>
+</section>
 {{ end }}
 {{ end }}
diff --git a/docs/website/themes/qaul-theme/layouts/_default/baseof.html b/docs/website/themes/qaul-theme/layouts/_default/baseof.html
index 0b930be1..a86827d0 100644
--- a/docs/website/themes/qaul-theme/layouts/_default/baseof.html
+++ b/docs/website/themes/qaul-theme/layouts/_default/baseof.html
@@ -3,7 +3,7 @@
   {{- partial "head.html" . -}}
   {{- block "head-override" .}}{{- end }}
   <body>
-    <div class="header">
+    <header>
       <div class="wrap">
         <!-- top logo & nav bar -->
         <div class="navbar">
@@ -19,7 +19,7 @@
 
         {{- block "header-title" . }}{{- end }}
       </div>
-    </div>
+    </header>
     
     {{- block "main" . }}{{- end }}
 
diff --git a/docs/website/themes/qaul-theme/layouts/_default/learning.html b/docs/website/themes/qaul-theme/layouts/_default/learning.html
index 0f8988a0..bccf7f09 100644
--- a/docs/website/themes/qaul-theme/layouts/_default/learning.html
+++ b/docs/website/themes/qaul-theme/layouts/_default/learning.html
@@ -1,5 +1,5 @@
 {{ define "main" }}
-<div class="content">
+<main class="content">
   <div class="wrap">
     <h1>{{ .Title }}</h1>
 
@@ -14,5 +14,5 @@
       </div>
     </div>
   </div>
-</div>
+</main>
 {{ end }}
diff --git a/docs/website/themes/qaul-theme/layouts/_default/page.html b/docs/website/themes/qaul-theme/layouts/_default/page.html
index e63fd83b..b0a26109 100644
--- a/docs/website/themes/qaul-theme/layouts/_default/page.html
+++ b/docs/website/themes/qaul-theme/layouts/_default/page.html
@@ -1,9 +1,9 @@
 {{ define "main" }}
-<div class="content">
+<main class="content">
   <div class="wrap">
     <h1>{{ .Title }}</h1>
 
     {{ .Content }}
   </div>
-</div>
+</main>
 {{ end }}
diff --git a/docs/website/themes/qaul-theme/layouts/partials/footer.html b/docs/website/themes/qaul-theme/layouts/partials/footer.html
index a799c0a0..d537e14d 100644
--- a/docs/website/themes/qaul-theme/layouts/partials/footer.html
+++ b/docs/website/themes/qaul-theme/layouts/partials/footer.html
@@ -1,4 +1,4 @@
-<div class="footer">
+<footer>
   <div class="wrap">
     <div class="navbar">
       <div class="navbar-links">
@@ -6,4 +6,4 @@
       </div>
     </div>
   </div>
-</div>
+</footer>
diff --git a/docs/website/themes/qaul-theme/static/css/qaul.css b/docs/website/themes/qaul-theme/static/css/qaul.css
index b2f5d363..d225a20d 100644
--- a/docs/website/themes/qaul-theme/static/css/qaul.css
+++ b/docs/website/themes/qaul-theme/static/css/qaul.css
@@ -25,7 +25,7 @@ p,li {
     max-width: 100%;
 }
 
-.header, .footer {
+body > header, body > footer {
     display: flex;
     justify-content: center;
     padding: 2rem;
-- 
2.30.0