d549445e78
* docs: Move Installation and Quickstart (Usage) under Getting started Moved Installation and Usage (Quickstart) under Getting started section Rename installation folder to documentation folder Rename installation/index.md to documentation/installation.md Duplicate usage/index.md to documentation directory and rename it to documentation/quickstart.md Add redirection from installation and usage Signed-off-by: Ryan S <ryansoliveres@users.noreply.github.com> * docs: Move Installation and Quickstart under Getting started Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com> * docs: Move Installation and Quickstart under Getting started Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com> * git commit -m "DCO Remediation Commit for rysoliveres <ryan.soliveres@yahoo.com> I, rysoliveres <ryan.soliveres@yahoo.com>, hereby add my Signed-off-by to this commit:b7ae13e3d8Signed-off-by: rysoliveres <ryan.soliveres@yahoo.com>" Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com> * git commit --allow-empty -m "DCO Remediation Commit for rysoliveres <ryan.soliveres@yahoo.com> I, rysoliveres <ryan.soliveres@yahoo.com>, hereby add my Signed-off-by to this commit:b7ae13e3d8Signed-off-by: rysoliveres <ryan.soliveres@yahoo.com>" Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com> * DCO Remediation Commit for rysoliveres <ryan.soliveres@yahoo.com> I, rysoliveres <ryan.soliveres@yahoo.com>, hereby add my Signed-off-by to this commit:b7ae13e3d8Signed-off-by: rysoliveres <ryan.soliveres@yahoo.com> Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com> * DCO Remediation Commit for rysoliveres <ryan.soliveres@yahoo.com> I, rysoliveres <ryan.soliveres@yahoo.com>, hereby add my Signed-off-by to this commit:b7ae13e3d8Signed-off-by: rysoliveres <ryan.soliveres@yahoo.com> Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com> --------- Signed-off-by: Ryan S <ryansoliveres@users.noreply.github.com> Signed-off-by: ryansoliveres <ryan.soliveres@yahoo.com>
1.5 KiB
Vendored
Basic usage
Python
In Docling, working with documents is as simple as:
- converting your source file to a Docling document
- using that Docling document for your workflow
For example, the snippet below shows conversion with export to Markdown:
from docling.document_converter import DocumentConverter
source = "https://arxiv.org/pdf/2408.09869" # file path or URL
converter = DocumentConverter()
doc = converter.convert(source).document
print(doc.export_to_markdown()) # output: "### Docling Technical Report[...]"
Docling supports a wide array of file formats and, as outlined in the architecture guide, provides a versatile document model along with a full suite of supported operations.
CLI
You can additionally use Docling directly from your terminal, for instance:
docling https://arxiv.org/pdf/2206.01062
The CLI provides various options, such as 🥚GraniteDocling (incl. MLX acceleration) & other VLMs:
docling --pipeline vlm --vlm-model granite_docling https://arxiv.org/pdf/2206.01062
For all available options, run docling --help or check the CLI reference.
What's next
Check out the Usage subpages (navigation menu on the left) as well as our featured examples for additional usage workflows, including conversion customization, RAG, framework integrations, chunking, serialization, enrichments, and much more!