Skip to main content

MkDocs plugin that allows to read data from markup files

Project description

mkdocs-data-plugin

MkDocs Data Plugin is a plugin for MkDocs that allows reading data from markup files and use it in your Markdown pages.

Currently supported formats:

  • JSON: .json
  • YAML: .yml, .yaml

Documentation

This plugin documentation can be found here: https://joapuiib.github.io/mkdocs-data-plugin/

Installation

This plugin can be installed via pip:

pip install mkdocs-data-plugin

Configuration

Activate the plugin in your mkdocs.yml:

plugins:
  - macros
  - data

Overview

When using this plugin, you can define data in YAML or JSON files in a separate directory and reference them in your Markdown files.

root/
├── docs/
│   └── ...
├── data/
│   └── fruits.yml
└── mkdocs.yml
- Apple
- Banana
- Strawberry

Files in this directory can be referenced in your Markdown files using the data variable.

{% for fruit in data.fruits -%}
- {{ fruit }}
{% endfor %}

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_data_plugin-0.3.0.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

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

mkdocs_data_plugin-0.3.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_data_plugin-0.3.0.tar.gz.

File metadata

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

File hashes

Hashes for mkdocs_data_plugin-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5845f12064e32ec4a786e4144c22d63669b164a6aa584f94e46da0fe27870020
MD5 26f0a1d209a417f7238c9b97643a1852
BLAKE2b-256 7ad92e2abd32a45591525c44456ff8eee6d8b3e01bd7bbc58a415ad761d58b91

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_data_plugin-0.3.0.tar.gz:

Publisher: publish-to-pypi.yml on joapuiib/mkdocs-data-plugin

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_data_plugin-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_data_plugin-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 76c1f1ab26f73ffd7d3a357640d1559846ef0f71907013488f0059114ec74679
MD5 92d70b63caeb0da4d32380a121bf097a
BLAKE2b-256 4f68b1ad05672beccb092fd534f40eb5b8835cfc86e4821d4d4bc7558d28642e

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_data_plugin-0.3.0-py3-none-any.whl:

Publisher: publish-to-pypi.yml on joapuiib/mkdocs-data-plugin

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