Skip to content

Commit

Permalink
Merge pull request #177 from pymupdf/updates-READMEs
Browse files Browse the repository at this point in the history
Fixes some code samples in the READMEs.
  • Loading branch information
jamie-lemon authored Nov 1, 2024
2 parents e20b9e7 + 1a9d5dc commit b257182
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ To create small **chunks of text** - as opposed to generating one large string f

Also new in version 0.0.2 is the optional **extraction of images** and vector graphics: use of parameter `write_images=True`. The will store PNG images in the document's folder, and the Markdown text will appropriately refer to them. The images are named like `"input.pdf-page_number-index.png"`.

# Documentation and API

[Documentation](https://pymupdf.readthedocs.io/en/latest/pymupdf4llm/index.html)

[API](https://pymupdf.readthedocs.io/en/latest/pymupdf4llm/api.html#pymupdf4llm-api)

# Document Support

While PDF is by far the most important document format worldwide, it is worthwhile mentioning that all examples and helper scripts work in the same way and **_without change_** for [all supported file types](https://pymupdf.readthedocs.io/en/latest/how-to-open-a-file.html#supported-file-types).
Expand Down
2 changes: 1 addition & 1 deletion pdf4llm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Instead of the filename string as above, one can also provide a PyMuPDF `Documen
```python
import pdf4llm

md_read = LlamaMarkdownReader()
md_read = pdf4llm.LlamaMarkdownReader()
data = md_read.load_data("input.pdf")

# The result 'data' is of type List[LlamaIndexDocument]
Expand Down
2 changes: 1 addition & 1 deletion pymupdf4llm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Instead of the filename string as above, one can also provide a PyMuPDF `Documen
```python
import pymupdf4llm

md_read = LlamaMarkdownReader()
md_read = pymupdf4llm.LlamaMarkdownReader()
data = md_read.load_data("input.pdf")

# The result 'data' is of type List[LlamaIndexDocument]
Expand Down

0 comments on commit b257182

Please sign in to comment.