Deprecate 'git_authors' and 'git_authors_summary' tags

Author: timvink

mkdocs_git_authors_plugin/plugin.py

@@ -138,6 +138,7 @@ def on_page_content(self, html, page, config, files, **kwargs):
         if exclude(page.file.src_path, excluded_pages):
             return html
 
+        # Replace {{ git_site_authors }}
         list_pattern = re.compile(
             r"\{\{\s*git_site_authors\s*\}\}", flags=re.IGNORECASE
         )
@@ -146,59 +147,20 @@ def on_page_content(self, html, page, config, files, **kwargs):
                 "" if self._fallback else
                 util.site_authors_summary(self.repo().get_authors(), self.config), html
             )
-        return html
-
-    def on_page_markdown(self, markdown, page, config, files, **kwargs):
-        """
-        Replace jinja tags in markdown.
-
-        The page_markdown event is called after the page's markdown is loaded
-        from file and can be used to alter the Markdown source text.
-        The meta- data has been stripped off and is available as page.meta
-        at this point.
-
-        https://www.mkdocs.org/user-guide/plugins/#on_page_markdown
-
-        Args:
-            markdown (str): Markdown source text of page as string
-            page: mkdocs.nav.Page instance
-            config: global configuration object
-            site_navigation: global navigation object
 
-        Returns:
-            str: Markdown source text of page as string
-        """
-        if not self.config.get('enabled'):
-            return markdown
-        
-        # Exclude pages specified in config
-        excluded_pages = self.config.get("exclude", [])
-        if exclude(page.file.src_path, excluded_pages):
-            return markdown
+        # Replace {{ git_page_authors }}
+        page_obj = self.repo().page(page.file.abs_src_path)
+        page_authors = util.page_authors_summary(page_obj, self.config)
 
-        pattern_authors_summary = re.compile(
-            r"\{\{\s*git_authors_summary\s*\}\}", flags=re.IGNORECASE
-        )
-        pattern_page_authors = re.compile(
+        list_pattern = re.compile(
             r"\{\{\s*git_page_authors\s*\}\}", flags=re.IGNORECASE
         )
+        if list_pattern.search(html):
+            html = list_pattern.sub(
+                "" if self._fallback else page_authors, html
+            )
 
-        if not pattern_authors_summary.search(
-            markdown
-        ) and not pattern_page_authors.search(markdown):
-            return markdown
-
-        if self._fallback:
-            markdown = pattern_authors_summary.sub("", markdown)
-            markdown = pattern_page_authors.sub("", markdown)
-            return markdown
-
-        page_obj = self.repo().page(page.file.abs_src_path)
-        page_authors = util.page_authors_summary(page_obj, self.config)
-
-        markdown = pattern_authors_summary.sub(page_authors, markdown)
-        markdown = pattern_page_authors.sub(page_authors, markdown)
-        return markdown
+        return html
 
     def on_page_context(self, context, page, config, nav, **kwargs):
         """
@@ -255,10 +217,6 @@ def on_page_context(self, context, page, config, nav, **kwargs):
         context["git_page_authors"] = page_authors
         context["git_site_authors"] = site_authors
 
-        # For backward compatibility, deprecate in 1.2
-        context["git_authors"] = util.page_authors(authors, path)
-        context["git_authors_summary"] = page_authors
-
         return context
 
     def repo(self):

tests/basic_setup/docs/page_with_tag.md

@@ -4,4 +4,6 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor i
 
 ## Content
 
-Markdown tag: {{ git_authors_summary }}
+Markdown tag (this tag has been deprecated so should not be replaced): {{ git_authors_summary }}
+
+This one has authors {{ git_page_authors }}

tests/basic_setup/mkdocs_w_macros.yml

@@ -3,5 +3,5 @@ use_directory_urls: true
 
 plugins:
     - search
-    - macros
+    # - macros
     - git-authors