njvack/markdown-to-json

Topics with content + subtopics

Closed this issue · 3 comments

Even though it might not be best practice, there is markdown which follow below format.

value = """
# 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

"""

When this is jsonified, the content under the main topic This is an example file gets lost.

'{"Description": {"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"}}}'
Is there a good way of handling this situation?

What behavior would you suggest?

Yeah, there's no standard for doing this transformation. There's a huge amount of valid markdown that doesn't have a reasonable translation to json.

I will very much go on the record saying I generally don't think anyone should use this package ;-)