jessieh/eldoc-frame
jessieh/eldoc-frame
1
Fork 0
Code Issues Pull Requests Releases Activity

Update README

Browse Source
This commit is contained in:
Yuan Fu 2018-12-11 09:17:31 -05:00
parent 77250ae7da
commit 13a948fb4b
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.org
View File

@ -1,12 +1,14 @@
This package displays ElDoc documentations in a childframe.
* Install
Get the file, add to load path, and
#+BEGIN_SRC emacs-lisp
(require 'eglot-doc)
(require 'eldoc-box)
#+END_SRC
* 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.