Update README
This commit is contained in:
parent
77250ae7da
commit
13a948fb4b
10
README.org
10
README.org
@ -1,12 +1,14 @@
|
|||||||
|
This package displays ElDoc documentations in a childframe.
|
||||||
|
|
||||||
* Install
|
* Install
|
||||||
Get the file, add to load path, and
|
Get the file, add to load path, and
|
||||||
#+BEGIN_SRC emacs-lisp
|
#+BEGIN_SRC emacs-lisp
|
||||||
(require 'eglot-doc)
|
(require 'eldoc-box)
|
||||||
#+END_SRC
|
#+END_SRC
|
||||||
|
|
||||||
* Usage
|
* Usage
|
||||||
Show the documentation of the symbol at point: =eglot-doc-help-at-point=
|
Show the documentation of the symbol at point: =eldoc-box-help-at-point=
|
||||||
|
|
||||||
Show documentation upon hover: =eglot-doc-hover-mode=. Note that you need to enable ElDoc mode for this to work.
|
Show documentation upon hover: =eldoc-box-hover-mode=. Note that you need to enable ElDoc mode for this to work.
|
||||||
|
|
||||||
Adjust =:background= of =eglot-doc-border= face for border color. Adjust =:background= of =eglot-doc-body= face for background color of childframe.
|
Adjust =:background= of =eldoc-box-border= face for border color. Adjust =:background= of =eldoc-box-body= face for background color of childframe.
|
||||||
|
Loading…
Reference in New Issue
Block a user