Detached configuration from documentation build

squidfunk · Jul 24, 2021 · abb95a3 · abb95a3
1 parent fddc648
commit abb95a3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 32 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -55,6 +55,7 @@ jobs:
         run: |
           git clone --depth 1 https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
           pip install -e mkdocs-material-insiders
+          cp mkdocs-material-insiders/mkdocs.yml mkdocs.yml
           echo "THEME_DIR=mkdocs-material-insiders/material" >> $GITHUB_ENV
 
       - name: Deploy documentation

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,8 +24,7 @@ site_url: https://squidfunk.github.io/mkdocs-material/
 site_author: Martin Donath
 site_description: >-
   Create a branded static site from a set of Markdown files to host the
-  documentation of your Open Source or commercial project – customizable,
-  searchable, mobile-friendly, 40+ languages
+  documentation of your Open Source or commercial project
 
 # Repository
 repo_name: squidfunk/mkdocs-material
@@ -53,14 +52,19 @@ theme:
   features:
     - content.code.annotate
     - content.tabs.link
+    # - header.autohide
+    # - navigation.expand
+    # - navigation.indexes
     # - navigation.instant
     - navigation.sections
     - navigation.tabs
+    # - navigation.tabs.sticky
     - navigation.top
     - navigation.tracking
     - search.highlight
     - search.share
     - search.suggest
+    # - toc.integrate
   palette:
     - scheme: default
       primary: indigo
@@ -84,7 +88,6 @@ theme:
 # Plugins
 plugins:
   - search
-  - social
   - redirects:
       redirect_maps:
         changelog/insiders.md: insiders/changelog.md

diff --git a/src/overrides/main.html b/src/overrides/main.html
@@ -25,34 +25,7 @@
 <!-- Custom front matter -->
 {% block extrahead %}
 
-  <!-- Determine title -->
-  {% set title = config.site_name %}
-  {% if page and page.title and not page.is_homepage %}
-    {% set title = config.site_name ~ " - " ~ page.title | striptags %}
-  {% endif %}
-
-  <!-- The image needs to have an absolute URL -->
-  {% set image = config.site_url ~ 'assets/images/banner.png' %}
-
-  <!-- Open graph meta tags -->
-  <meta property="og:type" content="website" />
-  <meta property="og:title" content="{{ title }}" />
-  <meta property="og:description" content="{{ config.site_description }}" />
-  <meta property="og:url" content="{{ page.canonical_url }}" />
-  <meta property="og:image" content="{{ image }}" />
-  <meta property="og:image:type" content="image/png" />
-  <meta property="og:image:width" content="1080" />
-  <meta property="og:image:height" content="568" />
-
-  <!-- Twitter meta tags -->
-  <meta name="twitter:card" content="summary_large_image" />
-  <meta name="twitter:site" content="@squidfunk" />
-  <meta name="twitter:creator" content="@squidfunk" />
-  <meta name="twitter:title" content="{{ title }}" />
-  <meta name="twitter:description" content="{{ config.site_description }}" />
-  <meta name="twitter:image" content="{{ image }}" />
-
-  <!-- Extra stylesheets -->
+  <!-- Extra stylesheets (can't be set in mkdocs.yml due to content hash) -->
   <link
     rel="stylesheet"
     href="{{ 'overrides/assets/stylesheets/main.css' | url }}"
@@ -74,7 +47,7 @@
 {% block scripts %}
   {{ super() }}
 
-  <!-- Extra JavaScript -->
+  <!-- Extra JavaScript (can't be set in mkdocs.yml due to content hash) -->
   <script src="{{ 'overrides/assets/javascripts/bundle.js' | url }}"></script>
 {% endblock %}