YAML to Markdown Converter

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

Usage

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

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.1712460996
File	Size	Uploaded
yaml-to-markdown-0.1.1712460996.tar.gz	7.5 kB	Apr 7, 2024	Details

Built distribution (wheel)

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

Total release size: 16.2 kB

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

Download URL	yaml-to-markdown-0.1.1712460996.tar.gz
Size	7.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`0c444f9104626170e37ed95518541b90c0841b0c18e42df80630df7bfc52e6c9`
BLAKE2b-256 checksum How to use checksums	`055aa99760c02dcf5b979422815eb0f89f75d5c9bfd4eb5d5f81390d84c3c039`
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.1712460996-py3-none-any.whl

Download URL	yaml_to_markdown-0.1.1712460996-py3-none-any.whl
Size	8.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`51aa4d5db8909bf6d4eb33a278ade3b22baed1ba0aa490669165590b96c1770c`
BLAKE2b-256 checksum How to use checksums	`4bc5b1a319ed5270ef6245fb7a5b93e422b86e7864124b40303709ba8ee3ee5a`
Upload date	Apr 7, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.0.0 CPython/3.12.2`