emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update tools/lookup readme

Browse source 
Relevant to #1166
This commit is contained in:
Henrik Lissner 2020-04-25 02:55:06 -04:00
parent 096803e2fe
commit 30dea4bf0c
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395
1 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

28
modules/tools/lookup/README.org
View file

@ -25,13 +25,14 @@
- [[#commands][Commands]] - [[#commands][Commands]]
* Description * Description
Integrates with code navigation and documentation tools to help you quickly look This module adds code navigation and documentation lookup tools to help you
up definitions, references and documentation. quickly look up definitions, references, documentation, dictionary definitions
or synonyms.
+ Jump-to-definition and find-references implementations that just work. + Jump-to-definition and find-references implementations that just work.
+ Powerful xref integration for languages that support it. + Powerful xref integration for languages that support it.
+ Documentation lookup for a variety of online sources (like devdocs.io, + Search online providers like devdocs.io, stackoverflow, google, duckduckgo or
stackoverflow or youtube). youtube (duckduckgo and google have live suggestions).
+ Integration with Dash.app docsets. + Integration with Dash.app docsets.
+ Support for online (and offline) dictionaries and thesauruses. + Support for online (and offline) dictionaries and thesauruses.
@ -43,14 +44,27 @@ up definitions, references and documentation.
** Plugins ** Plugins
+ [[https://github.com/jacktasia/dumb-jump][dumb-jump]] + [[https://github.com/jacktasia/dumb-jump][dumb-jump]]
+ [[https://github.com/alexmurray/ivy-xref][ivy-xref]] or [[https://github.com/brotzeit/helm-xref][helm-xref]] + [[https://github.com/alexmurray/ivy-xref][ivy-xref]] or [[https://github.com/brotzeit/helm-xref][helm-xref]]
+ [[https://github.com/nathankot/counsel-dash][counsel-dash]] or [[https://github.com/areina/helm-dash][helm-dash]] + [[https://github.com/tkf/emacs-request][request]]
+ =+docsets=
+ [[https://github.com/dash-docs-el/dash-docs][dash-docs]]
+ [[https://github.com/nathankot/counsel-dash][counsel-dash]] or [[https://github.com/areina/helm-dash][helm-dash]]
+ =+dictionary=
+ if macOS
+ [[https://github.com/xuchunyang/osx-dictionary.el][osx-dictionary]]* (on macOS)
+ else
+ [[https://github.com/abo-abo/define-word][define-word]]
+ [[https://github.com/maxchaos/emacs-powerthesaurus][powerthesaurus]]
+ =+offline=
+ [[https://github.com/gromnitsky/wordnut][wordnut]]
+ [[https://github.com/hpdeifel/synosaurus][synosaurus]]
* Prerequisites * Prerequisites
This module has several soft dependencies: This module has several soft dependencies:
+ ~ripgrep~ as a last-resort fallback for jump-to-definition/find-references. + ~ripgrep~ as a last-resort fallback for jump-to-definition/find-references.
+ ~sqlite3~ for Dash docset support. + ~sqlite3~ for Dash docset support (if you have =+docsets= enabled)
+ ~wordnet~ for offline dictionary and thesaurus support. + ~wordnet~ for offline dictionary and thesaurus support (if you have
=+dictionary +offline= enabled).
** MacOS ** MacOS
#+BEGIN_SRC sh #+BEGIN_SRC sh