Skip to content

Commit

Permalink
馃摑 Update guidance for upstream issues (#2759)
Browse files Browse the repository at this point in the history
  • Loading branch information
CollierCZ committed Dec 20, 2022
1 parent c98f3c9 commit c740a5d
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions contributing/markup-format.md
Expand Up @@ -259,6 +259,26 @@ web:
Keep the top-level key visible so readers can understand the code in context.
(For example, don't leave out `web:` in the example above.)

### Multiline strings

When writing multiline strings in YAML, known as scalar content,
examples often use a literal style as shown with a `|`.
In such cases, the string that comes needs to span multiple lines.
Otherwise, the parser doesn't accept it as a scalar and the spacing and highlighting is wrong.

To resolve this, either put the comment on a single line without the `|`
or add an ellipsis to indicate content is missing, as in the following example:

```yaml
hooks:
build: |
...
git pull
```

The highlighter also adds extra whitespace at the end of multiline strings.
These are [known issues](https://github.com/alecthomas/chroma/issues/475).

### Note when low-level items are missing

If there's a complicated block (such as `web.locations`) with many settings not relevant to the current idea,
Expand Down

0 comments on commit c740a5d

Please sign in to comment.