mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
ecc0a45f0e
* fix(docs): keep gray-matter on js-yaml 3 so the docs site builds The js-yaml >=4.2.0 override from #257 forced js-yaml 4 onto gray-matter (used by vitepress and vitepress-plugin-llms), which calls the removed yaml.safeLoad and broke `vitepress build`. Scope a gray-matter>js-yaml ^3.14.1 override so gray-matter keeps the v3 API (build-time, trusted frontmatter only) while app code stays on js-yaml 4.2.0+. * docs: add per-tool reference pages for all 157 tools, with a modality sidebar Generate /tools/<id> pages for the 104 tools that lacked one (video 29, audio 17, document 36, data 10, and 12 newer image tools), matching the existing page format (API endpoint, parameters from the OpenAPI spec, curl example, response, notes). Async/AI tools document the 202+SSE flow and feature-bundle requirement. Sidebar: add Video / Audio / PDF & Documents / Data groups with per-tool links, fold the 12 new image tools into the existing image categories, and replace the placeholder rest.md-anchor group. Docs site builds cleanly (157 pages, no dead links).
44 lines
1.0 KiB
Markdown
44 lines
1.0 KiB
Markdown
---
|
|
description: Convert an HTML file to PDF.
|
|
---
|
|
|
|
# HTML to PDF
|
|
|
|
Convert an HTML file to a styled PDF document. Remote resources (external images, stylesheets, scripts) are disabled for privacy.
|
|
|
|
## API Endpoint
|
|
|
|
`POST /api/v1/tools/html-to-pdf`
|
|
|
|
Accepts multipart form data with an HTML file.
|
|
|
|
## Parameters
|
|
|
|
This tool has no configurable parameters. Upload an HTML file and it will be converted to PDF.
|
|
|
|
## Example Request
|
|
|
|
```bash
|
|
curl -X POST http://localhost:1349/api/v1/tools/html-to-pdf \
|
|
-H "Authorization: Bearer si_your-api-key" \
|
|
-F "file=@page.html"
|
|
```
|
|
|
|
## Example Response
|
|
|
|
Returns `202 Accepted`. Track progress via SSE at `/api/v1/jobs/{jobId}/progress`.
|
|
|
|
```json
|
|
{
|
|
"jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
|
|
"async": true
|
|
}
|
|
```
|
|
|
|
## Notes
|
|
|
|
- Accepted input formats: `.html`, `.htm`.
|
|
- Remote resources (images, stylesheets, scripts referenced via URLs) are not fetched for privacy and security.
|
|
- Inline styles and embedded images (data URIs) are preserved.
|
|
- Conversion is handled by WeasyPrint on the server.
|