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.3.tar.gz (6.7 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.3-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_to_kirby-0.11.3.tar.gz
Algorithm Hash digest
SHA256 3ffd2da4b6e4cc919a69350b88f81e903083b937a2ef7262d9c4159dc88bcbdb
MD5 ad9723c23ee7e6f19365e851f7a8573f
BLAKE2b-256 48f579bd646ad0cc274632a32cca71dc5f54dffb646b22b6292d37137b1d4a6a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for mkdocs_to_kirby-0.11.3-py3-none-any.whl
Algorithm Hash digest
SHA256 06d714e845ba46b8cb716f371221b52b77246c938070d85e48f816ace841f277
MD5 c71df2b1d24d3c0b6ce525cf69fee888
BLAKE2b-256 08a696cb9571ad33a7ad50ff0bec5c9e540971a673f9331ae75bea5a5888fed5

See more details on using hashes here.

Provenance

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