mkdocs-branchcustomization-plugin

Name	mkdocs-branchcustomization-plugin JSON
Version	0.1.3 JSON
	download
home_page	https://github.com/effigies/mkdocs-branchcustomization-plugin
Summary	Update mkdocs configuration based on the git branch
upload_time	2019-12-13 18:18:51
maintainer	Christopher J. Markiewicz
docs_url	None
author	Christopher J. Markiewicz
requires_python	>=3.6
license	MIT License
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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.



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/effigies/mkdocs-branchcustomization-plugin",
    "name": "mkdocs-branchcustomization-plugin",
    "maintainer": "Christopher J. Markiewicz",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "markiewicz@stanford.edu",
    "keywords": "",
    "author": "Christopher J. Markiewicz",
    "author_email": "markiewicz@stanford.edu",
    "download_url": "https://files.pythonhosted.org/packages/c1/d5/2823c9e878152e5291d7c368c0f30b2df523b4220477eae0d0dc53c859e0/mkdocs-branchcustomization-plugin-0.1.3.tar.gz",
    "platform": "OS Independent",
    "description": "# MkDocs Branch Customization Plugin\n\nThis plugin allows configuration options to be overridden on a per-branch basis.\nBranches are matched with regular expressions.\n\nAn example for adding CSS to the `master` branch might be:\n\n```YAML\nplugins:\n  - branchcustomization:\n      update_config:\n        - branch: /master/\n          extra_css:\n            - css/master_branch.css\n```\n\nNote that this will *override* the global `extra_css` value.\n\nTo customize every branch *except* `master`:\n\n```YAML\nplugins:\n  - branchcustomization:\n      update_config:\n        - branch: /(?!^master$)/\n          +extra_css:\n            - css/draft.css\n          extra_js:\n            - js/draft.js\n```\n\nIn this case the `+extra_css` indicates that this list should be *appended* to\nthe global `extra_css` value, rather than overriding it, while `extra_js` overrides\nthe global value.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Update mkdocs configuration based on the git branch",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/effigies/mkdocs-branchcustomization-plugin"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3f2da3aca81a7a7f23cf8ae3047a274e4f5ff6fd651b10551a098bf2815ff48c",
                "md5": "2e7735d506eb870f84cb4c11041b3314",
                "sha256": "b29ebe625b32be042f1ede935490134afac55962458be09bd2bcd746aa54fedf"
            },
            "downloads": -1,
            "filename": "mkdocs_branchcustomization_plugin-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2e7735d506eb870f84cb4c11041b3314",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 4120,
            "upload_time": "2019-12-13T18:18:49",
            "upload_time_iso_8601": "2019-12-13T18:18:49.797600Z",
            "url": "https://files.pythonhosted.org/packages/3f/2d/a3aca81a7a7f23cf8ae3047a274e4f5ff6fd651b10551a098bf2815ff48c/mkdocs_branchcustomization_plugin-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c1d52823c9e878152e5291d7c368c0f30b2df523b4220477eae0d0dc53c859e0",
                "md5": "3ffe0dcc0a05ecb11e4958e49b238d3b",
                "sha256": "c34b891a6ab1d8a19c81ac5e2fa1ea435bc17155e4dd733627bc7db98d933870"
            },
            "downloads": -1,
            "filename": "mkdocs-branchcustomization-plugin-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "3ffe0dcc0a05ecb11e4958e49b238d3b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 19034,
            "upload_time": "2019-12-13T18:18:51",
            "upload_time_iso_8601": "2019-12-13T18:18:51.293937Z",
            "url": "https://files.pythonhosted.org/packages/c1/d5/2823c9e878152e5291d7c368c0f30b2df523b4220477eae0d0dc53c859e0/mkdocs-branchcustomization-plugin-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2019-12-13 18:18:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "effigies",
    "github_project": "mkdocs-branchcustomization-plugin",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mkdocs-branchcustomization-plugin"
}