Evil extensions for Org-mode.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.org

org-evil

Synopsis

Org-evil provides Org-mode extensions for Evil users.

Installation

The following installation methods are available:

Manual

To install org-evil, you need to have the following dependencies installed:

Once you have set up these dependencies appropriately (and they are in your load-path) you can add:

(add-to-list 'load-path "/path/to/org-evil/directory")
(require 'org-evil)

To your init file to enable org-evil for future sessions.

To check that org-evil is working, navigate to a buffer with org as its major mode, then run C-h v org-evil-mode RET, you should see an indication that the value of the variable is t.

el-get

el-get can be used to install the latest version, see https://github.com/dimitri/el-get for more information.

MELPA

The latest version of org-evil is available from MELPA.

http://melpa.milkbox.net/#/org-evil

Follow the instructions at MELPA to enable MELPA for your system, then run M-x package-install RET org-evil RET to install org-evil.

Getting Started

Moving Around

org-evil aims to make motion in Org intuitive for Evil users, so you can expect motions such as $ to be similar to evil-end-of-line, ^ to evil-first-non-blank, and so on and so forth.

General Motions

The following are the default motion bindings for org-evil-motion, use M-x describe-function BINDING for more information on each motion.

KeyBinding
[[org-evil-motion-backward-block-begin
]]org-evil-motion-forward-block-begin
gHorg-evil-motion-up-heading-top
ghorg-evil-motion-up-heading
{org-evil-motion-backward-heading
}org-evil-motion-forward-heading

Block Motions

The following bindings apply when inside an Org block:

KeyBinding
(org-evil-block-beginning-of-block
)org-evil-block-end-of-block

List Motions

The following bindings apply when inside a list:

KeyBinding
(org-evil-list-beginning-of-previous-item
)org-evil-list-beginning-of-next-item
^org-evil-list-beginning-of-item

Table Motions

The following bindings apply when inside an Org table:

KeyBinding
gRorg-evil-table-goto-line-from-bottom
gcorg-evil-table-goto-column
grorg-evil-table-goto-line
|org-evil-table-goto-column

Operators

Heading Operators

The following bindings apply when at a heading:

KeyBinding
<org-evil-promote
>org-evil-demote
Oorg-evil-heading-open-sibling-or-insert-above
oorg-evil-heading-open-sibling-or-insert-below

List Operators

The following bindings apply when in a list:

KeyBinding
<org-evil-list-outdent-item-tree
>org-evil-list-indent-item-tree
Oorg-evil-list-open-item-or-insert-above
oorg-evil-list-open-item-or-insert-below

Table Operators

The following bindings apply when inside an Org table:

KeyBinding
<org-evil-table-move-column-left
>org-evil-table-move-column-right
Dorg-evil-table-kill-row-to-end
Oorg-evil-table-insert-row-above
oorg-evil-table-insert-row-below

Text Objects

Block Text Objects

The following text objects are enabled within an Org block:

KeyBinding
aborg-evil-block-a-block
iborg-evil-block-inner-block

See Also