evil-org

Supplemental evil-mode key-bindings to Emacs org-mode. This project is a continuation of https://github.com/edwtjo/evil-org-mode/blob/master/evil-org.el by Edward Tjörnhammar. From version 1.3 it was taken over by Somelauw. See changelog for a history of changes.

Features

• normal, visual and insert mode bindings
• key bindings organised in key themes
• operators like > and < to work on headings
• text objects
• table support

Keybindings

Full overview of bindings and configuration

Quick overview

key	explanation
gh, gj, gk, gl	navigate between elements
vae	select an element

Headings and items

key	explanation
M-ret	insert heading
TAB	fold / unfold headings
M-h or <<	promote a heading
M-l or >>	demote a heading
M-k	move subtree up
M-j	move subtree down
M-S-h or <aR	promote a subtree
M-S-l or >aR	demote a subtree
vaR	select a subtree

Tables

key	explanation
(	previous table cell
)	next table cell
{	beginning of table
}	end of table
M-h / M-l	move table column left / right
M-k / M-j	move table column up / down
vae	select table cell
vaE	select table row
var	select whole table

Requirements

• org-mode, git://orgmode.org/org-mode.git
• evil-mode, https://github.com/emacs-evil/evil

Installation

Manual installation

mkdir -p ~/.emacs.d/plugins; git clone
git://github.com/somelauw/evil-org.git ~/.emacs.d/plugins/evil-org

Configuration emacs.el

(add-to-list 'load-path "~/.emacs.d/plugins/evil-org")
(require 'evil-org)
(add-hook 'org-mode-hook 'evil-org-mode)
(evil-org-set-key-theme '(navigation insert textobjects additional))

Or you can customize evil-org-key-theme and replace the last line by:

(evil-org-set-key-theme)

Installation by use-package

(use-package evil-org
  :ensure t
  :after org
  :config
  (add-hook 'org-mode-hook 'evil-org-mode)
  (add-hook 'evil-org-mode-hook
            (lambda ()
              (evil-org-set-key-theme))))

For a more elaborate setup, take a look at this example.

Common issues

In case you run Emacs in a terminal, you might find that TAB does not work as expected (being bound to evil-jump-forward instead of org-tab). You can add this to your configuration to get org-tab instead at the cost of losing C-i to jump.

(setq evil-want-C-i-jump nil)

See also

• evil-org-mode by edwtjo Original org-mode plugin by edwtjo from which this project was forked
• org-evil by GuiltyDolphin Alternative integration of evil and org with different keybindings
• https://github.com/abo-abo/worf Not an evil plugin, but provides vim-inspired key bindings
• https://github.com/jceb/vim-orgmode Org mode plugin for vim
• http://orgmode.org/ The official org-mode website
• http://orgmode.org/orgcard.pdf A handy cheat sheet, even if using this plugin
• https://github.com/Somelauw/evil-markdown Similar project for markdown code

License

Gnu General Public License v3.0, http://www.gnu.org/copyleft/gpl.html