Skip to content

Commit 74f2046

Browse files
committed
Updated README
1 parent 05b8e4c commit 74f2046

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,37 @@ body:
5151
]
5252
```
5353

54+
### Request fields
55+
56+
| Field | Required | Description |
57+
|---|---|---|
58+
| `userId` | Yes | Used to namespace the generated file in S3 |
59+
| `fileName` | Yes | Output file name, without extension |
60+
| `typeOfFile` | Yes | `"PDF"` or `"TEX"` |
61+
| `markdown` | Yes | Source document body |
62+
| `implicitFigures` | No | Enables Pandoc's `implicit_figures` extension |
63+
| `variables` | No | Map of Pandoc template variables, passed as `--variable=key:value` |
64+
| `template` | No | `"default"` or `"cjk"` (see below). Defaults to `"default"` |
65+
66+
### Templates
67+
68+
Two LaTeX templates are available via the `template` field:
69+
70+
- `"default"` (default) — the standard document template, sans-serif `lmodern` font.
71+
- `"cjk"` — adds `xeCJK` support for Chinese/Japanese/Korean typesetting, with `Noto Sans` / `Noto Sans CJK KR` as the default fonts. Use this when the document contains CJK text. `mainfont`/`CJKmainfont` can still be overridden via `variables`.
72+
73+
```json
74+
[
75+
{
76+
"userId":"c82da7d4-3295-4c4a-921b-7000d65224b6",
77+
"fileName": "korean_doc",
78+
"typeOfFile":"PDF",
79+
"template":"cjk",
80+
"markdown":"# 수학 문서\n\n이차 방정식의 판별식은 $\\Delta = b^2 - 4ac$ 입니다."
81+
}
82+
]
83+
```
84+
5485

5586
## Testing
5687

0 commit comments

Comments
 (0)