microsoft / microsoft/markitdown

Unified Document Structure for Enhanced DocumentConverterResult

Open
#94 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement question
Dominant language
Python
Stars
186k
Forks
13.7k
Avg merge
1d 4h
Merged PRs (30d)
49

Description

Hi! First of all, Markitdown is awesome! I’d like to know if you have any plans to introduce a unified Document structure to represent the DocumentConverterResult. This would include detailed information about all the contents of the document, such as page numbers, what each page has as contents, images on each page (for PDFs), etc. Or do you intend to keep the output as a simple Markdown string for the entire document?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating DocumentConverterResult and the conversion entry points that currently return a Markdown string. Review how page contents and PDF images are represented today; done would require a decided unified Document structure or an explicit decision to retain the current string output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design, content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.