mirror of
https://github.com/DS4SD/docling.git
synced 2025-12-08 12:48:28 +00:00
docs: Move Installation and Quickstart (Usage) under Getting started (#2644)
* 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>
This commit is contained in:
45
docs/getting_started/quickstart.md
vendored
Normal file
45
docs/getting_started/quickstart.md
vendored
Normal file
@@ -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!
|
||||||
10
mkdocs.yml
10
mkdocs.yml
@@ -53,11 +53,11 @@ theme:
|
|||||||
- toc.follow
|
- toc.follow
|
||||||
nav:
|
nav:
|
||||||
- Documentation:
|
- Documentation:
|
||||||
- "Docling documentation": index.md
|
- Documentation: index.md
|
||||||
- Installation:
|
- Getting started :
|
||||||
- Installation: installation/index.md
|
- Installation: getting_started/installation.md
|
||||||
|
- Quickstart: getting_started/quickstart.md
|
||||||
- Usage:
|
- Usage:
|
||||||
- Usage: usage/index.md
|
|
||||||
- Advanced options: usage/advanced_options.md
|
- Advanced options: usage/advanced_options.md
|
||||||
- Supported formats: usage/supported_formats.md
|
- Supported formats: usage/supported_formats.md
|
||||||
- Enrichment features: usage/enrichments.md
|
- Enrichment features: usage/enrichments.md
|
||||||
@@ -183,6 +183,8 @@ plugins:
|
|||||||
- redirects:
|
- redirects:
|
||||||
redirect_maps:
|
redirect_maps:
|
||||||
getting_started/index.md: index.md
|
getting_started/index.md: index.md
|
||||||
|
installation/index.md: getting_started/installation.md
|
||||||
|
usage/index.md: getting_started/quickstart.md
|
||||||
- mkdocs-jupyter
|
- mkdocs-jupyter
|
||||||
- mkdocstrings:
|
- mkdocstrings:
|
||||||
default_handler: python
|
default_handler: python
|
||||||
|
|||||||
Reference in New Issue
Block a user