Implement exclude pages functionality #43

Author: timvink

README.md

@@ -120,6 +120,8 @@ plugins:
       time_zone: Europe/Amsterdam
       locale: en
       fallback_to_build_date: false
+      exclude:
+        - index.md
 ```
 
 ### `type`
@@ -150,6 +152,20 @@ Default is `None`. Specify a two letter [ISO639](https://en.wikipedia.org/wiki/L
 
 Default is `false`. If set to `true` the plugin will use the time at `mkdocs build` instead of the file's last git revision date *when git is not available*. This means the revision date can be incorrect, but this can be acceptable if you want your project to also successfully build in environments with no access to GIT.
 
+### `exclude`
+
+Default is empty. Specify a list of page source paths (one per line) that should not have a revision date included. This can be useful for example to remove the revision date from the front page. The source page is relative to your `docs/` folder. To exclude `docs/subfolder/page.md` specify in your `mkdocs.yml` a line under `exclude:` with `- subfolder/page.md`. Example:
+
+```yaml
+# mkdocs.yml
+plugins:
+  - git-revision-date-localized:
+      exclude:
+        - index.md
+        - subfolder/page.md
+        - another_page.md
+```
+
 ## Contributing
 
 Contributions are very welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) before putting in any work.

mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -35,7 +35,7 @@ class GitRevisionDateLocalizedPlugin(BasePlugin):
         ("locale", config_options.Type(str, default=None)),
         ("type", config_options.Type(str, default="date")),
         ("timezone", config_options.Type(str, default="UTC")),
-        ("excluded_page_titles", config_options.Type(list, default=[])),
+        ("exclude", config_options.Type(list, default=[])),
     )
 
     def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
@@ -140,10 +140,10 @@ def on_page_markdown(
         Returns:
             str: Markdown source text of page as string
         """
-        excluded_titles = self.config.get("excluded_page_titles", [])
-        if page.title in excluded_titles:
-            logging.debug("Excluding page " + page.url)
-            # page is excluded
+        # Exclude pages specified in config
+        excluded_pages = self.config.get("exclude", [])
+        if page.file.src_path in excluded_pages:
+            logging.debug("Excluding page " + page.file.src_path)
             return markdown
 
         revision_dates = self.util.get_revision_date_for_file(

tests/fixtures/basic_project/mkdocs_exclude.yml

@@ -0,0 +1,12 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+theme:
+    name: 'material'
+
+plugins:
+    - search
+    - git-revision-date-localized:
+        exclude:
+            - subfolder/page_in_subfolder.md
+            - first_page.md

tests/test_builds.py

@@ -331,7 +331,7 @@ def test_material_theme_no_locale(tmp_path):
     )
 
     # In mkdocs-material, a 'last update' should appear
-    # in German because locale is set to 'de'
+    # in english because default locale is set to 'en'
     index_file = testproject_path / "site/index.html"
     contents = index_file.read_text(encoding="utf8")
     assert re.search(r"Last update\:\s[<span class].+", contents)
@@ -358,6 +358,26 @@ def test_build_with_timezone(tmp_path):
     )
 
 
+def test_exclude_pages(tmp_path):
+    """
+    When using mkdocs-material theme, test correct working
+    """
+    # theme set to 'material' with 'locale' set to 'de'
+    testproject_path = validate_mkdocs_file(
+        tmp_path, "tests/fixtures/basic_project/mkdocs_exclude.yml"
+    )
+
+    # Make sure revision date does not exist in excluded pages
+    first_page = testproject_path / "site/first_page/index.html"
+    contents = first_page.read_text(encoding="utf8")
+    assert not re.search(r"Last update\:\s[<span class].+", contents)
+
+    sub_page = testproject_path / "site/subfolder/page_in_subfolder/index.html"
+    contents = sub_page.read_text(encoding="utf8")
+    assert not re.search(r"Last update\:\s[<span class].+", contents)
+
+
+
 def test_git_in_docs_dir(tmp_path):
     """
     In https://github.com/timvink/mkdocs-git-revision-date-localized-plugin/pull/31