yaml multiline string pipe code example

Example 1: yaml multiline string

# Use > most of the time: interior line breaks are stripped out, although you get one at the end:

key: >
  Your long
  string here.


# Use | if you want those linebreaks to be preserved as \n (for instance, embedded markdown with paragraphs).

key: |
  ### Heading

  * Bullet
  * Points

# Use >- or |- instead if you don't want a linebreak appended at the end.
# Use "..." if you need to split lines in the middle of words or want to literally type linebreaks as \n:

key: "Antidisestab\
 lishmentarianism.\n\nGet on it."

Example 2: yaml multiline string

Key: >
  This is a very long sentence
  that spans several lines in the YAML
  but which will be rendered as a string
  with only a single carriage return appended to the end.
  
# You can use the "block chomping indicator" to eliminate the trailing line break, as follows:

Key: >-
  This is a very long sentence
  that spans several lines in the YAML
  but which will be rendered as a string
  with NO carriage returns.