mirrors/docling
1
0
Fork 0
mirror of https://github.com/DS4SD/docling.git synced 2025-12-08 12:48:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: combine Home and Getting Started pages (#2600)

Browse Source 
* Update mkdocs.yml

Remove navigations.sections feature so that navigation menus will collapse & expand. They are collapsed by default.

* docs: add sign-off

DCO Remediation Commit for Robyn J <bobbinrobyn@users.noreply.github.com>

I, Robyn J <bobbinrobyn@users.noreply.github.com>, hereby add my Signed-off-by to this commit: b7d7441827

Signed-off-by: Robyn J <bobbinrobyn@users.noreply.github.com>

* docs: Combine Home and Getting Started page

Combine home and getting stated pages, and rename the page "Documentation"

Signed-off-by: Robyn J <bobbinrobyn@users.noreply.github.com>

---------

Signed-off-by: Robyn J <bobbinrobyn@users.noreply.github.com>
This commit is contained in:
Robyn Johnson
2025-11-14 06:29:25 -06:00
committed by GitHub
parent 14b436d590
commit ae30373ee7
3 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/getting_started/index.md vendored
View File

@@ -1,18 +1 @@
🐣 Ready to kick off your Docling journey? Let's dive right into it!
<div class="grid">
<a href="../installation/" class="card"><b>⬇️ Installation</b><br />Quickly install Docling in your environment</a>
<a href="../usage/" class="card"><b>▶️ Usage</b><br />Get a jumpstart on basic Docling usage</a>
<a href="../concepts/" class="card"><b>🧩 Concepts</b><br />Learn Docling fundamentals and get a glimpse under the hood</a>
<a href="../examples/" class="card"><b>🧑🏽‍🍳 Examples</b><br />Try out recipes for various use cases, including conversion, RAG, and more</a>
<a href="../integrations/" class="card"><b>🤖 Integrations</b><br />Check out integrations with popular AI tools and frameworks</a>
<a href="../reference/document_converter/" class="card"><b>📖 Reference</b><br />See more API details</a>
</div>
## What's next
🚀 The journey has just begun! Join us and become a part of the growing Docling community!
- <a href="https://github.com/docling-project/docling">:fontawesome-brands-github: GitHub</a>
- <a href="https://docling.ai/discord">:fontawesome-brands-discord: Discord</a>
- <a href="https://linkedin.com/company/docling/">:fontawesome-brands-linkedin: LinkedIn</a>

21
docs/index.md vendored
View File

@@ -20,6 +20,19 @@
Docling simplifies document processing, parsing diverse formats — including advanced PDF understanding — and providing seamless integrations with the gen AI ecosystem.
## Getting started
🐣 Ready to kick off your Docling journey? Let's dive right into it!
<div class="grid">
<a href="../installation/" class="card"><b>⬇️ Installation</b><br />Quickly install Docling in your environment</a>
<a href="../usage/" class="card"><b>▶️ Usage</b><br />Get a jumpstart on basic Docling usage</a>
<a href="../concepts/" class="card"><b>🧩 Concepts</b><br />Learn Docling fundamentals and get a glimpse under the hood</a>
<a href="../examples/" class="card"><b>🧑🏽‍🍳 Examples</b><br />Try out recipes for various use cases, including conversion, RAG, and more</a>
<a href="../integrations/" class="card"><b>🤖 Integrations</b><br />Check out integrations with popular AI tools and frameworks</a>
<a href="../reference/document_converter/" class="card"><b>📖 Reference</b><br />See more API details</a>
</div>
## Features
* 🗂️ Parsing of [multiple document formats][supported_formats] incl. PDF, DOCX, PPTX, XLSX, HTML, WAV, MP3, VTT, images (PNG, TIFF, JPEG, ...), and more
@@ -46,9 +59,13 @@ Docling simplifies document processing, parsing diverse formats — including ad
* 📝 Chart understanding (Barchart, Piechart, LinePlot, etc)
* 📝 Complex chemistry understanding (Molecular structures)
## Get started
## What's next
Check out our [getting started](./getting_started/index.md) page to get the ball rolling!
🚀 The journey has just begun! Join us and become a part of the growing Docling community!
- <a href="https://github.com/docling-project/docling">:fontawesome-brands-github: GitHub</a>
- <a href="https://docling.ai/discord">:fontawesome-brands-discord: Discord</a>
- <a href="https://linkedin.com/company/docling/">:fontawesome-brands-linkedin: LinkedIn</a>
## Live assistant

6
mkdocs.yml
View File

@@ -52,10 +52,8 @@ theme:
- search.suggest
- toc.follow
nav:
- Home:
- "Docling": index.md
- Getting started:
- Getting started: getting_started/index.md
- Documentation:
- "Docling documentation": index.md
- Installation:
- Installation: installation/index.md
- Usage: