Added support for linking authors in blog posts

Co-authored-by: alexvoss <4134224+alexvoss@users.noreply.github.com>
squidfunk · Nov 26, 2023 · 28ebcbf · 28ebcbf
1 parent 9c01605
commit 28ebcbf
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 4 deletions.
diff --git a/docs/blog/.authors.yml b/docs/blog/.authors.yml
@@ -3,7 +3,9 @@ authors:
     name: Martin Donath
     description: Creator
     avatar: https://avatars.githubusercontent.com/u/932156
+    url: https://github.com/squidfunk
   alexvoss:
     name: Alex Voss
     description: Community support
     avatar: https://avatars.githubusercontent.com/u/4134224
+    url: https://github.com/alexvoss
diff --git a/docs/plugins/blog.md b/docs/plugins/blog.md
@@ -1205,6 +1205,7 @@ The provided path is resolved from the [`docs` directory][mkdocs.docs_dir].
         name: string        # Author name
         description: string # Author description
         avatar: url         # Author avatar
+        url: url            # Author website URL
     ```
 
     Note that `<author>` must be set to an identifier for associating authors

diff --git a/material/plugins/blog/author.py b/material/plugins/blog/author.py
@@ -19,7 +19,7 @@
 # IN THE SOFTWARE.
 
 from mkdocs.config.base import Config
-from mkdocs.config.config_options import DictOfItems, SubConfig, Type
+from mkdocs.config.config_options import DictOfItems, Optional, SubConfig, Type
 
 # -----------------------------------------------------------------------------
 # Classes
@@ -30,6 +30,7 @@ class Author(Config):
     name = Type(str)
     description = Type(str)
     avatar = Type(str)
+    url = Optional(Type(str))
 
 # -----------------------------------------------------------------------------
 

diff --git a/material/templates/blog-post.html b/material/templates/blog-post.html
@@ -27,7 +27,14 @@
                       <img src="{{ author.avatar }}" alt="{{ author.name }}">
                     </span>
                     <span class="md-profile__description">
-                      <strong>{{ author.name }}</strong><br>
+                      <strong>
+                        {% if author.url %}
+                          <a href="{{ author.url }}">{{ author.name }}</a>
+                        {% else %}
+                          {{ author.name }}
+                        {% endif %}
+                      </strong>
+                      <br>
                       {{ author.description }}
                     </span>
                   </div>

diff --git a/src/plugins/blog/author.py b/src/plugins/blog/author.py
@@ -19,7 +19,7 @@
 # IN THE SOFTWARE.
 
 from mkdocs.config.base import Config
-from mkdocs.config.config_options import DictOfItems, SubConfig, Type
+from mkdocs.config.config_options import DictOfItems, Optional, SubConfig, Type
 
 # -----------------------------------------------------------------------------
 # Classes
@@ -30,6 +30,7 @@ class Author(Config):
     name = Type(str)
     description = Type(str)
     avatar = Type(str)
+    url = Optional(Type(str))
 
 # -----------------------------------------------------------------------------
 

diff --git a/src/templates/blog-post.html b/src/templates/blog-post.html
@@ -59,7 +59,14 @@
                       <img src="{{ author.avatar }}" alt="{{ author.name }}" />
                     </span>
                     <span class="md-profile__description">
-                      <strong>{{ author.name }}</strong><br />
+                      <strong>
+                        {% if author.url %}
+                          <a href="{{ author.url }}">{{ author.name }}</a>
+                        {% else %}
+                          {{ author.name }}
+                        {% endif %}
+                      </strong>
+                      <br />
                       {{ author.description }}
                     </span>
                   </div>