mkdocs-branchcustomization-plugin

Update mkdocs configuration based on the git branch


License
MIT
Install
pip install mkdocs-branchcustomization-plugin==0.1.3

Documentation

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:

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:

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

This is just to demonstrate that multiple configuration options can be overridden.