Custom href option

Author: alonsomoya

docs/options.md

@@ -8,6 +8,7 @@ plugins:
         show_contribution: true
         show_line_count: true
         show_email_address: true
+        href: "mailto:{email}"
         count_empty_lines: true
         fallback_to_empty: false
         sort_authors_by: name
@@ -37,9 +38,15 @@ If this option is set to `true` (default: `false`) the number of lines per autho
 ## `show_email_address`
 
 If this option is set to `true` (default: `true`), then authors' names
-are rendered as a `mailto:` link pointing to their email address. If
+are rendered as (by default) a `mailto:{email}` link pointing to their email address. If
 set to `false`, they are shown in plain text.
 
+## `href`
+
+Given `show_email_adress` is set to `true`, you can customize the rendered link with the option `href`
+(default: `mailto:{email}`) using the f-string format (available `{email}` and `{name}`).
+This is useful to link to IM tools i.e. `href: "https://teams.microsoft.com/l/chat/0/0?users={email}"`.
+
 ## `count_empty_lines`
 
 If this option is set to `true` (default: `false`) empty lines will count towards an authors' contribution.

mkdocs_git_authors_plugin/plugin.py

@@ -17,6 +17,7 @@ class GitAuthorsPlugin(BasePlugin):
         ("show_contribution", config_options.Type(bool, default=False)),
         ("show_line_count", config_options.Type(bool, default=False)),
         ("show_email_address", config_options.Type(bool, default=True)),
+        ("href", config_options.Type(str, default='mailto:{email}')),
         ("count_empty_lines", config_options.Type(bool, default=True)),
         ("fallback_to_empty", config_options.Type(bool, default=False)),
         ("exclude", config_options.Type(list, default=[])),

mkdocs_git_authors_plugin/util.py

@@ -59,7 +59,9 @@ def page_authors_summary(page, config: dict):
             else ""
         )
         if page.repo().config("show_email_address"):
-            author_name = "<a href='mailto:%s'>%s</a>" % (author.email(), author.name())
+            href = page.repo().config("href").format(email=author.email(),
+                                                     name=author.name())
+            author_name = "<a href='%s'>%s</a>" % (href, author.name())
         else:
             author_name = author.name()
         authors_summary.append("%s%s" % (author_name, contrib))
@@ -105,7 +107,9 @@ def site_authors_summary(authors, config: dict):
         lines = ": %s lines" % author.lines() if show_line_count else ""
         author_name = ""
         if show_email_address:
-            author_name = '<a href="mailto:%s">%s</a>' % (author.email(), author.name())
+            href = config["href"].format(email=author.email(),
+                                         name=author.name())
+            author_name = '<a href="%s">%s</a>' % (href, author.name())
         else:
             author_name = author.name()
         result += """

tests/basic_setup/mkdocs_custom_href.yml

@@ -0,0 +1,7 @@
+site_name: test gitauthors_plugin
+use_directory_urls: true
+
+plugins:
+    - search
+    - git-authors:
+        href: "https://teams.microsoft.com/l/chat/0/0?users={email}"

tests/test_basic.py

@@ -29,6 +29,7 @@
 
 SITES_THAT_SHOULD_SUCCEED = [
     "mkdocs.yml",
+    "mkdocs_custom_href.yml",
     "mkdocs_complete_material_disabled.yml",
     "mkdocs_complete_material.yml",
     "mkdocs_exclude.yml",
@@ -92,6 +93,27 @@ def test_basic_working(tmp_path, mkdocs_file):
     assert re.search('<a href="mailto:[email protected]">Tim Vink</a>', contents)
 
 
+def test_custom_href(tmp_path):
+    """
+    """
+    result = build_docs_setup("tests/basic_setup/mkdocs_custom_href.yml", tmp_path)
+    assert result.exit_code == 0, (
+            "'mkdocs build' command failed. Error: %s" % result.stdout
+    )
+
+    index_file = tmp_path / "index.html"
+    assert index_file.exists(), "%s does not exist" % index_file
+
+    contents = index_file.read_text()
+    assert re.search("<span class='git-page-authors", contents)
+    # Checking Page Authors
+    assert re.search((r"<p>Page authors:.*<a href='https://teams.microsoft.com/l/chat/0/0\?"
+                      "[email protected]'>Tim Vink</a>.*<\/p>"), contents)
+    # Checking Site Authors
+    assert re.search(('<li><a href="https://teams.microsoft.com/l/chat/0/0\?'
+                      '[email protected]">Tim Vink</a><\/li>'), contents)
+
+
 
 def test_no_email(tmp_path):