lint markdown

Signed-off-by: Michele Dolfi <[email protected]>

.markdownlint-cli2.yaml

@@ -2,5 +2,6 @@ config:
   line-length: false
   no-emphasis-as-header: false
   first-line-heading: false
+  allowed_elements: ["details", "summary"]
 globs:
   - "**/*.md"

README.md

@@ -2,7 +2,6 @@
 
  Running [Docling](https://github.com/DS4SD/docling) as an API service.
 
-
 ## Usage
 
 The API provides two endpoints: one for urls, one for files. This is necessary to send files directly in binary format instead of base64-encoded strings.
@@ -51,9 +50,9 @@
 }
 ```
 
 <details>
 
 <summary>CURL example:</summary>
 
 ```sh
 curl -X 'POST' \
@@ -92,10 +91,11 @@
   "input_sources": "https://arxiv.org/pdf/2206.01062"
 }'
 ```
+
 </details>
 
 <details>
 <summary>Python example:</summary>
 
 ```python
 import httpx
@@ -121,14 +121,15 @@
 
 data = response.json()
 ```
+
 </details>
 
 ### File endpoint
 
 The endpoint is: `/v1alpha/convert/file`, listening for POST requests of Form payloads (necessary as the files are sent as multipart/form data). You can send one or multiple files.
 
 <details>
 <summary>CURL example:</summary>
 
 ```sh
 curl -X 'POST' \
@@ -148,10 +149,11 @@
   -F 'return_as_file=false' \
   -F 'do_ocr=true'
 ```
+
 </details>
 
 <details>
 <summary>Python example:</summary>
 
 ```python
 import httpx
@@ -184,8 +186,8 @@
 
 data = response.json()
 ```
-</details>
 
+</details>
 
 ### Response format
 
@@ -271,7 +273,6 @@
 `RELOAD`: If `True`, this will enable auto-reload when you modify files, useful for development.
 `WITH_UI`: If `True`, The Gradio UI will be available at `/ui`.
 
-
 ## Get help and support
 
 Please feel free to connect with us using the [discussion section](https://github.com/DS4SD/docling/discussions).