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.1712531157

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.1712531157
File	Size	Uploaded
yaml-to-markdown-0.1.1712531157.tar.gz	7.7 kB	Apr 7, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for yaml-to-markdown 0.1.1712531157
File	Interpreter	ABI	Platform	Reset
yaml_to_markdown-0.1.1712531157-py3-none-any.whl 8.9 kB Apr 7, 2024	Python 3	none	any	Details

Total release size: 16.7 kB

Release files / yaml-to-markdown-0.1.1712531157.tar.gz

Download URL	yaml-to-markdown-0.1.1712531157.tar.gz
Size	7.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`10d97b5bb6b3d0aeb05495c659a58a1b3340abf399c3b3fe02cc4e6f70e52b34`
BLAKE2b-256 checksum How to use checksums	`2fa056b88e06e44f535ae0f1127d8280b151950119fa22e847e38659a9f2b58c`
Upload date	Apr 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`

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

Download URL	yaml_to_markdown-0.1.1712531157-py3-none-any.whl
Size	8.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`85d0928d87609a107b1c5432cd07db42340d0d2e883f9d1187494569a46a3ac7`
BLAKE2b-256 checksum How to use checksums	`319cc34a2ec2a67c1ec17f3b831b7de37cc9689185def2bc8a6deefeb73d3635`
Upload date	Apr 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`