YAML to Markdown Converter

A Python utility to take a JSON / YAML file or a python dict / list and create a Markdown file.

Installation

pip install yaml-to-markdown

Usage

$ yaml-to-markdown --help
Convert JSON or YAML to Markdown.
Usage: yaml-to-markdown -o <output_file> [-y <yaml_file> | -j <json_file>]
    -o, --output-file <output_file>: Path to the output file as a string [Mandatory].
    -y, --yaml-file <yaml_file>: Path to the YAML file as a string [Optional]
    -j, --json-file <json_file>: Path to the JSON file as a string [Optional]
    -h, --help: Show this message and exit.
Note: Either yaml_file or json_file is required along with output_file.
Example: yaml-to-markdown -o output.md -y data.yaml

In Python Code example:

Convert a Pyton dictionary to Markdown:

from yaml_to_markdown.md_converter import MDConverter

data = {
    "name": "John Doe",
    "age": 30,
    "city": "Sydney",
    "hobbies": ["reading", "swimming"],
}
converter = MDConverter()
with open("output.md", "w") as f:
    converter.convert(data, f)

Content of output.md file will be:

## Name
John Doe
## Age
30
## City
Sydney
## Hobbies
* reading
* swimming

From the Command Line

You can also use the command line interface to convert a JSON or YAML file to Markdown. Here's an example:

Convert a JSON file to Markdown:

yaml-to-markdown --output-file output.md --json-file test.json

Convert a YAML file to Markdown:

yaml-to-markdown --output-file output.md --yaml-file test.yaml

Developer Guide

Please see the DEVELOPER.md file for more information on how to contribute to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Metadata

Release files for yaml-to-markdown 0.1.1744598339

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for yaml-to-markdown 0.1.1744598339
File	Size	Uploaded
yaml_to_markdown-0.1.1744598339.tar.gz	8.0 kB	Apr 14, 2025	Details

Built distribution (wheel)

Table of built distributions (wheels) for yaml-to-markdown 0.1.1744598339
File	Interpreter	ABI	Platform	Reset
yaml_to_markdown-0.1.1744598339-py3-none-any.whl 9.1 kB Apr 14, 2025	Python 3	none	any	Details

Total release size: 17.1 kB

Release files / yaml_to_markdown-0.1.1744598339.tar.gz

Download URL	yaml_to_markdown-0.1.1744598339.tar.gz
Size	8.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`2e425ae2a0a145f6c47cd0c1a9abfc31fb6e78c62ee63bfd33400777738b603e`
BLAKE2b-256 checksum How to use checksums	`69418934b304b8efb64fb6e5032094d5e6c694832700ea6c6c9f60f0c6d49c83`
Upload date	Apr 14, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.4`

Release files / yaml_to_markdown-0.1.1744598339-py3-none-any.whl

Download URL	yaml_to_markdown-0.1.1744598339-py3-none-any.whl
Size	9.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`f5a4e6285c276effd97c4e428f06404327334d89b21338d31f83af3aae88b9fe`
BLAKE2b-256 checksum How to use checksums	`ba8dc7d1737b8e0b6a6616df25593adf31bab92c384e4f1c2158bfde8a3899cc`
Upload date	Apr 14, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.4`