Editorconfig page

docs/.style/fsdocs-custom.sass

@@ -92,6 +92,13 @@ $headings-font-family: 'Reem Kufi', sans-serif
         line-height: 1
         color: $white
 
+  .green-recommendation
+    color: $green
+  .red-recommendation
+    color: $red
+  .yellow-recommendation
+    color: $yellow
+
 .fsdocs-source-link
   float: right
   text-decoration: none

docs/.style/variables.sass

@@ -5,9 +5,12 @@ $drop-shadow: rgba(22, 22, 22, 0.2)
 $white: #FFF
 $pearl: #f6f7f7
 $menu-open: #347193
+$green: #92DC84
+$yellow: #E9DFB2
+$red: #EA7268
 $navbar-light-brand-color: $white
 $navbar-light-brand-hover-color: $white
 $navbar-light-color: $white
 $navbar-light-active-color: $secondary
 $navbar-light-hover-color: $white
-$navbar-nav-link-padding-x: 0
+$navbar-nav-link-padding-x: 0

docs/_template.html

@@ -103,6 +103,9 @@
     document.getElementById(e.target.id+'-wrapper').classList.add('menu-open');
   }
 })
+const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
+const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))
+
   </script>
   <!-- BEGIN SEARCH BOX: this adds support for the search box -->
   <link rel="stylesheet"

docs/docs/end-users/Configuration.fsx

@@ -0,0 +1,166 @@
+(**
+---
+category: End-users
+categoryindex: 1
+index: 3
+---
+*)
+#r "nuget: Fantomas.Core, 5.0.0-alpha-*"
+
+open Fantomas.Core.FormatConfig
+open Fantomas.Core
+
+(**
+# Configuration
+Fantomas ships with a series of format options.
+These can be stored in an [.editorconfig](https://editorconfig.org/) file and will be picked up automatically by the 
+commandline. <br>
+Your IDE should respect your settings, but the implementation of that is editor specific. Setting the configuration via 
+UI might be available depending on the IDE but do note that these features might not be up to 
+date nor work properly, therefore it's support and use is out of scope for this project. 
+*)
+
+(**
+## Usage
+Inside .editorconfig you can specify the file extension and code location to be use per config:
+```
+[*.fs]
+fsharp_space_before_uppercase_invocation = true
+
+# Write a comment by starting the line with a '#'
+[*.{fs,fsx,fsi}]
+fsharp_bar_before_discriminated_union_declaration = true
+
+# Apply specific settings for a targeted subfolder
+[src/Elmish/View.fs]
+fsharp_multiline_block_brackets_on_same_column = true
+fsharp_experimental_stroustrup_style = true
+```
+*)
+
+(**
+## Trying your settings via the online tool
+You can quickly try your settings via the <a href="https://fsprojects.github.io/fantomas-tools/#/fantomas/preview" target="_blank">online tool</a>. <br>
+<img src="{{root}}/online_tool_usage.gif" alt="drawing" width="100%"/>
+*)
+
+(**
+## Settings recommendations
+Fantomas ships with a series of settings that you can use freely depending  on your case. However there are settings that we do not recommend and generally should not be used. <br>
+<i class="bi bi-check-circle-fill green-recommendation"></i> Good to use: TBD<br>
+<i class="bi bi-exclamation-circle-fill yellow-recommendation"></i> Not recommended: TBD <br>
+<i class="bi bi-check-circle-fill red-recommendation"></i> Do not use: TBD<br>
+*)
+
+(**
+## Auxiliary settings
+#### <i class="bi bi-check-circle-fill green-recommendation" data-bs-toggle="tooltip" data-bs-title="This setting is good to use"></i> indent_size
+` indent_size` has to be between 1 and 10.
+
+This preference sets the indentation
+The common values are 2 and 4. 
+The same indentation is ensured to be consistent in a source file.
+Default = 4.
+
+`defaultConfig`
+*)
+let input = """ 
+let inline selectRandom (f: _ []) =
+    let r = random 1.0
+
+    let rec find =
+        function
+        | 0 -> fst f.[0]
+        | n when r < snd f.[n] -> fst f.[n]
+        | n -> find (n - 1)
+
+    find <| f.Length - 1
+"""
+let configIndent = { FormatConfig.Default with IndentSize = 2 }
+(**
+
+## Maximum width constraints
+#### <i class="bi bi-check-circle-fill yellow-recommendation" data-bs-toggle="tooltip" data-bs-title="This setting is not recommended"></i>indent_size
+` indent_size` has to be between 1 and 10.
+
+This preference sets the indentation
+The common values are 2 and 4. 
+The same indentation is ensured to be consistent in a source file.
+Default = 4.
+
+`defaultConfig`
+
+*)
+let input2 = """ 
+let inline selectRandom (f: _ []) =
+    let r = random 1.0
+
+    let rec find =
+        function
+        | 0 -> fst f.[0]
+        | n when r < snd f.[n] -> fst f.[n]
+        | n -> find (n - 1)
+
+    find <| f.Length - 1
+"""
+let configIndent2 = { FormatConfig.Default with IndentSize = 2 }
+(**
+
+## G-Research style
+#### <i class="bi bi-check-circle-fill yellow-recommendation" data-bs-toggle="tooltip" data-bs-title="This setting is not recommended"></i>indent_size
+` indent_size` has to be between 1 and 10.
+
+This preference sets the indentation
+The common values are 2 and 4. 
+The same indentation is ensured to be consistent in a source file.
+Default = 4.
+
+`defaultConfig`
+
+*)
+let input3 = """ 
+let inline selectRandom (f: _ []) =
+    let r = random 1.0
+
+    let rec find =
+        function
+        | 0 -> fst f.[0]
+        | n when r < snd f.[n] -> fst f.[n]
+        | n -> find (n - 1)
+
+    find <| f.Length - 1
+"""
+let configIndent3 = { FormatConfig.Default with IndentSize = 2 }
+(**
+
+## Other
+#### <i class="bi bi-check-circle-fill red-recommendation" data-bs-toggle="tooltip" data-bs-title="You shouldn't use this setting"></i>indent_size
+
+` indent_size` has to be between 1 and 10.
+
+This preference sets the indentation
+The common values are 2 and 4. 
+The same indentation is ensured to be consistent in a source file.
+Default = 4.
+
+`defaultConfig`
+
+*)
+let input4 = """ 
+let inline selectRandom (f: _ []) =
+    let r = random 1.0
+
+    let rec find =
+        function
+        | 0 -> fst f.[0]
+        | n when r < snd f.[n] -> fst f.[n]
+        | n -> find (n - 1)
+
+    find <| f.Length - 1
+"""
+let configIndent4 = { FormatConfig.Default with IndentSize = 2 }
+let formatCode input configIndent =
+    CodeFormatter.FormatDocumentAsync  (false, input, configIndent)
+    |>  Async.RunSynchronously
+
+formatCode input configIndent