Skip to content

Commit

Permalink
lint markdown
Browse files Browse the repository at this point in the history
Signed-off-by: Michele Dolfi <[email protected]>
  • Loading branch information
dolfim-ibm committed Jan 27, 2025
1 parent 6a5aa98 commit 407d827
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
1 change: 1 addition & 0 deletions .markdownlint-cli2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@ config:
line-length: false
no-emphasis-as-header: false
first-line-heading: false
allowed_elements: ["details", "summary"]
globs:
- "**/*.md"
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -92,6 +91,7 @@ curl -X 'POST' \
"input_sources": "https://arxiv.org/pdf/2206.01062"
}'
```

</details>

<details>

Check failure on line 97 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Inline HTML

README.md:97:1 MD033/no-inline-html Inline HTML [Element: details] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
Expand Down Expand Up @@ -121,6 +121,7 @@ response = await async_client_client.post(url, json=payload)

data = response.json()
```

</details>

### File endpoint
Expand Down Expand Up @@ -148,6 +149,7 @@ curl -X 'POST' \
-F 'return_as_file=false' \
-F 'do_ocr=true'
```

</details>

<details>

Check failure on line 155 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Inline HTML

README.md:155:1 MD033/no-inline-html Inline HTML [Element: details] https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
Expand Down Expand Up @@ -184,8 +186,8 @@ assert response.status_code == 200, "Response should be 200 OK"

data = response.json()
```
</details>

</details>

### Response format

Expand Down Expand Up @@ -271,7 +273,6 @@ The following variables are available:
`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).
Expand Down

0 comments on commit 407d827

Please sign in to comment.