https://github.com/erickgnavar/evil-emacs-kickstart

A minimal emacs config focused for vim modal editing
https://github.com/erickgnavar/evil-emacs-kickstart

dotfiles emacs evil-mode

Last synced: about 2 months ago
JSON representation

A minimal emacs config focused for vim modal editing

• Host: GitHub
• URL: https://github.com/erickgnavar/evil-emacs-kickstart
• Owner: erickgnavar
• Created: 2023-09-10T06:02:38.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-25T03:27:24.000Z (7 months ago)
• Last Synced: 2024-06-25T04:37:43.897Z (7 months ago)
• Topics: dotfiles, emacs, evil-mode
• Language: Emacs Lisp
• Homepage: https://evil-emacs-kickstart.com
• Size: 10.7 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Evil emacs kickstart

A simple emacs starter kit to start using emacs as a daily driver using [evil-mode](https://github.com/emacs-evil/evil), focused in programming.

> This config requires at least emacs 29

## Installation

1. Backup your current config, if any

2. Clone the repo `git clone https://github.com/erickgnavar/evil-emacs-kickstart.git ~/.emacs.d`

3. Start `emacs`

4. Enjoy 🎉

## Features

### Fuzzy search

Find inside project files by typing terms

### Grep search

Using [ripgrep](https://github.com/BurntSushi/ripgrep) search into project files content.

> [ripgrep](https://github.com/BurntSushi/ripgrep) should be installed and available in `PATH`

### Mode line

- Show active evil mode

- Show relative project filename

- Show battery status

- Show major mode

- Show git current branch

### Git changes indicators

Show, using `fringe` section(on the left), indicators of all the changes made into the current buffer

### Key bindings

All the actions are triggered by `` key which is `SPC`, space bar.

| Action                               | Key binding        | function called               |

|--------------------------------------|--------------------|-------------------------------|

| Select interactive function          | SPC SPC | `execute-extended-command`    |

| Grep project files content           | SPC a   | `consult-ripgrep`             |

| Search for file into project         | SPC e   | `project-find-file`           |

| Find file by path                    | SPC f   | `find-file`                   |

| Kill current buffer                  | SPC k   | `kill-buffer`                 |

| Toggle line numbers                  | SPC l   | `display-line-numbers-mode`   |

| Create a new buffer                  | SPC n   | `evil-buffer-new`             |

| Fuzzy search inside current buffer   | SPC q   | `consult-line`                |

| Paste from killring(emacs clipboard) | SPC y   | `consult-yank-from-kill-ring` |

| Comment code                         | gc      | `evil-commentary`             |