Skip to content

Commit

Permalink
docs adjustment
Browse files Browse the repository at this point in the history
  • Loading branch information
braydonk committed Feb 10, 2024
1 parent 04359f6 commit 981ac49
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/config-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,13 @@ The basic formatter is a barebones formatter that simply takes the data provided

### Configuration

| Key | Type | Default | Description |
|:-------------------------|:---------------|:--------|:------------|
| `indent` | int | 2 | The indentation level in spaces to use for the formatted yaml|
| `include_document_start` | bool | false | Include `---` at document start |
| Key | Type | Default | Description |
|:----------------------------|:---------------|:--------|:------------|
| `indent` | int | 2 | The indentation level in spaces to use for the formatted yaml. |
| `include_document_start` | bool | false | Include `---` at document start. |
| `line_ending` | `lf` or `crlf` | `crlf` on Windows, `lf` otherwise | Parse and write the file with "lf" or "crlf" line endings. This setting will be overwritten by the global `line_ending`. |
| `retain_line_breaks` | bool | false | Retain line breaks in formatted yaml |
| `retain_line_breaks_single` | bool | false | (NOTE: Takes precedence over `retain_line_breaks`) Retain line breaks in formatted yaml but only keep a single line in groups of many blank lines. |
| `retain_line_breaks` | bool | false | Retain line breaks in formatted yaml. |
| `retain_line_breaks_single` | bool | false | (NOTE: Takes precedence over `retain_line_breaks`) Retain line breaks in formatted yaml, but only keep a single line in groups of many blank lines. |
| `disallow_anchors` | bool | false | If true, reject any YAML anchors or aliases found in the document. |
| `max_line_length` | int | 0 | Set the maximum line length (see notes below). if not set, defaults to 0 which means no limit. |
| `scan_folded_as_literal` | bool | false | Option that will preserve newlines in folded block scalars (blocks that start with `>`). |
Expand Down

0 comments on commit 981ac49

Please sign in to comment.