diff --git a/docs/installation/index.md b/docs/getting_started/installation.md similarity index 100% rename from docs/installation/index.md rename to docs/getting_started/installation.md diff --git a/docs/getting_started/quickstart.md b/docs/getting_started/quickstart.md new file mode 100644 index 00000000..a336eb93 --- /dev/null +++ b/docs/getting_started/quickstart.md @@ -0,0 +1,45 @@ +## Basic usage + +### Python + +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: + +```python +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](./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. + +### CLI + +You can additionally use Docling directly from your terminal, for instance: + +```console +docling https://arxiv.org/pdf/2206.01062 +``` + +The CLI provides various options, such as 🥚[GraniteDocling](https://huggingface.co/ibm-granite/granite-docling-258M) (incl. MLX acceleration) & other VLMs: +```bash +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](../reference/cli.md). + +## What's next + +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! diff --git a/mkdocs.yml b/mkdocs.yml index d3266ce7..5ff3ea2f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,11 +53,11 @@ theme: - toc.follow nav: - Documentation: - - "Docling documentation": index.md - - Installation: - - Installation: installation/index.md + - Documentation: index.md + - Getting started : + - Installation: getting_started/installation.md + - Quickstart: getting_started/quickstart.md - Usage: - - Usage: usage/index.md - Advanced options: usage/advanced_options.md - Supported formats: usage/supported_formats.md - Enrichment features: usage/enrichments.md @@ -183,6 +183,8 @@ plugins: - redirects: redirect_maps: getting_started/index.md: index.md + installation/index.md: getting_started/installation.md + usage/index.md: getting_started/quickstart.md - mkdocs-jupyter - mkdocstrings: default_handler: python