branch: externals/ivy-posframe
commit c36250a5a6d307fdc8f60505be09e23d0b9e1b5a
Author: Feng Shu <[email protected]>
Commit: Feng Shu <[email protected]>
Update README
---
README.md | 41 ++++++++++++++++-------------------------
ivy-posframe.el | 32 +++++++++++++-------------------
2 files changed, 29 insertions(+), 44 deletions(-)
diff --git a/README.md b/README.md
index 923fc91..6278036 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,18 @@
# 目录
-1. [ivy-posframe README](#org0fcd3f6)
- 1. [What is ivy-posframe](#org5941743)
- 2. [How to use ivy-posframe](#orgb557f45)
- 1. [How to enable ivy-posframe](#org9056741)
- 2. [Window-buttom-left style](#org3ce6114)
- 3. [Window-center style](#orgadbea28)
+1. [ivy-posframe README](#org56f4250)
+ 1. [What is ivy-posframe](#orge48b949)
+ 2. [How to enable ivy-posframe](#orgf9d7738)
+ 3. [How to set the style of ivy-posframe](#org3923198)
-<a id="org0fcd3f6"></a>
+<a id="org56f4250"></a>
# ivy-posframe README
-<a id="org5941743"></a>
+<a id="orge48b949"></a>
## What is ivy-posframe
@@ -22,14 +20,9 @@ ivy-posframe is a ivy extension, which let ivy use posframe
to show its candidate menu.
-<a id="orgb557f45"></a>
+<a id="orgf9d7738"></a>
-## How to use ivy-posframe
-
-
-<a id="org9056741"></a>
-
-### How to enable ivy-posframe
+## How to enable ivy-posframe
1. Global mode
@@ -45,22 +38,20 @@ to show its candidate menu.
(push '(t . ivy-posframe-display) ivy-display-functions-alist)
-<a id="org3ce6114"></a>
-
-### Window-buttom-left style
-
- (setq ivy-posframe-style 'window-buttom-left)
+<a id="org3923198"></a>
-
+## How to set the style of ivy-posframe
+1. window-buttom-left style
-<a id="orgadbea28"></a>
+ (setq ivy-posframe-style 'window-buttom-left)
-### Window-center style
+ 
+2. Window-center style
- (setq ivy-posframe-style 'window-center)
+ (setq ivy-posframe-style 'window-center)
-
+ 
diff --git a/ivy-posframe.el b/ivy-posframe.el
index f1ecc9b..dd1f09f 100644
--- a/ivy-posframe.el
+++ b/ivy-posframe.el
@@ -27,14 +27,12 @@
;;; Commentary:
;; * ivy-posframe README :README:
+
;; ** What is ivy-posframe
;; ivy-posframe is a ivy extension, which let ivy use posframe
;; to show its candidate menu.
-;; ** How to use ivy-posframe
-
-;; *** How to enable ivy-posframe
-
+;; ** How to enable ivy-posframe
;; 1. Global mode
;; #+BEGIN_EXAMPLE
;; (require 'ivy-posframe)
@@ -51,21 +49,17 @@
;; (push '(t . ivy-posframe-display) ivy-display-functions-alist)
;; #+END_EXAMPLE
-;; *** Window-buttom-left style
-;; #+BEGIN_EXAMPLE
-;; (setq ivy-posframe-style 'window-buttom-left)
-;; #+END_EXAMPLE
-
-;; [[./snapshots/ivy-posframe1.gif]]
-
-;; *** Window-center style
-;; #+BEGIN_EXAMPLE
-;; (setq ivy-posframe-style 'window-center)
-;; #+END_EXAMPLE
-
-;; [[./snapshots/ivy-posframe2.gif]]
-
-
+;; ** How to set the style of ivy-posframe
+;; 1. window-buttom-left style
+;; #+BEGIN_EXAMPLE
+;; (setq ivy-posframe-style 'window-buttom-left)
+;; #+END_EXAMPLE
+;; [[./snapshots/ivy-posframe1.gif]]
+;; 2. Window-center style
+;; #+BEGIN_EXAMPLE
+;; (setq ivy-posframe-style 'window-center)
+;; #+END_EXAMPLE
+;; [[./snapshots/ivy-posframe2.gif]]
;;; Code:
;; * ivy-posframe's code