A simple tool to convert Markdown (CommonMark dialect) data into JSON. It uses headings as JSON keys, and the stuff following headings as values. Lists are turned into arrays. Higher heading values yield nested JSON keys.
If you have to ask that question, it probably isn't. Here are some cases where I'd recommend something else:
In this case, I'd recommend the excellent markdown-it-py
In this case, TOML might be what you're looking for. Python support is built-in as of 3.11. If I had known of TOML, I would never have written this package.
If you don't mind the loss of fidelity to the exact Markdown Document Object Model (DOM), you can get a simple python or json data structure to extract data-like structures from a subset of Markdown documents.
This tool was built to allow easier creation of dataset descriptions for the Brain Imaging Data Structure data sharing specification.
Non isolated install from pypi
pip install markdown-to-json
md_to_json --helpIsolated install with pipx if you only want the CLI
pipx install markdown-to-json
md_to_json --helpInstall bleeding edge from github
pip install git+https://github.com/njvack/markdown-to-json/
python -m markdown_to_json --helpgit clone https://github.com/njvack/markdown-to-json.git
cd markdown_to_json
./setup.py installThe package has no external requirements and has been tested python 3.6+.
Please use version 1 or 1.1 for python 2.x.
Translate Markdown into JSON.
Usage:
md_to_json [options] <markdown_file>
md_to_json -h | --help
Options:
-h --help Show this screen
--version Print version number
-o <file> Save output to a file instead of stdout
-i <val> Indent nested JSON by this amount. Use a negative number for
most compact possible JSON. the [default: 2]
import markdown_to_json
value = """
# Nested List
* Item 1
* Item 1.1
* Item 2
"""
# The simple way:
dictified = markdown_to_json.dictify(value)
assert dictified == {'Nested List': ['Item 1', ['Item 1.1'], 'Item 2']}
# Or, if you want a json string
jsonified = markdown_to_json.jsonify(value)
assert jsonified == """{"Nested List": ["Item 1", ["Item 1.1"], "Item 2"]}"""This translates a Markdown document into JSON as described in the example below.
The Markdown:
# Description
This is an example file
# Authors
* Nate Vack
* Vendor Packages
* docopt
* CommonMark-py
# Versions
## Version 1
Here's something about Version 1; I said "Hooray!"
## Version 2
Here's something about Version 2will translate to the JSON:
{
"Description": "This is an example file",
"Authors": ["Nate Vack", "Vendor Packages", ["docopt", "CommonMark-py"]],
"Versions": {
"Version 1": "Here's something about Version 1; I said \"Hooray!\"",
"Version 2": "Here's something about Version 2"
}
}markdown_to_json was written by Nate Vack at the Center for Healthy Minds at the University of Wisconsin–Madison.
Maintenance development by Matthew Martin
This tool ships a few really excellent tools in its vendor directory:
docopt is copyright (c) 2012 Vladimir Keleshev, [email protected]
Upgraded to docopt-ng.
CommonMark-py is copyright Copyright (c) 2014, Bibek Kafle and Roland Shoemaker.
Cannot upgrade to 0.6.0 because of breaking changes in AST.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent