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.
1 maintainer
Metadata
1 maintainer
Release files for yaml-to-markdown 0.1.1712383579
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| yaml-to-markdown-0.1.1712383579.tar.gz | 7.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| yaml_to_markdown-0.1.1712383579-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.1 kB
Release files / yaml-to-markdown-0.1.1712383579.tar.gz
| Download URL | yaml-to-markdown-0.1.1712383579.tar.gz |
|---|---|
| Size | 7.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bebb14e40c20cadb49f0dc9ab76dc9aff3d29b63edecfbcc3e63b3f990d1027b
|
|
BLAKE2b-256 checksum How to use checksums |
ae75542d222f45213bd070528d6d76a3f0ed3ff0b26443f90dab3da891d73865
|
| Upload date | |
|
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.1712383579-py3-none-any.whl
| Download URL | yaml_to_markdown-0.1.1712383579-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9a0e3ce4ba4fcd5d275e78e530d80aa5fc10d9f19f8b51e95c333c5cb1dc031f
|
|
BLAKE2b-256 checksum How to use checksums |
c6fcad0ac6076cf6b4e7fe54c8b299ee6e4b1145ba91ddc318ab2701374f5dd5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.12.2
|
