mdformat-vuepress

Name	mdformat-vuepress JSON
Version	0.1.0 JSON
	download
home_page	None
Summary	Preserve VuePress-style ::: containers in mdformat
upload_time	2025-08-24 15:15:00
maintainer	None
docs_url	None
author	None
requires_python	>=3.9
license	MIT License Copyright (c) 2025 Marius Högger Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords	formatter markdown mdformat vuepress
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mdformat-vuepress

An [mdformat](https://github.com/executablebooks/mdformat) plugin to preserve VuePress-style `:::` containers when formatting Markdown files.

## Installation

```bash
pip install mdformat-vuepress
```

Or with uv:

```bash
uv add mdformat-vuepress
```

## Usage

After installation, the plugin will automatically be available to mdformat. VuePress-style containers will be preserved during formatting:

```markdown
::: tip
This is a tip container that will be preserved.
:::

::: warning
This is a warning container.
:::

::: danger
This is a danger container.
:::
```

## Features

- Preserves VuePress container syntax (`:::`)
- Maintains container content formatting
- Compatible with mdformat's formatting rules
- Supports all VuePress container types

## Development

This plugin is built using the mdformat plugin system and uses markdown-it-py for parsing.

## License

MIT License - see [LICENSE](LICENSE) file for details.

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mdformat-vuepress",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "formatter, markdown, mdformat, vuepress",
    "author": null,
    "author_email": "Marius H\u00f6gger <marius.hoegger@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/1a/0c/50c2f5348b09441c1b4e0bd88330a62ef13d82d31b356bb3a75508b0d2a7/mdformat_vuepress-0.1.0.tar.gz",
    "platform": null,
    "description": "# mdformat-vuepress\n\nAn [mdformat](https://github.com/executablebooks/mdformat) plugin to preserve VuePress-style `:::` containers when formatting Markdown files.\n\n## Installation\n\n```bash\npip install mdformat-vuepress\n```\n\nOr with uv:\n\n```bash\nuv add mdformat-vuepress\n```\n\n## Usage\n\nAfter installation, the plugin will automatically be available to mdformat. VuePress-style containers will be preserved during formatting:\n\n```markdown\n::: tip\nThis is a tip container that will be preserved.\n:::\n\n::: warning\nThis is a warning container.\n:::\n\n::: danger\nThis is a danger container.\n:::\n```\n\n## Features\n\n- Preserves VuePress container syntax (`:::`)\n- Maintains container content formatting\n- Compatible with mdformat's formatting rules\n- Supports all VuePress container types\n\n## Development\n\nThis plugin is built using the mdformat plugin system and uses markdown-it-py for parsing.\n\n## License\n\nMIT License - see [LICENSE](LICENSE) file for details.",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2025 Marius H\u00f6gger\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.",
    "summary": "Preserve VuePress-style ::: containers in mdformat",
    "version": "0.1.0",
    "project_urls": null,
    "split_keywords": [
        "formatter",
        " markdown",
        " mdformat",
        " vuepress"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d90ebac3c3289dfcf3f97df091747eb45bfade115c9b977b2e14a95196aea8c6",
                "md5": "73a1bf41e509cc91ae780cff2f0075ea",
                "sha256": "aa16e5a56358e06ce8f75129d4416b9105cfe2af83088752d74b765b3c811238"
            },
            "downloads": -1,
            "filename": "mdformat_vuepress-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "73a1bf41e509cc91ae780cff2f0075ea",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 5017,
            "upload_time": "2025-08-24T15:14:59",
            "upload_time_iso_8601": "2025-08-24T15:14:59.259730Z",
            "url": "https://files.pythonhosted.org/packages/d9/0e/bac3c3289dfcf3f97df091747eb45bfade115c9b977b2e14a95196aea8c6/mdformat_vuepress-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "1a0c50c2f5348b09441c1b4e0bd88330a62ef13d82d31b356bb3a75508b0d2a7",
                "md5": "61e8c177b963486d87b9255bc81ef4ee",
                "sha256": "5ec0f17185d35f1b4235c0209ebeb0ec9a9fabcd1bd52a66fe8521c2d63e33ad"
            },
            "downloads": -1,
            "filename": "mdformat_vuepress-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "61e8c177b963486d87b9255bc81ef4ee",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 7431,
            "upload_time": "2025-08-24T15:15:00",
            "upload_time_iso_8601": "2025-08-24T15:15:00.876500Z",
            "url": "https://files.pythonhosted.org/packages/1a/0c/50c2f5348b09441c1b4e0bd88330a62ef13d82d31b356bb3a75508b0d2a7/mdformat_vuepress-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-24 15:15:00",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "mdformat-vuepress"
}

None