{"id":15048510,"url":"https://github.com/anevis/yaml-to-markdown","last_synced_at":"2026-02-19T03:02:55.690Z","repository":{"id":231800952,"uuid":"782260556","full_name":"anevis/yaml-to-markdown","owner":"anevis","description":"A Python utility to take a JSON / YAML file or a python dict / list and create a Markdown file.","archived":false,"fork":false,"pushed_at":"2024-04-08T12:19:07.000Z","size":30,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-09T05:02:45.686Z","etag":null,"topics":["converter","json","markdown","md","python","yaml"],"latest_commit_sha":null,"homepage":"https://anevis.github.io/json-to-markdown/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anevis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-04-05T00:16:28.000Z","updated_at":"2024-04-15T08:41:54.398Z","dependencies_parsed_at":"2024-04-15T08:54:04.009Z","dependency_job_id":null,"html_url":"https://github.com/anevis/yaml-to-markdown","commit_stats":null,"previous_names":["anevis/json-to-markdown","anevis/yaml-to-markdown"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anevis%2Fyaml-to-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anevis%2Fyaml-to-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anevis%2Fyaml-to-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anevis%2Fyaml-to-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anevis","download_url":"https://codeload.github.com/anevis/yaml-to-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243495495,"owners_count":20299923,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["converter","json","markdown","md","python","yaml"],"created_at":"2024-09-24T21:13:37.555Z","updated_at":"2026-02-19T03:02:50.664Z","avatar_url":"https://github.com/anevis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# YAML to Markdown Converter\n\nA Python utility to take a JSON / YAML file or a python dict / list and create a Markdown file.\n\n## Installation\n\n```bash\npip install yaml-to-markdown\n```\n\n## Usage\n\n```bash\n$ yaml-to-markdown --help\nConvert JSON or YAML to Markdown.\nUsage: yaml-to-markdown -o \u003coutput_file\u003e [-y \u003cyaml_file\u003e | -j \u003cjson_file\u003e]\n    -o, --output-file \u003coutput_file\u003e: Path to the output file as a string [Mandatory].\n    -y, --yaml-file \u003cyaml_file\u003e: Path to the YAML file as a string [Optional]\n    -j, --json-file \u003cjson_file\u003e: Path to the JSON file as a string [Optional]\n    -h, --help: Show this message and exit.\nNote: Either yaml_file or json_file is required along with output_file.\nExample: yaml-to-markdown -o output.md -y data.yaml\n```\n\n### In Python Code example:\n\n#### Convert a Pyton dictionary to Markdown:\n```python\nfrom yaml_to_markdown.md_converter import MDConverter\n\ndata = {\n    \"name\": \"John Doe\",\n    \"age\": 30,\n    \"city\": \"Sydney\",\n    \"hobbies\": [\"reading\", \"swimming\"],\n}\nconverter = MDConverter()\nwith open(\"output.md\", \"w\") as f:\n    converter.convert(data, f)\n```\nContent of `output.md` file will be:\n```markdown\n## Name\nJohn Doe\n## Age\n30\n## City\nSydney\n## Hobbies\n* reading\n* swimming\n```\n\n### From the Command Line\n\nYou can also use the command line interface to convert a JSON or YAML file to Markdown. Here's an example:\n\n#### Convert a JSON file to Markdown:\n```bash\nyaml-to-markdown --output-file output.md --json-file test.json\n```\n\n#### Convert a YAML file to Markdown:\n```bash\nyaml-to-markdown --output-file output.md --yaml-file test.yaml\n```\n\n## Developer Guide\nPlease see the [DEVELOPER.md](docs/DEVELOPER.md) file for more information on how to contribute to this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanevis%2Fyaml-to-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanevis%2Fyaml-to-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanevis%2Fyaml-to-markdown/lists"}