Merge pull request #63 from timvink/add_enable_option

Add new option 'enabled', see #58

Author: timvink

docs/options.md

@@ -12,6 +12,7 @@ plugins:
       enable_creation_date: true
       exclude:
           - index.md
+      enabled: true
 ```
 
 ## `type`
@@ -71,3 +72,21 @@ plugins:
         - another_page.md
         - folder/*
 ```
+
+## `enabled`
+
+Default is `true`. Enables you to deactivate this plugin. A possible use case is local development where you might want faster build times and/or do not have git available. It's recommended to use this option with an environment variable together with a default fallback (introduced in `mkdocs` v1.2.1, see [docs](https://www.mkdocs.org/user-guide/configuration/#environment-variables)). Example:
+
+```yaml
+# mkdocs.yml
+plugins:
+  - git-revision-date-localized:
+      enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
+```
+
+Which enables you do disable the plugin locally using:
+
+```bash
+export ENABLED_GIT_REVISION_DATE=false
+mkdocs serve
+```

mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -38,6 +38,7 @@ class GitRevisionDateLocalizedPlugin(BasePlugin):
         ("timezone", config_options.Type(str, default="UTC")),
         ("exclude", config_options.Type(list, default=[])),
         ("enable_creation_date", config_options.Type(bool, default=False)),
+        ("enabled", config_options.Type(bool, default=True)),
     )
 
     def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
@@ -55,6 +56,9 @@ def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
         Returns:
             dict: global configuration object
         """
+        if not self.config.get('enabled'):
+            return config
+        
         self.util = Util(config=self.config)
 
         # Get locale settings - might be added in future mkdocs versions
@@ -142,6 +146,9 @@ def on_page_markdown(
         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):
@@ -206,7 +213,7 @@ def on_post_build(self, config: Dict[str, Any], **kwargs) -> None:
         Adds the timeago assets to the build.
         """
         # Add timeago files:
-        if self.config.get("type") == "timeago":
+        if self.config.get("type") == "timeago" and self.config.get('enabled'):
             files = [
                 "js/timeago.min.js",
                 "js/timeago_mkdocs_material.js",

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name="mkdocs-git-revision-date-localized-plugin",
-    version="0.9.3",
+    version="0.10.0",
     description="Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",

tests/fixtures/basic_project/mkdocs_theme_locale_disabled.yml

@@ -0,0 +1,11 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+theme:
+    name: 'material'
+    locale: nl
+
+plugins:
+    - search
+    - git-revision-date-localized:
+        enabled: !ENV [ENABLED_GIT_REVISION_DATE, False]

tests/test_builds.py

@@ -51,14 +51,15 @@ def get_plugin_config_from_mkdocs(mkdocs_path) -> dict:
     cfg = plugin_loaded.on_config(cfg_mkdocs)
     logging.info("Fixture configuration loaded: " + str(cfg))
 
-    assert (
-        plugin_loaded.config.get("locale") is not None
-    ), "Locale should never be None after plugin is loaded"
-
-    logging.info(
-        "Locale '%s' determined from %s"
-        % (plugin_loaded.config.get("locale"), mkdocs_path)
-    )
+    if plugin_loaded.config.get("enabled"):
+        assert (
+            plugin_loaded.config.get("locale") is not None
+        ), "Locale should never be None after plugin is loaded"
+
+        logging.info(
+            "Locale '%s' determined from %s"
+            % (plugin_loaded.config.get("locale"), mkdocs_path)
+        )
     return plugin_loaded.config
 
 
@@ -196,6 +197,9 @@ def validate_build(testproject_path, plugin_config: dict = {}):
 
     # Make sure with markdown tag has valid
     # git revision date tag
+    if not plugin_config.get('enabled'):
+        return 
+    
     page_with_tag = testproject_path / "site/page_with_tag/index.html"
     contents = page_with_tag.read_text(encoding="utf8")
     assert re.search(r"renders as\:\s[<span>|\w].+", contents)
@@ -346,6 +350,23 @@ def test_material_theme_locale(tmp_path):
     contents = index_file.read_text(encoding="utf8")
     assert re.search(r"Last update\:\s[<span class].+", contents)
 
+def test_material_theme_locale_disabled(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_theme_locale_disabled.yml"
+    )
+
+    # In mkdocs-material, a 'last update' should appear
+    # in english instead of German because you should use 'language' and not locale.
+    # The date will be in german though
+    index_file = testproject_path / "site/index.html"
+    contents = index_file.read_text(encoding="utf8")
+    assert re.search(r"Last update\:\s[<span class].+", contents) is None
+
+
 
 def test_material_theme_no_locale(tmp_path):
     """