Add SEO metadata and sitemap plugin support, configure custom theme directory and extra SEO settings in mkdocs.yml

Author: dompling

.github/workflows/deploy-docs.yml

@@ -163,7 +163,7 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install mkdocs-material
+          pip install mkdocs-material mkdocs-sitemap-plugin
 
       - name: Prepare Workspace
         run: |
@@ -177,4 +177,4 @@ jobs:
           
 
       - name: Build and Deploy
-        run: mkdocs gh-deploy --force
+        run: mkdocs gh-deploy --force

mkdocs.yml

@@ -1,10 +1,12 @@
 site_name: TrollScript
 site_url: https://trollscript.qzz.io
 site_description: TrollScript 官方文档与 API 参考
+site_author: TrollScript Team
 repo_url: https://github.com/dompling/TrollScript-Release
 
 theme:
   name: material
+  custom_dir: overrides
   language: zh
   palette:
     # 自动切换深色/浅色模式
@@ -64,12 +66,26 @@ nav:
     - iCloud: iCloud.md
   - 常见问题: FAQ.md
 
+plugins:
+  - search:
+      lang:
+        - zh
+        - en
+  - sitemap
+
+extra:
+  seo:
+    keywords: TrollScript, iOS automation, TrollStore, JavaScript API, iOS scripting, iOS docs
+    og_image: https://trollscript.qzz.io/AppIcon.png
+    twitter_card: summary_large_image
+
 
 markdown_extensions:
+  - meta
   - toc:
       permalink: true
   - admonition                # 警告/提示框
   - pymdownx.details          # 折叠详情
   - pymdownx.superfences      # 嵌套代码块
   - pymdownx.tabbed:          # 选项卡
-      alternate_style: true
+      alternate_style: true

overrides/main.html

@@ -0,0 +1,36 @@
+{% extends "base.html" %}
+
+{% block extrahead %}
+  {{ super() }}
+
+  {% set seo_title = config.site_name %}
+  {% if page and page.title %}
+    {% set seo_title = page.title ~ " - " ~ config.site_name %}
+  {% endif %}
+
+  {% set seo_description = config.site_description %}
+  {% if page and page.meta and page.meta.description %}
+    {% set seo_description = page.meta.description %}
+  {% endif %}
+
+  {% set seo_url = config.site_url %}
+  {% if page and page.canonical_url %}
+    {% set seo_url = page.canonical_url %}
+  {% endif %}
+
+  <meta name="robots" content="index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1" />
+  <meta name="author" content="{{ config.site_author }}" />
+  <meta name="keywords" content="{{ config.extra.seo.keywords }}" />
+
+  <meta property="og:type" content="website" />
+  <meta property="og:site_name" content="{{ config.site_name }}" />
+  <meta property="og:title" content="{{ seo_title }}" />
+  <meta property="og:description" content="{{ seo_description }}" />
+  <meta property="og:url" content="{{ seo_url }}" />
+  <meta property="og:image" content="{{ config.extra.seo.og_image }}" />
+
+  <meta name="twitter:card" content="{{ config.extra.seo.twitter_card }}" />
+  <meta name="twitter:title" content="{{ seo_title }}" />
+  <meta name="twitter:description" content="{{ seo_description }}" />
+  <meta name="twitter:image" content="{{ config.extra.seo.og_image }}" />
+{% endblock %}