Appearance
Front Matter
Front matter is a YAML block at the very top of a file, between two --- lines:
yaml
---
title: Launch Plan
author: Mira Chen
typora-copy-images-to: ./assets
---Type --- on the first line and press Enter, or choose YAML Front Matter in the / menu. Front matter shows as a Properties card; Edit as fields and Edit YAML source switch how you edit it.
General
| Key | Effect |
|---|---|
title | The document's title: its tab name, export title and hover card |
summary | Shown in the hover card |
author | Export author |
Images
| Key | Effect |
|---|---|
typora-root-url | Base for paths that start with / |
typora-copy-images-to | Folder for inserted images, or upload. See Images |
Export
These apply to every export:
| Key | Effect |
|---|---|
typora-author | Author |
typora-split-level | Heading level that starts a new chapter |
typora-toc-depth | Levels in the table of contents |
keywords or tags, subject, creator | PDF metadata |
These need Read and overwrite settings from YAML front matter on in the export profile:
| Key | Effect |
|---|---|
typora-header, typora-footer | PDF header and footer |
typora-sidebar | Outline sidebar in HTML |
typora-append-head, typora-append-body | Replace the extra content for <head> and <body> |
typora-append-head-extra, typora-append-body-extra | Add to it |
Each also works without the typora- prefix.
All your front matter reaches Pandoc as metadata, and export text can use it as ${key}, such as ${title} in a PDF header.
Citations
| Key | Effect |
|---|---|
bibliography, references | Where citation entries come from |
csl, lang | Citation style and its language |
reference-section-title | Heading above the bibliography |
suppress-bibliography | Leave the bibliography out |
See Citations.
Publishing
| Key | Effect |
|---|---|
status: draft | Publish as a draft |
publish_id | Keeps the link to the online article when a file moves |
See Publish.
Templates and snippets
typora-template and typora-snippet hold a library item's description, file name and prefix. They are removed when it is used.