diff --git a/docs/Config.md b/docs/Config.md index 150961442..3dca4dc9d 100644 --- a/docs/Config.md +++ b/docs/Config.md @@ -62,8 +62,8 @@ git: overrideGpg: false # prevents lazygit from spawning a separate process when using GPG disableForcePushing: false os: - editCommand: '' # see EditCommand section - openCommand: # see OpenCommand section + editCommand: '' # see 'Configuring File Editing' section + openCommand: '' refresher: refreshInterval: 10 # file/submodule refresh interval in seconds fetchInterval: 60 # re-fetch interval in seconds @@ -218,17 +218,21 @@ os: ``` ### Configuring File Editing -Lazygit will run edit with the first set option: + +Lazygit will edit a file with the first set editor in the following: + 1. config.yaml + ```yaml os: - editCommand: + editCommand: 'vim' # as an example ``` -2. $(git config core.editor) -3. $GIT_EDITOR -4. $VISUAL -5. $EDITOR -6. $(which vi) + +2. \$(git config core.editor) +3. \$GIT_EDITOR +4. \$VISUAL +5. \$EDITOR +6. \$(which vi) Lazygit will log an error if none of these options are set.