Add Jekyll SEO Tag and update configuration

- Introduced `jekyll-seo-tag` gem for SEO enhancements. - Updated `_config.yaml` to include the new plugin and added a description. - Created a new default layout in `_layouts/default.html`.
hummat · Dec 9, 2024 · b993324 · b993324
1 parent e6cece8
commit b993324
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 1 deletion.
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1 @@
+gem 'jekyll-seo-tag'
diff --git a/_config.yaml b/_config.yaml
@@ -1,5 +1,7 @@
-theme: jekyll-theme-cayman
+plugins:
+  - jekyll-seo-tag
 title: BlenderProc Publication Visualization
+description: Publication-ready visualization of 3D objects and point clouds in seconds.
 url: https://hummat.github.io/bproc-pubvis
 twitter:
   username: matthiashumt

diff --git a/_layouts/default.html b/_layouts/default.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="{{ site.lang | default: "en-US" }}">
+  <head>
+    <meta charset="UTF-8">
+
+{% seo %}
+    <link rel="preconnect" href="https://fonts.gstatic.com">
+    <link rel="preload" href="https://fonts.googleapis.com/css?family=Open+Sans:400,700&display=swap" as="style" type="text/css" crossorigin>
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <meta name="theme-color" content="#157878">
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+    <link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}">
+    {% include head-custom.html %}
+  </head>
+  <body>
+    <a id="skip-to-content" href="#content">Skip to the content.</a>
+
+    <header class="page-header" role="banner">
+      <h1 class="project-name">{{ page.title | default: site.title | default: site.github.repository_name }}</h1>
+      <h2 class="project-tagline">{{ page.description | default: site.description | default: site.github.project_tagline }}</h2>
+      {% if site.github.is_project_page %}
+        <a href="{{ site.github.repository_url }}" class="btn">View on GitHub</a>
+      {% endif %}
+      {% if site.show_downloads %}
+        <a href="{{ site.github.zip_url }}" class="btn">Download .zip</a>
+        <a href="{{ site.github.tar_url }}" class="btn">Download .tar.gz</a>
+      {% endif %}
+    </header>
+
+    <main id="content" class="main-content" role="main">
+      {{ content }}
+
+      <footer class="site-footer">
+        {% if site.github.is_project_page %}
+          <span class="site-footer-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</span>
+        {% endif %}
+        <span class="site-footer-credits">This page was generated by <a href="https://pages.github.com">GitHub Pages</a>.</span>
+      </footer>
+    </main>
+  </body>
+</html>