Metadata-Version: 2.4
Name: mkdocs-branchcustomization-plugin
Version: 1.0.0
Summary: Update mkdocs configuration based on the git branch
Author-email: "Christopher J. Markiewicz" <markiewicz@stanford.edu>
Maintainer-email: "Christopher J. Markiewicz" <markiewicz@stanford.edu>
License-Expression: MIT
Project-URL: Homepage, https://github.com/effigies/mkdocs-branchcustomization-plugin
Platform: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Provides: mkdocs_branchcustomization_plugin
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs
Requires-Dist: gitpython
Dynamic: license-file

# MkDocs Branch Customization Plugin

This plugin allows configuration options to be overridden on a per-branch basis.
Branches are matched with regular expressions.

An example for adding CSS to the `master` branch might be:

```YAML
plugins:
  - branchcustomization:
      update_config:
        - branch: /master/
          extra_css:
            - css/master_branch.css
```

Note that this will *override* the global `extra_css` value.

To customize every branch *except* `master`:

```YAML
plugins:
  - branchcustomization:
      update_config:
        - branch: /(?!^master$)/
          +extra_css:
            - css/draft.css
          extra_js:
            - js/draft.js
```

In this case the `+extra_css` indicates that this list should be *appended* to
the global `extra_css` value, rather than overriding it, while `extra_js` overrides
the global value.
