Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JsonConverter for Converting JSON Files into Structured Markdown Files #251

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

JsonConverter for Converting JSON Files into Structured Markdown Files #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions src/markitdown/_markitdown.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1204,6 +1204,42 @@ def convert(
text_content=f"[ERROR] Failed to process zip file {local_path}: {str(e)}",
)

class JsonConverter(DocumentConverter):
"""
Converts Jsons to Markdown. The output preserves the structure of the JSON file as closely as possible, while using Markdown syntax for readability.
"""

def convert(self, local_path, **kwargs) -> Union[None, DocumentConverterResult]:
# Bail if not a Json
extension = kwargs.get("file_extension", "")
if extension.lower() != ".json":
return None

list_heading = kwargs.get("list_heading", "Elem")
with open(local_path, "r") as f:
json_data = json.load(f)

md_content = ""

if isinstance(json_data, dict):
md_content += json.dumps(json_data, indent=4, ensure_ascii=False) + "\n"
elif isinstance(json_data, list):
for idx, item in enumerate(json_data, start=1):
md_content += f"# {list_heading} {idx}\n"
if isinstance(item, (dict, list)):
md_content += json.dumps(item, indent=4, ensure_ascii=False) + "\n\n"
else:
md_content += f"{item}\n\n"
else:
md_content += f"{json_data}\n"

# removing tailing \n
md_content = md_content.strip()

return DocumentConverterResult(
title=None,
text_content=md_content,
)

class FileConversionException(BaseException):
pass
Expand Down Expand Up @@ -1276,6 +1312,7 @@ def __init__(
self.register_page_converter(WikipediaConverter())
self.register_page_converter(YouTubeConverter())
self.register_page_converter(BingSerpConverter())
self.register_page_converter(JsonConverter())
self.register_page_converter(DocxConverter())
self.register_page_converter(XlsxConverter())
self.register_page_converter(PptxConverter())
Expand Down