branch: externals/ivy-posframe
commit 04d3719c54866e9712140437fc89ae4cdd0a479b
Author: Feng Shu <[email protected]>
Commit: Feng Shu <[email protected]>
Update README
---
README.md | 34 +++++++++++++++++-----------------
ivy-posframe.el | 6 +++---
2 files changed, 20 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
index 53f2855..5663595 100644
--- a/README.md
+++ b/README.md
@@ -3,21 +3,21 @@ Note: this file is converted from ivy-posframe.el by
[el2org](https://github.com
# 目录
-1. [ivy-posframe README](#org73a5a3f)
- 1. [What is ivy-posframe](#org711a00d)
- 2. [Display functions](#org8ff600c)
- 3. [How to enable ivy-posframe](#orgedfde9d)
- 4. [Tips](#org7fbf393)
- 1. [How to show fringe to ivy-posframe](#org79a88f5)
- 2. [How to custom your ivy-posframe style](#orgd33a170)
+1. [ivy-posframe README](#org7f9a5fe)
+ 1. [What is ivy-posframe](#org5057226)
+ 2. [Display functions](#orgbde602c)
+ 3. [How to enable ivy-posframe](#org6bfc45d)
+ 4. [Tips](#orgd52c7c9)
+ 1. [How to show fringe to ivy-posframe](#orga286c1f)
+ 2. [How to custom your ivy-posframe style](#orgf8a38da)
-<a id="org73a5a3f"></a>
+<a id="org7f9a5fe"></a>
# ivy-posframe README
-<a id="org711a00d"></a>
+<a id="org5057226"></a>
## What is ivy-posframe
@@ -27,7 +27,7 @@ to show its candidate menu.
NOTE: ivy-posframe requires Emacs 26
-<a id="org8ff600c"></a>
+<a id="orgbde602c"></a>
## Display functions
@@ -43,40 +43,40 @@ NOTE: ivy-posframe requires Emacs 26

-<a id="orgedfde9d"></a>
+<a id="org6bfc45d"></a>
## How to enable ivy-posframe
1. Global mode
(require 'ivy-posframe)
- (ivy-posframe-enable)
(setq ivy-display-function #'ivy-posframe-display)
;; (setq ivy-display-function #'ivy-posframe-display-at-frame-center)
;; (setq ivy-display-function #'ivy-posframe-display-at-window-center)
;; (setq ivy-display-function
#'ivy-posframe-display-at-frame-bottom-left)
;; (setq ivy-display-function
#'ivy-posframe-display-at-window-bottom-left)
;; (setq ivy-display-function #'ivy-posframe-display-at-point)
+ (ivy-posframe-enable)
2. Per-command mode.
(require 'ivy-posframe)
- (ivy-posframe-enable)
;; Different command can use different display function.
(push '(counsel-M-x . ivy-posframe-display-at-window-bottom-left)
ivy-display-functions-alist)
(push '(complete-symbol . ivy-posframe-display-at-point)
ivy-display-functions-alist)
+ (ivy-posframe-enable)
3. Fallback mode
(require 'ivy-posframe)
- (ivy-posframe-enable)
(push '(t . ivy-posframe-display) ivy-display-functions-alist)
+ (ivy-posframe-enable)
-<a id="org7fbf393"></a>
+<a id="orgd52c7c9"></a>
## Tips
-<a id="org79a88f5"></a>
+<a id="orga286c1f"></a>
### How to show fringe to ivy-posframe
@@ -88,7 +88,7 @@ By the way, User can set **any** parameters of ivy-posframe
with
the help of \`ivy-posframe-parameters'.
-<a id="orgd33a170"></a>
+<a id="orgf8a38da"></a>
### How to custom your ivy-posframe style
diff --git a/ivy-posframe.el b/ivy-posframe.el
index 5985ed5..ce615ed 100644
--- a/ivy-posframe.el
+++ b/ivy-posframe.el
@@ -51,27 +51,27 @@
;; 1. Global mode
;; #+BEGIN_EXAMPLE
;; (require 'ivy-posframe)
-;; (ivy-posframe-enable)
;; (setq ivy-display-function #'ivy-posframe-display)
;; ;; (setq ivy-display-function #'ivy-posframe-display-at-frame-center)
;; ;; (setq ivy-display-function #'ivy-posframe-display-at-window-center)
;; ;; (setq ivy-display-function
#'ivy-posframe-display-at-frame-bottom-left)
;; ;; (setq ivy-display-function
#'ivy-posframe-display-at-window-bottom-left)
;; ;; (setq ivy-display-function #'ivy-posframe-display-at-point)
+;; (ivy-posframe-enable)
;; #+END_EXAMPLE
;; 2. Per-command mode.
;; #+BEGIN_EXAMPLE
;; (require 'ivy-posframe)
-;; (ivy-posframe-enable)
;; ;; Different command can use different display function.
;; (push '(counsel-M-x . ivy-posframe-display-at-window-bottom-left)
ivy-display-functions-alist)
;; (push '(complete-symbol . ivy-posframe-display-at-point)
ivy-display-functions-alist)
+;; (ivy-posframe-enable)
;; #+END_EXAMPLE
;; 3. Fallback mode
;; #+BEGIN_EXAMPLE
;; (require 'ivy-posframe)
-;; (ivy-posframe-enable)
;; (push '(t . ivy-posframe-display) ivy-display-functions-alist)
+;; (ivy-posframe-enable)
;; #+END_EXAMPLE
;; ** Tips