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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_to_kirby-0.11.2.tar.gz
  • Upload date:
  • Size: 6.6 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.2.tar.gz
Algorithm Hash digest
SHA256 40bd3782bfbf60c53bd269e01cb1e4125298884eccd3107882a5775793adaddf
MD5 7bef5d7cc2d11a722c90cfd33aa8f4c3
BLAKE2b-256 8ea204a639a1a27efc22319510735ba5bd11c7bb4dc5ceb65d9e2cc9eecbd32a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for mkdocs_to_kirby-0.11.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e7d0327609d2c55ae1c15ea4ab322e152fa53023236c8cab7a3af3a7d9b3bd66
MD5 3db4ab4cded1186d0cc1c4e54c860a05
BLAKE2b-256 1cda50374d92923f18f0f768e908bf7113da16573b02b9c7c51ccc8e47470515

See more details on using hashes here.

Provenance

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