Skip to main content

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

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.

Release files for mkdocs-branchcustomization-plugin 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocs-branchcustomization-plugin 1.0.0
File Size Uploaded
mkdocs_branchcustomization_plugin-1.0.0.tar.gz 4.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mkdocs-branchcustomization-plugin 1.0.0
File Interpreter ABI Platform
mkdocs_branchcustomization_plugin-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 9.2 kB

Release files / mkdocs_branchcustomization_plugin-1.0.0.tar.gz

Download URL mkdocs_branchcustomization_plugin-1.0.0.tar.gz
Size 4.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4a080d25d819c2db5408d266cf7d867bef68e771f7687f1d94628c604e304fb8
BLAKE2b-256 checksum
How to use checksums
c178fbfd3920619ac9462fea45dd3ad87c7a53a218e79470d6e548f25fd0a7b0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Bluefin","version":"44","id":"Deinonychus","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / mkdocs_branchcustomization_plugin-1.0.0-py3-none-any.whl

Download URL mkdocs_branchcustomization_plugin-1.0.0-py3-none-any.whl
Size 5.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0ae7e7f939a62ba2c2d08ff3b7fcd1c7b6f188dae9c42931d7fcc62a1c305505
BLAKE2b-256 checksum
How to use checksums
1989f6610b4db03443902da7cb75c7b0e3de6be79989f61079d80603c683a5ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.11.33 {"installer":{"name":"uv","version":"0.11.33","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Bluefin","version":"44","id":"Deinonychus","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page