All settings
Every key a settings file or a project .markdown-pdf.json accepts. Most people never need this page: Studio writes these for you. Where the files live and how they combine: Settings file. Which keys a document's front matter accepts: Per-document options.
Short presets
The quickest way to set many things at once.
| Setting | What it does | Values | Default |
|---|---|---|---|
look | Page style preset: clean (Default. GitHub-style, neutral.) report (Serif headings, strong title rule. Business reports.) academic (Serif body, justified, minimal colour. Papers and theses.) compact (Dense and small. More text per page.) technical (For documents with code: framed code blocks, blue accents.) Explicit keys in this file override it. | clean, report, academic, compact, technical | |
font | Font preset for the text. Use font_family for a custom stack. | sans, serif, book, humanist, geometric, office, mono, system | |
heading_font | Font preset for titles (h1-h6). Use heading_font_family for a custom stack. | sans, serif, book, humanist, geometric, office, mono, system | |
template | Header/footer preset. Explicit header/footer keys in this file override it. | minimal, simple, corporate, academic, two-logo |
Page
| Setting | What it does | Values | Default |
|---|---|---|---|
page_format | Paper format. | A4, Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A5, A6 | A4 |
orientation | Paper orientation. | portrait, landscape | portrait |
margin | Page margins. | object: top, right, bottom, left | top: 15mm, right: 15mm, bottom: 15mm, left: 15mm |
scale | Scale of the page rendering (default 1). | number | 1 |
page_ranges | Paper ranges to print, e.g. '1-5, 8, 11-13'. Empty means all pages. | string | |
print_background | Whether to print background colours and images. | boolean | true |
Text, fonts and code
| Setting | What it does | Values | Default |
|---|---|---|---|
font_family | CSS font-family value for the document body and header/footer. Overrides the default system font stack. Example: "Georgia, 'Times New Roman', serif". | string | |
heading_font_family | CSS font-family value for headings (h1-h6). Default: same as the body text. | string | |
accent_color | Accent colour of the page style, as #rgb or #rrggbb: title rules, coloured titles, code block bars. Used by the report and technical looks; the others have no accent. | string | |
stylesheet_path | CSS file applied after the built-in stylesheet (relative to this settings file). | string | |
include_default_styles | Include the built-in default CSS stylesheet. | boolean | true |
highlight | Enable syntax highlighting for code blocks. | boolean | true |
highlight_style | Highlight.js style filename to use (e.g. 'github.css', 'monokai.css'). | one of 80 names, e.g. github.css, github-dark.css, monokai.css | github.css |
Content
| Setting | What it does | Values | Default |
|---|---|---|---|
breaks | Enable hard line breaks in the Markdown renderer. | boolean | false |
emoji | Render :emoji: shortcodes as Unicode characters. | boolean | true |
math | Render LaTeX math via KaTeX. Use $inline$ and $$display$$ syntax. | boolean | false |
math_options | KaTeX rendering options. | object: throw_on_error, error_color, macros | throw_on_error: false, error_color: #cc0000 |
heading_anchors | Add id slugs to headings (required infrastructure for TOC links). | boolean | false |
toc | Render a [[toc]] marker as an auto-generated table of contents (also enables heading anchors). | boolean | false |
toc_options | Table-of-contents rendering options. | object: level, list_type | level: [1,2,3], list_type: ul |
Header and footer
See Header and footer.
| Setting | What it does | Values | Default |
|---|---|---|---|
header | Page header. | object, see below | |
footer | Page footer. | object, see below | |
display_header_footer | Display header and footer on each page. Content comes from header / footer (here, in settings or in front matter); without them the header and footer are empty. Enabled automatically when header or footer is given. | boolean | false |
Files
| Setting | What it does | Values | Default |
|---|---|---|---|
output_directory | Folder for the PDFs, relative to each Markdown file. Default: next to it. | string | |
assets_directory | Folder for "@/name.svg" image references (relative to this settings file). | string | |
open_after_export | Open the PDF after export. | boolean | false |
Inside header and footer
| Key | What it does | Values |
|---|---|---|
height | Height of the area. | string |
padding | CSS padding. | string |
font_family | string | |
font_size | Default font-size. | string |
font_style | normal, italic, oblique | |
font_weight | string or number | |
color | Default text color. | string |
background | string | |
border_bottom | Header only. | string |
border_top | Footer only. | string |
style | Extra inline CSS, e.g. "letter-spacing: 1px". | string |
left | Element, array of elements, or null to clear the zone. | |
center | Element, array of elements, or null to clear the zone. | |
right | Element, array of elements, or null to clear the zone. | |
left_text | Shorthand: text in the left zone; placeholders allowed, e.g. "Page {page} of {pages}". | string |
left_image | Shorthand: image in the left zone (relative to the settings file, or "@/name.svg"). | string |
left_image_height | Shorthand: height of the left image. | string |
center_text | Shorthand: text in the center zone; placeholders allowed, e.g. "Page {page} of {pages}". | string |
center_image | Shorthand: image in the center zone (relative to the settings file, or "@/name.svg"). | string |
center_image_height | Shorthand: height of the center image. | string |
right_text | Shorthand: text in the right zone; placeholders allowed, e.g. "Page {page} of {pages}". | string |
right_image | Shorthand: image in the right zone (relative to the settings file, or "@/name.svg"). | string |
right_image_height | Shorthand: height of the right image. | string |
The structured form (left, center, right as objects): Structured header and footer.
