diff options
| author | William Wagner Moraes Artero <williamwmoraes@gmail.com> | 2020-02-27 18:57:15 +0100 |
|---|---|---|
| committer | Jesse Duffield <jessedduffield@gmail.com> | 2020-03-01 10:57:12 +1100 |
| commit | ec31fc4cc77b73246d276f8de7322eeff1a3b2fd (patch) | |
| tree | 63fc7dea9ab7caed2cf584ce901a36d71e2127b9 /docs | |
| parent | 3ce2b9b79ac909c772c2a2b56873b45b93f8d221 (diff) | |
docs: moved services conf docs to config.md
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Config.md | 41 |
1 files changed, 29 insertions, 12 deletions
diff --git a/docs/Config.md b/docs/Config.md index f143f914c..f72ce445a 100644 --- a/docs/Config.md +++ b/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  -## 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` |