![]() ![]() The keywords variable contains keywords, or tags, that can be used by Pandoc. Indentation of YAML values is important and thus you should take care. Note the indentation of the property affiliation: It aligns with the name property. This variable will be used, for instance, to generate a title page on PDF exports.īoth of the following variants would be correct: author: ![]() This is a list of either simple names, or author names with affiliations. Use this field to specify the authors of a file. This variable will override the filename in various places where Zettlr displays the filename (such as the file list and the document tab bar). This is useful as headings of level 1 are, strictly speaking, not meant to denote the title of a document, but rather the topmost order of sections in the document. title ¶Ĭontains the final title of the document. Therefore, if you plan to use a different tool to convert your Markdown files, you should consult their documentation for a list of available variables. Tip: On this page we only list certain important variables for use with Pandoc, but YAML frontmatters are also supported by other engines, such as the Jekyll static site generator. The support for variables such as nocite is likely going to increase further in future versions.įor a full list of available variables and more instructions on how to use these variables, refer to the section on metadata blocks in the Pandoc manual as well as the manual for Pandoc citeproc. Zettlr can understand a subset of these variables to show you additional information across the program. With such a frontmatter, you can control many aspects of how your document will be rendered, such as the locale to be used, or a list of references that you do not cite within the main text. The frontmatter serves to hold a lot of useful information for both Pandoc and Pandoc citeproc. For more information, make sure to read the documentation on defaults files to avoid confusion! Frontmatter variables ¶ ![]() Frontmatters versus Defaults files ¶įrontmatters can be used to override defaults set by either Pandoc internally or one of the defaults files which Zettlr uses to export your files. For your YAML frontmatter to be valid, use spaces for indentation. For a full guide on how to write YAML, view the specification.Ī valid YAML frontmatter for a Pandoc export could look like this: -Īttention: According to the YAML specification, tab (tabulator) characters cannot be used for indentation. In between, Zettlr will apply YAML syntax highlighting. Such a frontmatter must begin with three dashes ( -) on the very first line of the document, and end with three dashes or three dots on a single line. Zettlr supports syntax highlighting for YAML frontmatter blocks that occur at the beginning of the file. YAML frontmatters can be defined anywhere in the document as it is common for Pandoc use-cases to concatenate multiple input files into one output file (Zettlr does this during project exports). They come in handy for a variety of use cases.įor a more concise documentation of what you can do with YAML frontmatters, please refer to the Pandoc documentation. They contain valid YAML and can be used to define arbitrary variables. YAML frontmatters can be defined at the beginning of a file, by starting on the first line with three dashes ( -) and ending the frontmatter either with three dashes or three dots (the former variant is more common). A YAML frontmatter is a series of meta variables that can be defined to describe information of the file that normally is not part of the text contents themselves, such as authors, keywords, and the title. Like Pandoc, Zettlr supports YAML frontmatters for your Markdown files. ![]()
0 Comments
Leave a Reply. |