✨ Make checked attributes configurable

Closes #1

Author: foosel

README.md

@@ -1,4 +1,4 @@
-# MkDocs Site URLs
+# MkDocs Site URLs Plugin
 
 A MkDocs plugin that adds support for site-relative `site:` URLs.
 
@@ -11,7 +11,7 @@ Example:
 
 **Please note**: This plugin requires MkDocs 1.5 or higher.
 
-## Usage
+## Getting Started
 
 1. Install the plugin from PyPI
    ```bash
@@ -22,18 +22,35 @@ Example:
    plugins:
      - site-urls
    ```
-   There are no configuration options.
 3. Start using site-relative URLs in your Markdown files by prefixing them with `site:`:
    ```markdown
    [Link to another page](site:another-page/relative/to/the/site/root)
 
    ![Image](site:images/foo.png)
    ```
 
+## Configuration
+
+By default the plugin will replace URLs in `href`, `src` and `data` attributes. You can configure the attributes to replace
+by setting the `attributes` option in your `mkdocs.yml`, e.g.:
+
+```yaml
+plugins:
+  - site-urls:
+      attributes:
+        - href
+        - src
+        - data
+        - data-url
+```
+
+Be advised that in case of any customization on your part you need to include the default attributes as well if you want
+to keep them, as the default list will not be included automatically anymore.
+
 ## How it works
 
 The plugin hooks into the [`on_page_content` event](https://www.mkdocs.org/dev-guide/plugins/#on_page_content)
-and replaces all URLs in `href` or `src` attributes in the rendered HTML with the corresponding site-relative URLs.
+and replaces all URLs in the configured attributes (by default `href`, `src` or `data`) in the rendered HTML with the corresponding site-relative URLs.
 
 ## License
 

mkdocs_site_urls/__init__.py

@@ -2,13 +2,23 @@
 import urllib.parse
 
 import mkdocs.plugins
-
-SITE_URLS_REGEX = re.compile(r'(href|src)="site:([^"]+)"', re.IGNORECASE)
+from mkdocs.config import config_options as c
+from mkdocs.config.defaults import MkDocsConfig
 
 logger = mkdocs.plugins.get_plugin_logger(__name__)
 
 
-class SiteUrlsPlugin(mkdocs.plugins.BasePlugin):
+class SiteUrlsConfig(mkdocs.config.base.Config):
+    attributes = c.Type(list, default=["href", "src", "data"])
+
+
+class SiteUrlsPlugin(mkdocs.plugins.BasePlugin[SiteUrlsConfig]):
+    def on_pre_build(self, *, config: MkDocsConfig) -> None:
+        self._regex = re.compile(
+            r"(" + "|".join(self.config["attributes"]) + r')="site:([^"]+)"',
+            re.IGNORECASE,
+        )
+
     @mkdocs.plugins.event_priority(50)
     def on_page_content(self, html, page, config, files):
         site_url = config["site_url"]
@@ -25,7 +35,7 @@ def _replace(match):
             if url.startswith("/"):
                 url = url[1:]
 
-            logger.info(f"Replacing site:{match.group(2)} with {path}{url}...")
+            logger.info(f"Replacing site:{match.group(2)} with {path}{url}")
             return f'{param}="{path}{url}"'
 
-        return SITE_URLS_REGEX.sub(_replace, html)
+        return self._regex.sub(_replace, html)