From 199e7298a1f3cf6c92bb9e00d2d33f31a986b850 Mon Sep 17 00:00:00 2001 From: Albert Meltzer <7529386+kitbellew@users.noreply.github.com> Date: Tue, 25 Jun 2024 10:34:32 -0700 Subject: [PATCH] Documentation: describe `lineEndings` --- docs/configuration.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 8981a9dc11..8c86c38133 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -5310,6 +5310,19 @@ maxColumn = 30 ## Miscellaneous +### `lineEndings` + +This parameter controls which end-of-line character sequences will be output, +takes the following values: + +- `unix`: outputs LF (`U+000A`) +- `windows`: uses CRLF (`U+000D U+000A`) +- `preserve`: if an input file _contains_ CRLF anywhere, use CRLF for every line; otherwise, LF + +```scala mdoc:defaults +lineEndings +``` + ### `rewriteTokens` Map of tokens to rewrite. For example, Map("⇒" -> "=>") will rewrite unicode