cheatsheet.md

title	weight	type
Quire Cheatsheet	501	essay

Markdown

Paragraphs are made by adding two hard returns. When working in a text editor, depending on your configuration and the source of your text, lines might have hard breaks, or might all flow together. This is seen in the example below where the first paragraph has hard breaks and the second does not. In Markdwon, these will both render as single paragraphs with no hard breaks. The only way to add a hard break in markdown is with the HTML break (<br />) element.

Lorem ipsum dolor sit amet, consectetur
adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.
Ut enim ad minim veniam, quis nostrud
exercitation ullamco laboris nisi ut
aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Other typical Markdown formatting is listed below. Note that the spacing after the #, >, - and list numerals is necessary.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

*Italic Text*
**Bold Text**

> Blockquote

[Link Text](http://www.linkadress.com)

- dashes make
- a list with
- bullets
  - indenting
  - makes
  - sub-lists

1. numbers make
2. a list with
3. numbers

YAML

In a Quire publication, anything that could be considered data, is written in a plain-text data format called YAML.

• YAML is used for configuring how Quire works and for providing metadata about your publication in files with the extension .yml (both topics covered in Metadata & Configuration.

• .yml files are also used for storing information about figures, bibliographic references, and art objects.

• In individual pages or chapters within the publication, written in Markdown and with a .md extension, there is a YAML block that contains the page metadata. For example the YAML block for the page you’re on right now is:

---
title: Cheatsheet
type: page
---

YAML

item:
other_item:
multiple_items:
  - item_name:
    item_description:
  - item_name:
    item_description:

item: "If the text here has a colon : or other special characters it should be surrounded in double quotes"

item: |
  Using a pipe character, and then dropping down a line and indenting like this allows you to include multiple paragraphs, just as you would in Markdown.

  Not all Quire YAML attributes expect Markdown though, so check the docs.

  - Markdown style lists
  - and other formatting are
  - also allowed

YAML Lint Code Beautify validator

Shortcodes

{{</* q-figure id="##" */>}}

{{</* q-figure-group id="##, ##, ##" */>}}

{{</* q-cite "Lastname YYYY" */>}}

{{</* q-bibliography */>}}

{{</* q-contributors range="xxxx" type="xxxx" */>}}