Various improvements (#54)

* Update to latest mkdocs material version * Add media coverage page * Enable allowed domains for fathom analytics to suppress dev traffic * Enable Material for MkDocs privacy plugin * Make banner dismissable * Enable tab linking in tutorials Signed-off-by: Sven Trieflinger <[email protected]>
carbynestack · May 2, 2022 · bbf1b4e · bbf1b4e
1 parent d5db60b
commit bbf1b4e
Show file tree

Hide file tree

Showing 9 changed files with 72 additions and 21 deletions.
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -20,6 +20,8 @@ jobs:
         with:
           python-version: 3.x
       - name: Install Material for MkDocs
-        run: pip install mkdocs-material==8.1.1 mkdocs-minify-plugin==0.5.0
+        run: pip install \
+          git+https://${MKDOCS_MATERIAL_INSIDERS}@github.com/squidfunk/[email protected] \
+          mkdocs-minify-plugin==0.5.0
       - name: Deploy site
         run: mkdocs gh-deploy --force
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,6 @@ out
 gen
 target
 
+# MkDocs files
+.cache
+
diff --git a/README.md b/README.md
@@ -23,6 +23,11 @@ cd carbynestack.github.io
 mkdocs serve
 ```
 
+### MkDocs Material Insiders
+
+We use components of the MkDocs Material Insiders sponsorware. Installation
+instructions can be found [here](https://squidfunk.github.io/mkdocs-material/insiders/getting-started/#installation).
+
 ## License
 
 The Carbyne Stack website is open-sourced under the Apache License 2.0. See the

diff --git a/config/nav.yml b/config/nav.yml
@@ -17,6 +17,7 @@ nav:
       - Participate: community/participate.md
       - Ecosystem: community/ecosystem.md
       - Events: community/events.md
+      - Media Coverage: community/media-coverage.md
       - Opportunities: community/opportunities.md
       - Google Summer of Code: community/gsoc.md
       - Acknowledgements: community/acknowledgements.md

diff --git a/docs/community/media-coverage.md b/docs/community/media-coverage.md
@@ -0,0 +1,23 @@
+# Media Coverage
+
+This page summarizes media coverage of Carbyne Stack in blog posts, articles
+and news.
+
+<div class="grid cards" markdown>
+
+- <p>:fontawesome-solid-blog:{ .middle } __Blog Post__</p>
+
+    ---
+
+    ![Blog Image][bosch-cs-blog-post-image]
+
+    **Lifting Computing on Encrypted Data into the Cloud** - Bosch Research
+    launches Carbyne Stack Open-Source Project for Cloud-Native Secure
+    Multiparty Computation
+
+    [:octicons-arrow-right-24:{ .middle } Bosch Research Blog][bosch-cs-blog-post]
+
+</div>
+
+[bosch-cs-blog-post]: https://www.bosch.com/stories/open-source-carbyne-stack/
+[bosch-cs-blog-post-image]: https://assets.bosch.com/media/global/stories/forschung/carbyne_stack_for_cloud_native_secure_multiparty_computation/blog-header-carbyne-stack-16x9_res_1280x720.png
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -17,6 +17,14 @@
   color: var(--md-accent-fg-color);
 }
 
+.md-header {
+  background-color: black;
+}
+
+.md-tabs {
+  background-color: black;
+}
+
 .gsoc-topic-section-title {
   font-size: 1.4em;
   padding-bottom: -1.2em;
@@ -39,7 +47,7 @@
 
 .ecosystem-logo {
   width: auto;
-  height: 50px;
+  height: 50px !important;
 }
 
 .acknowledgements-logo {
@@ -54,9 +62,21 @@
 
 .event-logo {
   width: auto;
-  height: 70px;
+  height: 70px !important;
 }
 
 .invert {
   filter: invert(1);
 }
+
+.announcement-bar {
+  font-size: medium;
+}
+
+.announcement-bar a {
+  color: var(--md-accent-fg-color);
+}
+
+.announcement-bar a:where(:focus, :hover) {
+  color: var(--md-typeset-a-color) !important;
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -25,6 +25,8 @@ theme:
   custom_dir: overrides
   language: en
   features:
+    - announce.dismiss
+    - content.tabs.link
     - navigation.instant
     - navigation.tracking
     - navigation.tabs
@@ -39,7 +41,7 @@ theme:
     code: Roboto Mono
   palette:
     - scheme: default
-      primary: black
+      primary: indigo
       accent: red
 
 markdown_extensions:
@@ -61,6 +63,9 @@ markdown_extensions:
       toc_depth: 3
 
 plugins:
+  - privacy:
+      externals_exclude:
+        - holiday-van.carbynestack.io/*
   - search
   - minify:
       minify_html: true

diff --git a/overrides/assets/stylesheets/home.css b/overrides/assets/stylesheets/home.css
@@ -21,6 +21,10 @@
   padding: 0;
 }
 
+.md-sidebar--secondary {
+  display: none !important;
+}
+
 .md-main__inner .md-content__inner::before {
   display: none;
 }
@@ -45,7 +49,7 @@
 section.hero-section {
   min-height: 435px;
   justify-content: center;
-  color: var(--md-primary-bg-color);
+  color: white;
   position: relative;
   display: flex;
   align-items: center;
@@ -100,7 +104,7 @@ body {
 }
 
 .image-with-text {
-  color: var(--md-primary-fg-color);
+  color: var(--md-typeset-color);
 }
 
 .left {
@@ -147,7 +151,7 @@ body {
 .svg-icon-in-button {
   margin-right: 10px;
   font-size: x-large;
-  vertical-align: top;
+  vertical-align: middle !important;
 }
 
 .used-by-logo-banner {
@@ -156,18 +160,6 @@ body {
 
 .used-by-logo {
   width: auto;
-  height: 40px;
+  height: 40px !important;
   margin: 20px;
 }
-
-.announcement-bar {
-  font-size: medium;
-}
-
-.announcement-bar a {
-  color: var(--md-accent-fg-color);
-}
-
-.announcement-bar a:where(:focus, :hover) {
-  color: var(--md-typeset-a-color);
-}
diff --git a/overrides/main.html b/overrides/main.html
@@ -7,7 +7,7 @@
 {% extends "base.html" %}
 
 {% block libs %}
-<script src="https://cdn.usefathom.com/script.js" data-site="CUNVUWEF" data-excluded-domains="localhost,10.*.*.*,127.*.*.*,172.16.*.*,192.168.*.*" defer></script>
+<script src="https://holiday-van.carbynestack.io/script.js" data-site="CUNVUWEF" defer></script>
 {% endblock %}
 
 {% block announce %}
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,3 +5,6 @@ out @@
     gen
     target
+    # MkDocs files
+    .cache