docs: moved services conf docs to config.md

README.md

@@ -158,61 +158,7 @@ Then `source ~/.zshrc` and from now on when you call `lg` and exit you'll switch
 
 ## Configuration
 
-All Lazygit configurations are stored on `<userConfigDir>/jesseduffield/lazygit/config.yml`, where
+Check the [configuration docs](docs/Config.md).
-`userConfigDir` is your OS-dependent user configurations folder, namely:
-
-- Windows: `%APPDATA%` (`C:\Users\<User>\AppData\Roaming`)
-- Linux/BSDs: `${XDG_CONFIG_HOME}` (`${HOME}/.config`)
-- MacOSX: `${HOME}/Library/Application Support`
-
-This file is auto-generated on first run.
-
-You can also get the default values with `lazygit -c`, which returns something like:
-
-```
-gui:
-  ## stuff relating to the UI
-  scrollHeight: 2
-  scrollPastBottom: true
-  mouseEvents: false # will default to true when the feature is complete
-  theme:
-    activeBorderColor:
-      - white
-      - bold
-    inactiveBorderColor:
-      - white
-    optionsTextColor:
-      - blue
-  commitLength:
-    show: true
-git:
-  merging:
-    manualCommit: false
-  skipHookPrefix: 'WIP'
-  autoFetch: true
-update:
-  method: prompt # can be: prompt | background | never
-  days: 14 # how often a update is checked for
-reporting: 'undetermined' # one of: 'on' | 'off' | 'undetermined'
-confirmOnQuit: false
-```
-
-### Custom pull request URLs
-
-Some git provider setups (e.g. on-premises GitLab) can have distinct URLs for git-related calls and
-the web interface/API itself. To work with those, Lazygit needs to know where it needs to create
-the pull request. You can do so on your `config.yml` file using the following syntax:
-
-```yaml
-services:
-  "<gitDomain>": "<provider>:<webDomain>"
-```
-
-Where:
-
-- `gitDomain` stands for the domain used by git itself (i.e. the one present on clone URLs), e.g. `git.work.com`
-- `provider` is one of `github`, `bitbucket` or `gitlab`
-- `webDomain` is the URL where your git service exposes a web interface and APIs, e.g. `gitservice.work.com`
 
 ## Cool features
 

docs/Config.md

@@ -1,11 +1,11 @@
-# User Config:
+# User Config
 
 Default path for the config file:
 
 * Linux: `~/.config/jesseduffield/lazygit/config.yml`
 * MacOS: `~/Library/Application Support/jesseduffield/lazygit/config.yml`
 
-## Default:
+## Default
 
 ```yaml
   gui:
@@ -136,30 +136,30 @@ Default path for the config file:
       undo: 'z'
 ```
 
-## Platform Defaults:
+## Platform Defaults
 
-### Windows:
+### Windows
 
 ```yaml
   os:
     openCommand: 'cmd /c "start "" {{filename}}"'
 ```
 
-### Linux:
+### Linux
 
 ```yaml
   os:
     openCommand: 'sh -c "xdg-open {{filename}} >/dev/null"'
 ```
 
-### OSX:
+### OSX
 
 ```yaml
   os:
     openCommand: 'open {{filename}}'
 ```
 
-### Recommended Config Values:
+### Recommended Config Values
 
 for users of VSCode
 
@@ -168,7 +168,7 @@ for users of VSCode
     openCommand: 'code -r {{filename}}'
 ```
 
-## Color Attributes:
+## Color Attributes
 
 For color attributes you can choose an array of attributes (with max one color attribute)
 The available attributes are:
@@ -186,7 +186,7 @@ The available attributes are:
 - reverse # useful for high-contrast
 - underline
 
-## Light terminal theme:
+## Light terminal theme
 
 If you have issues with a light terminal theme where you can't read / see the text add these settings
 
@@ -203,15 +203,16 @@ If you have issues with a light terminal theme where you can't read / see the te
         - blue
 ```
 
-## Example Coloring:
+## Example Coloring
 
 ![border example](/docs/resources/colored-border-example.png)
 
-## Keybindings:
+## Keybindings
+
 For all possible keybinding options, check [Custom_Keybinding.md](https://github.com/jesseduffield/lazygit/blob/master/docs/keybindings/Custom_Keybinding.md)
 
+### Example Keybindings For Colemak Users
 
-#### Example Keybindings For Colemak Users:
 ```yaml
   keybinding:
     universal:
@@ -238,3 +239,19 @@ For all possible keybinding options, check [Custom_Keybinding.md](https://github
       viewGitFlowOptions: 'I'
 ```
 
+## Custom pull request URLs
+
+Some git provider setups (e.g. on-premises GitLab) can have distinct URLs for git-related calls and
+the web interface/API itself. To work with those, Lazygit needs to know where it needs to create
+the pull request. You can do so on your `config.yml` file using the following syntax:
+
+```yaml
+services:
+  "<gitDomain>": "<provider>:<webDomain>"
+```
+
+Where:
+
+- `gitDomain` stands for the domain used by git itself (i.e. the one present on clone URLs), e.g. `git.work.com`
+- `provider` is one of `github`, `bitbucket` or `gitlab`
+- `webDomain` is the URL where your git service exposes a web interface and APIs, e.g. `gitservice.work.com`