Skip to content

Commit

Permalink
README reorganizing
Browse files Browse the repository at this point in the history
  • Loading branch information
iyefrat committed Aug 1, 2020
1 parent 956e319 commit a6960a5
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ Heavily insipred by [[https://github.com/lervag/vimtex][vimtex]]; successor of [
* Table of Contents :TOC_3:noexport:
- [[#incomplete-showcase][Incomplete Showcase]]
- [[#installation][Installation]]
- [[#interaction-with-other-packages][Interaction with other packages]]
- [[#overview][Overview]]
- [[#text-objects][Text Objects]]
- [[#notes][Notes]]
- [[#toggles][Toggles]]
- [[#misc][Misc.]]
- [[#command-argument-movement][Command Argument Movement]]
- [[#section-jumping][Section Jumping]]
- [[#interaction-with-other-packages][Interaction with other packages]]
- [[#configuration][Configuration]]
- [[#custom-env-and-accent-surround-insertions][Custom env and accent surround insertions]]
- [[#custom-toggles][Custom Toggles]]
Expand Down Expand Up @@ -56,9 +56,15 @@ For ease use, hook it to =LaTeX-mode= by adding the following to your configurat
(add-hook 'LaTeX-mode-hook #'evil-tex-mode)
#+END_SRC

This package requires =evil=, =auctex=, and =Emacs 25.1+=
** Interaction with other packages
=evil-tex= does not require, but supports [[https://github.com/emacs-evil/evil-surround][evil-surround]] (using version =1.1.1=
or newer is preferred, to leverage [[https://github.com/emacs-evil/evil-surround/pull/165][#165]]). [[https://github.com/cute-jumper/evil-embrace.el][evil-embrace]] is also supported, in the
sense that it is told to overlook the bindings.

=evil-tex= also supports [[https://github.com/justbur/emacs-which-key][which-key]] to show the keys in [[#keymaps][keymaps]]. Likewise, the
toggles under =ts= plays well with [[https://github.com/hlissner/evil-snipe][evil-snipe]] as expected.

This package requires =evil=, =auctex=, and =Emacs 25.1+=
* Overview
** Text Objects
This package defines a number of text objects:
Expand Down Expand Up @@ -152,13 +158,6 @@ for quick navigation in marco arguments without going to normal mode.
~\frac{a}{b|}~ \to =M-n= \to ~\frac{a}{b}|~
*** Section Jumping
=]​]= and =[​[= jump between section headings (=\section=, =\subsection*=, etc).
** Interaction with other packages
=evil-tex= does not require, but supports =evil-surround= (using version =1.1.1=
or newer is preferred, to leverage [[https://github.com/emacs-evil/evil-surround/pull165][#165]]). [[https://github.com/cute-jumper/evil-embrace.el][evil-embrace]] is also supported, in the
sense that it is told to overlook the bindings.

=evil-tex= also supports =which-key= to show the keys in [[#keymaps][keymaps]]. Likewise, the
toggles under =ts= play with [[https://github.com/hlissner/evil-snipe][evil-snipe]] as expected.
* Configuration
** Custom env and accent surround insertions
Should be done by using ~evil-tex-bind-to-(env|cdlatex-accents|delim)-map~.
Expand Down

0 comments on commit a6960a5

Please sign in to comment.