Skip to main content

Mkdocs plugin to kirby content structure

Project description

mkdocs-to-kirby

A MkDocs plugin to export your documentation site for use with Kirby CMS.

Features

  • Converts MkDocs pages to Kirby-compatible content files
  • Preserves metadata and structure
  • Supports custom configuration

Installation

pip3 install mkdocs-to-kirby

Usage

Add the plugin to your mkdocs.yml:

plugins:
    - mkdocs-to-kirby

Build your site as usual:

mkdocs build

Exported content will be available in the configured output directory.

Configuration

Example configuration in mkdocs.yml:

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:

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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_to_kirby-0.11.0.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_to_kirby-0.11.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_to_kirby-0.11.0.tar.gz.

File metadata

  • Download URL: mkdocs_to_kirby-0.11.0.tar.gz
  • Upload date:
  • Size: 6.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for mkdocs_to_kirby-0.11.0.tar.gz
Algorithm Hash digest
SHA256 c60c12d26b9bcfcfc5dc0d66920f5033be76afc0ab6a565b8cac77c61c5d68f3
MD5 46c99216e357e417072b3e0703e5c5fc
BLAKE2b-256 67fa980806ff59204243d8fc756abf39340cc513d7bb4677faff3a0bb38d6ce0

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_to_kirby-0.11.0.tar.gz:

Publisher: release.yaml on kreemer/mkdocs-to-kirby

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_to_kirby-0.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_to_kirby-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08e208f7df73718af4c22a293691517b80dc6b53614903a3dd08b580d461babf
MD5 6a00e63ed70a9a62f4abc9efd0193b67
BLAKE2b-256 cc121417a1f56087bab3d5a841f245e1f4f6dd805b781546c74ce5263db70f50

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_to_kirby-0.11.0-py3-none-any.whl:

Publisher: release.yaml on kreemer/mkdocs-to-kirby

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page