[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/evil-matchit 4fdcda9fec 056/244: updated README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/evil-matchit 4fdcda9fec 056/244: updated README |
Date: |
Thu, 6 Jan 2022 02:58:49 -0500 (EST) |
branch: elpa/evil-matchit
commit 4fdcda9fec60925ef2c1a03f67c9ad0909a77273
Author: Chen Bin <chenbin.sh@gmail.com>
Commit: Chen Bin <chenbin.sh@gmail.com>
updated README
---
README.org | 33 +++++++++++++++++----------------
1 file changed, 17 insertions(+), 16 deletions(-)
diff --git a/README.org b/README.org
index 4b915ecaa6..f48d80e5d1 100644
--- a/README.org
+++ b/README.org
@@ -2,9 +2,9 @@
Vim [[http://www.vim.org/scripts/script.php?script_id=39][matchit.vim]] by
Benji Fisher ported into Emacs.
-When it's installed, you can press "%" to jump between matched tags in Emacs.
+Press "%" to jump between matched tags in Emacs. For example, in HTML "<div>"
and "</div>" are a pair of tags.
-Most modern languages are supported:
+Many modern languages are supported:
- HTML
- Python
- Java
@@ -23,21 +23,22 @@ Most modern languages are supported:
This package uses Evil as its vi layer!
+Tested on Emacs 23.4, 24.3, 24.4
+
* Why use evil-matchit
-- No learning curve. Press "%" to jump between matched tags. That's all!
-- Stable! The ONLY dependency is evil-mode. So it should work in any major
modes (web-mode, html-mode ...).
+- No learning curve. Press "%" to jump. That's all!
+- Stable! The ONLY dependency is evil-mode. It works in any major modes
(web-mode, html-mode ...).
- Support any modern languages (html/java/c/c++/python/latex/javascript ...).
-- Powerful. For example, if you mix jsp, freemarker, html, jquery template or
any weird syntax into one file, evil-matchit still works!
-- Extendable. You can write a plugin for it in 5 minutes.
-- I will provide long term support for it (next 10 years) because Emacs is my
last editor.
+- Powerful. If you mix jsp, freemarker, html, jquery template or any weird
syntax into one file, it still works!
+- Extendable. Write a plugin for it takes only 5 minutes.
+- Long term support
-Here is screen cast for python:
+Screen cast for python:
[[file:screencast.gif]]
* Install
-evil-matchit is already uploaded to [[http://melpa.milkbox.net/]]. So the best
way to install it is using Emacs' package manager.
+It's already uploaded to [[http://melpa.milkbox.net/]].
-Or you can download the package from
https://dl.dropboxusercontent.com/u/858862/myelpa/index.html and manually
install it by “M-x package-install-file”.
* Set up
Insert below code into your ~/.emacs:
#+BEGIN_SRC lisp
@@ -48,11 +49,11 @@ Insert below code into your ~/.emacs:
Alternatively, you can enable evil-matchit-mode along a major mode by adding
`turn-on-evil-matchit-mode' to the mode hook.
* Usage
-Press "%" to jump inside item(s) between tags in evil-normal-mode whose
command name is "evilmi-jump-items". Please note that you *DO NOT* need move
cursor above the tag before jumping, evil-matchit is smart enough to *detect
the beginning of tag automatically*.
+Press "%" to jump inside between tags in evil-normal-mode. Please note
evil-matchit is smart enough to *detect the beginning of tag automatically*.
-Text object "%" is also created. It roughly equal the region when you press
"%" from evil-matchit. Its basic unit is line.
+Text object "%" is also created. It roughly equal the region when you press
"%" from evil-matchit.
-Please note inner text object or outer object is the same thing in
evil-matchit.
+Inner text object or outer object is the same thing in evil-matchit.
Press "va%" or "vi%" to select line(s) wrapped by tags.
@@ -94,7 +95,7 @@ All you need to do is to define function
evilmi-customize-keybinding before turn
#+END_SRC
* Developer guide
-** Write elisp code to support a new language
+** Write Emacs Lisp to support new language
Simple. You only need define two functions and tell evil-matchit in which
major-mode they should be used.
Here is a complete sample:
@@ -138,7 +139,7 @@ Here is a complete sample:
Place above code into your ~/.emacs, after the line "(global-evil-matchit-mode
1)"
** Use SDK
-Please note SDK is totally *OPTIONAL*! You don't need SDK to write a plugin
for evil-matchit.
+Please note SDK is *OPTIONAL*! You don't need SDK to write a plugin for
evil-matchit.
You can check the evil-matchit-script.el for the sample on how to use SDK.
@@ -196,4 +197,4 @@ Key points about code quality of plugin:
- support emacs 23
- performance is the first priority
* Contact me
-You can report bugs at [[https://github.com/redguardtoo/evil-matchit]].
+Report bugs at [[https://github.com/redguardtoo/evil-matchit]].
- [nongnu] elpa/evil-matchit 9158dc87cc 062/244: case sensitive code is cleaned because Emacs will handle it, (continued)
- [nongnu] elpa/evil-matchit 9158dc87cc 062/244: case sensitive code is cleaned because Emacs will handle it, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 1c1a218d34 067/244: sql, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 1017e2e6ec 069/244: README.org: update MELPA URL, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 3f08492ec4 072/244: FIXED: #43 no jump at the first line in html v1.5.2, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit bfe8afe2a1 070/244: Merge pull request #40 from xuchunyang/patch-1, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 257d4ab10c 071/244: #41 workaround web-mode v11 issue, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit c4be28092f 087/244: perfect support for visual-line state v2.1, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 4780ef4e4a 104/244: scan-sexps buggy in latex-mode, fallback to Evil API, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 38df050735 103/244: clean code, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 0941f38bfe 118/244: Add ocaml plugin to evil-matchit.el, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 4fdcda9fec 056/244: updated README,
ELPA Syncer <=
- [nongnu] elpa/evil-matchit 2f8449cfec 057/244: support Laravel Blade Templating, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 4fe67764e2 059/244: extra commands to delete/select items v1.4.3, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit d2e7b21038 061/244: remove duplicated code, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 4efd9e0fac 064/244: use % in evil-visual-mode, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 965efc080a 065/244: updated pkg.sh, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit acb89199d0 074/244: Fix matching chaining off end blocks, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 296c31f93d 073/244: Fix matching multiple arguments and varibles with underscores in do/end blocks., ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 9a1b6ac1f9 076/244: can jump between brackets in visual-state #42, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit 11352e24ff 083/244: support more pattern in lua-mode, ELPA Syncer, 2022/01/06
- [nongnu] elpa/evil-matchit e831d42aa5 085/244: relax regex for python matching, ELPA Syncer, 2022/01/06