mkdocs-overwrite-configs


Namemkdocs-overwrite-configs JSON
Version 1.0.1 PyPI version JSON
download
home_pageNone
SummaryOverwrite MkDocs configuration files with a single file
upload_time2024-09-06 17:32:10
maintainerNone
docs_urlNone
authorNone
requires_python>=3.6
licenseMIT
keywords mkdocs backstage techdocs mkdocs-overwrite-configs
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            A simple plugin that will override configs that previous plugins have messed.

I made this plugin for the sole reason that I need to use the same config for a standalone build and a backstage integration. For some reason, the backstage-techdocs-core plugin messes with the config and I need to override it to make it work.

## Usage

```yaml
theme:
  palette: &palette
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
plugins:
  - overwrite-configs:
      theme:
        palette: *palette
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mkdocs-overwrite-configs",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": "mkdocs, backstage, techdocs, mkdocs-overwrite-configs",
    "author": null,
    "author_email": "carneirofc <claudiofcarneiro@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/4f/72/87502142ef21ac8f7c8927a834c11111bddc900cacb7654a37d3bb99e666/mkdocs_overwrite_configs-1.0.1.tar.gz",
    "platform": null,
    "description": "A simple plugin that will override configs that previous plugins have messed.\n\nI made this plugin for the sole reason that I need to use the same config for a standalone build and a backstage integration. For some reason, the backstage-techdocs-core plugin messes with the config and I need to override it to make it work.\n\n## Usage\n\n```yaml\ntheme:\n  palette: &palette\n    - media: \"(prefers-color-scheme: light)\"\n      scheme: default\n      toggle:\n        icon: material/brightness-7\n        name: Switch to dark mode\n    - media: \"(prefers-color-scheme: dark)\"\n      scheme: slate\n      toggle:\n        icon: material/brightness-4\n        name: Switch to system preference\nplugins:\n  - overwrite-configs:\n      theme:\n        palette: *palette\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Overwrite MkDocs configuration files with a single file",
    "version": "1.0.1",
    "project_urls": {
        "homepage": "https://github.com/carneirofc/mkdocs-overwrite-configs"
    },
    "split_keywords": [
        "mkdocs",
        " backstage",
        " techdocs",
        " mkdocs-overwrite-configs"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5731a67809fbc4a4f1e2cce37daa890920fa2e4109c4f2ea65c178d9a32b53af",
                "md5": "71cd637b41d8fc46f33f389ad4fcd86d",
                "sha256": "a4fc59a112b5439b0656478e79d63c34c97b762910a8314cbb59f04567c843e4"
            },
            "downloads": -1,
            "filename": "mkdocs_overwrite_configs-1.0.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "71cd637b41d8fc46f33f389ad4fcd86d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 2825,
            "upload_time": "2024-09-06T17:32:09",
            "upload_time_iso_8601": "2024-09-06T17:32:09.209909Z",
            "url": "https://files.pythonhosted.org/packages/57/31/a67809fbc4a4f1e2cce37daa890920fa2e4109c4f2ea65c178d9a32b53af/mkdocs_overwrite_configs-1.0.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4f7287502142ef21ac8f7c8927a834c11111bddc900cacb7654a37d3bb99e666",
                "md5": "2877da0dd8108fb3ec30101a330ea935",
                "sha256": "4dabafd4bd7eb1ea7d82af4dff8af2bda0f52b35d25a8d18d3f09e7cd1762750"
            },
            "downloads": -1,
            "filename": "mkdocs_overwrite_configs-1.0.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2877da0dd8108fb3ec30101a330ea935",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 2318,
            "upload_time": "2024-09-06T17:32:10",
            "upload_time_iso_8601": "2024-09-06T17:32:10.394517Z",
            "url": "https://files.pythonhosted.org/packages/4f/72/87502142ef21ac8f7c8927a834c11111bddc900cacb7654a37d3bb99e666/mkdocs_overwrite_configs-1.0.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-06 17:32:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "carneirofc",
    "github_project": "mkdocs-overwrite-configs",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mkdocs-overwrite-configs"
}
        
Elapsed time: 0.63573s