# mkdocs-to-kirby
A MkDocs plugin to export your documentation site for use with [Kirby CMS](https://getkirby.com/).
## Features
- Converts MkDocs pages to Kirby-compatible content files
- Preserves metadata and structure
- Supports custom configuration
## Installation
```bash
pip3 install mkdocs-to-kirby
```
## Usage
Add the plugin to your `mkdocs.yml`:
```yaml
plugins:
- mkdocs-to-kirby
```
Build your site as usual:
```bash
mkdocs build
```
Exported content will be available in the configured output directory.
## Configuration
Example configuration in `mkdocs.yml`:
```yaml
plugins:
- mkdocs-to-kirby:
output_dir: kirby-content
default_template: "doc"
# default_language: "en"
```
## Requirements
- Python 3
- MkDocs
## Development
Clone the repository and install dependencies:
```bash
git clone https://github.com/kreemer/mkdocs-to-kirby.git
cd mkdocs-to-kirby
pip3 install -e .
```
## License
MIT
## Contributing
Pull requests and issues are welcome!
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-to-kirby",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "mkdocs, kirby, plugin",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8b/cf/af99308a9bdfd2c9369f80579e1cff12d437db004684d4319e1ad89bb64e/mkdocs_to_kirby-0.11.1.tar.gz",
"platform": null,
"description": "# mkdocs-to-kirby\n\nA MkDocs plugin to export your documentation site for use with [Kirby CMS](https://getkirby.com/).\n\n## Features\n\n- Converts MkDocs pages to Kirby-compatible content files\n- Preserves metadata and structure\n- Supports custom configuration\n\n## Installation\n\n```bash\npip3 install mkdocs-to-kirby\n```\n\n## Usage\n\nAdd the plugin to your `mkdocs.yml`:\n\n```yaml\nplugins:\n - mkdocs-to-kirby\n```\n\nBuild your site as usual:\n\n```bash\nmkdocs build\n```\n\nExported content will be available in the configured output directory.\n\n## Configuration\n\nExample configuration in `mkdocs.yml`:\n\n```yaml\nplugins:\n - mkdocs-to-kirby:\n output_dir: kirby-content\n default_template: \"doc\"\n #\u00a0default_language: \"en\"\n```\n\n## Requirements\n\n- Python 3\n- MkDocs\n\n## Development\n\nClone the repository and install dependencies:\n\n```bash\ngit clone https://github.com/kreemer/mkdocs-to-kirby.git\ncd mkdocs-to-kirby\npip3 install -e .\n```\n\n## License\n\nMIT\n\n## Contributing\n\nPull requests and issues are welcome!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mkdocs plugin to kirby content structure",
"version": "0.11.1",
"project_urls": {
"Homepage": "https://github.com/kreemer/mkdocs-to-kirby"
},
"split_keywords": [
"mkdocs",
" kirby",
" plugin"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "61b7e1aa08dea5a173b4dab91339f5f50fcbd7953ad8c15f541125975f204695",
"md5": "68e4e6559dfbb3ef62579e1bb25bbce1",
"sha256": "d4638a8f199437e196ee7391c284135220440a8edae622fb8b467dd2e1fb87bc"
},
"downloads": -1,
"filename": "mkdocs_to_kirby-0.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "68e4e6559dfbb3ef62579e1bb25bbce1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 6913,
"upload_time": "2025-09-18T08:18:48",
"upload_time_iso_8601": "2025-09-18T08:18:48.475182Z",
"url": "https://files.pythonhosted.org/packages/61/b7/e1aa08dea5a173b4dab91339f5f50fcbd7953ad8c15f541125975f204695/mkdocs_to_kirby-0.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "8bcfaf99308a9bdfd2c9369f80579e1cff12d437db004684d4319e1ad89bb64e",
"md5": "f2ba0fc396e3831ed30005c22b8f6a21",
"sha256": "f063bcf2c83f5f81c1ab017787e4de484046f8c26c236d6a8532a7c3507adaa6"
},
"downloads": -1,
"filename": "mkdocs_to_kirby-0.11.1.tar.gz",
"has_sig": false,
"md5_digest": "f2ba0fc396e3831ed30005c22b8f6a21",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 6583,
"upload_time": "2025-09-18T08:18:49",
"upload_time_iso_8601": "2025-09-18T08:18:49.457439Z",
"url": "https://files.pythonhosted.org/packages/8b/cf/af99308a9bdfd2c9369f80579e1cff12d437db004684d4319e1ad89bb64e/mkdocs_to_kirby-0.11.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-18 08:18:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kreemer",
"github_project": "mkdocs-to-kirby",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pre-commit",
"specs": [
[
"~=",
"4.2"
]
]
},
{
"name": "mkdocs",
"specs": []
},
{
"name": "mkdocs-material",
"specs": []
},
{
"name": "mkdocs-static-i18n",
"specs": []
}
],
"lcname": "mkdocs-to-kirby"
}
JSON
