Files
SnapOtter/apps/docs/tools/files/markdown-to-pdf.md
T

44 lines
1.2 KiB
Markdown
Raw Normal View History

---
description: Convert a Markdown file to a styled PDF.
---
# Markdown to PDF {#markdown-to-pdf}
Convert a Markdown file to a styled PDF document. Remote resources are disabled for privacy.
## API Endpoint {#api-endpoint}
2026-06-21 00:12:59 +08:00
`POST /api/v1/tools/files/markdown-to-pdf`
Accepts multipart form data with a Markdown file.
## Parameters {#parameters}
This tool has no configurable parameters. Upload a Markdown file and it will be converted to PDF.
## Example Request {#example-request}
```bash
2026-06-21 00:12:59 +08:00
curl -X POST http://localhost:1349/api/v1/tools/files/markdown-to-pdf \
-H "Authorization: Bearer si_your-api-key" \
-F "file=@document.md"
```
## Example Response {#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 {#notes}
- Accepted input formats: `.md`, `.markdown`.
- Remote resources (images, stylesheets referenced via URLs) are not fetched for privacy and security.
- The Markdown is first rendered to HTML, then converted to PDF via WeasyPrint.
- Code blocks, tables, and other Markdown elements are styled in the PDF output.