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.10.0.tar.gz (6.2 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.10.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_to_kirby-0.10.0.tar.gz
  • Upload date:
  • Size: 6.2 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.10.0.tar.gz
Algorithm Hash digest
SHA256 e12025dd19b96f2dd7e7737723f34512e1924ad8517fdc388997b121eff7891f
MD5 edc015e19cd99bb56a7040cced2a0d23
BLAKE2b-256 86a8aa66be47d83ae4e6cc6dc51761e7d7164683c7bf15a04c6d9322332ef1bf

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_to_kirby-0.10.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.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_to_kirby-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a829f94c5ef72b73349f7d13b50caaff06cb8cf34e0d7c2f9d5f4863ad46c415
MD5 db223b6c7609b1088fc4d4f22f4feda0
BLAKE2b-256 75f221a1ea9ede6997409a9de0867548924c9d5461ae815c8582183308f1da89

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_to_kirby-0.10.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