README.md

   1 # inline-docs.el
   2
   3 This is a library for showing inline contextual docs above or below.
   4
   5 This source code mainly is
   6 from [justbur](https://emacs.stackexchange.com/users/14114/justbur)
   7 answered
   8 [question](https://emacs.stackexchange.com/questions/29256/display-eldoc-help-info-behind-point) .
   9
  10 # Support
  11
  12 On theory, this mode should support all Emacs available platforms.
  13
  14 Tested supported:
  15
  16 - Emacs 24.3 or upper
  17 - Emacs TTY mode
  18
  19 # Screenshots
  20
  21 ![screenshot](screenshot.png)
  22
  23 # Usage
  24
  25 You can use this library function `inline-docs` in packages like [eldoc-overlay-mode](https://github.com/stardiviner/eldoc-overlay-mode).
  26
  27 ```eldoc
  28 (setq eldoc-message-function #'inline-docs)
  29 ```
  30
  31 ```elisp
  32 (inline-docs "FORMATED-STRING")
  33 (inline-docs "STRING")
  34 ```
  35
  36 # related modes
  37
  38 - [eldoc-overlay-mode](https://github.com/stardiviner/eldoc-overlay-mode)