Skip to content

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 ​

KeyEffect
titleThe document's title: its tab name, export title and hover card
summaryShown in the hover card
authorExport author

Images ​

KeyEffect
typora-root-urlBase for paths that start with /
typora-copy-images-toFolder for inserted images, or upload. See Images

Export ​

These apply to every export:

KeyEffect
typora-authorAuthor
typora-split-levelHeading level that starts a new chapter
typora-toc-depthLevels in the table of contents
keywords or tags, subject, creatorPDF metadata

These need Read and overwrite settings from YAML front matter on in the export profile:

KeyEffect
typora-header, typora-footerPDF header and footer
typora-sidebarOutline sidebar in HTML
typora-append-head, typora-append-bodyReplace the extra content for <head> and <body>
typora-append-head-extra, typora-append-body-extraAdd 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 ​

KeyEffect
bibliography, referencesWhere citation entries come from
csl, langCitation style and its language
reference-section-titleHeading above the bibliography
suppress-bibliographyLeave the bibliography out

See Citations.

Publishing ​

KeyEffect
status: draftPublish as a draft
publish_idKeeps 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.

Theme adapted from Nimbus (MIT).