Added name attribute to social links and improved defaults

squidfunk · May 3, 2020 · db7c28b · db7c28b
1 parent 1b72c9f
commit db7c28b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -614,6 +614,10 @@ extra:
       link: https://linkedin.com/in/squidfunk
 ```
 
+By default, the link `title` will be set to the domain name, e.g. _github.com_.
+If you want to set a discernable name, e.g., to improve your Lighthouse score,
+you can set the `name` attribute on each social link.
+
   [21]: #icons
 
 ### Adding a Web App Manifest

diff --git a/material/partials/social.html b/material/partials/social.html
@@ -4,9 +4,12 @@
 {% if config.extra.social %}
   <div class="md-footer-social">
     {% for social in config.extra.social %}
-      {% set _,rest = social.link.split("//") %}
-      {% set domain = rest.split("/")[0] %}
-      <a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ domain }}" class="md-footer-social__link">
+      {% set title = social.name %}
+      {% if not title and "//" in social.link %}
+        {% set _,url = social.link.split("//") %}
+        {% set title = url.split("/")[0] %}
+      {% endif %}
+      <a href="{{ social.link }}" target="_blank" rel="noopener" title="{{ title }}" class="md-footer-social__link">
         {% include ".icons/" ~ social.icon ~ ".svg" %}
       </a>
     {% endfor %}

diff --git a/src/partials/social.html b/src/partials/social.html
@@ -24,12 +24,15 @@
 {% if config.extra.social %}
   <div class="md-footer-social">
     {% for social in config.extra.social %}
-      {% set _,rest = social.link.split("//") %}
-      {% set domain = rest.split("/")[0] %}
+      {% set title = social.name %}
+      {% if not title and "//" in social.link %}
+        {% set _,url = social.link.split("//") %}
+        {% set title = url.split("/")[0] %}
+      {% endif %}
       <a
         href="{{ social.link }}"
         target="_blank" rel="noopener"
-        title="{{ domain }}"
+        title="{{ title }}"
         class="md-footer-social__link"
       >
         {% include ".icons/" ~ social.icon ~ ".svg" %}