Skip to main content

Update mkdocs configuration based on the git branch

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocs-branchcustomization-plugin, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size mkdocs_branchcustomization_plugin-0.1.1-py3-none-any.whl (3.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mkdocs-branchcustomization-plugin-0.1.1.tar.gz (18.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page