2025-08-21 08:44:53 +02:00
|
|
|
## Basic usage
|
2024-10-17 18:14:48 +02:00
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
### Python
|
2024-10-17 18:14:48 +02:00
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
In Docling, working with documents is as simple as:
|
|
|
|
|
|
|
|
1. converting your source file to a Docling document
|
|
|
|
2. using that Docling document for your workflow
|
|
|
|
|
|
|
|
For example, the snippet below shows conversion with export to Markdown:
|
2024-10-17 18:14:48 +02:00
|
|
|
|
|
|
|
```python
|
|
|
|
from docling.document_converter import DocumentConverter
|
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
source = "https://arxiv.org/pdf/2408.09869" # file path or URL
|
2024-10-17 18:14:48 +02:00
|
|
|
converter = DocumentConverter()
|
2025-08-21 08:44:53 +02:00
|
|
|
doc = converter.convert(source).document
|
|
|
|
|
|
|
|
print(doc.export_to_markdown()) # output: "### Docling Technical Report[...]"
|
2024-10-17 18:14:48 +02:00
|
|
|
```
|
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
Docling supports a wide array of [file formats](./supported_formats.md) and, as outlined in the
|
|
|
|
[architecture](../concepts/architecture.md) guide, provides a versatile document model along with a full suite of
|
|
|
|
supported operations.
|
|
|
|
|
2024-10-17 18:14:48 +02:00
|
|
|
### CLI
|
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
You can additionally use Docling directly from your terminal, for instance:
|
2024-10-17 18:14:48 +02:00
|
|
|
|
|
|
|
```console
|
|
|
|
docling https://arxiv.org/pdf/2206.01062
|
|
|
|
```
|
2025-08-21 08:44:53 +02:00
|
|
|
|
|
|
|
The CLI provides various options, such as 🥚[SmolDocling](https://huggingface.co/ds4sd/SmolDocling-256M-preview) (incl. MLX acceleration) & other VLMs:
|
2025-03-19 15:38:54 +01:00
|
|
|
```bash
|
|
|
|
docling --pipeline vlm --vlm-model smoldocling https://arxiv.org/pdf/2206.01062
|
|
|
|
```
|
2024-10-17 18:14:48 +02:00
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
For all available options, run `docling --help` or check the [CLI reference](../reference/cli.md).
|
2025-01-26 08:10:33 +01:00
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
## What's next
|
2025-01-26 08:10:33 +01:00
|
|
|
|
2025-08-21 08:44:53 +02:00
|
|
|
Check out the Usage subpages (navigation menu on the left) as well as our [featured examples](../examples/index.md) for
|
|
|
|
additional usage workflows, including conversion customization, RAG, framework integrations, chunking, serialization,
|
|
|
|
enrichments, and much more!
|