From 36fa02a03cd9541b9fc6c95038b0a803dce5239f Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Sat, 2 Mar 2019 02:11:53 -0500 Subject: [PATCH] Add modules/README.org A module listing with supported flags, links to documentation and brief descriptions (WIP). --- modules/README.org | 170 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 170 insertions(+) create mode 100644 modules/README.org diff --git a/modules/README.org b/modules/README.org new file mode 100644 index 000000000..7a26494de --- /dev/null +++ b/modules/README.org @@ -0,0 +1,170 @@ +#+TITLE: Doom Modules + +* Table of Contents :TOC:noexport: +- [[#feature][:feature]] +- [[#completion][:completion]] +- [[#ui][:ui]] +- [[#editor][:editor]] +- [[#emacs][:emacs]] +- [[#tools][:tools]] +- [[#lang][:lang]] +- [[#app][:app]] +- [[#collab][:collab]] +- [[#config][:config]] + +* :feature +Broad modules that bring essential IDE functionality to Emacs. + ++ [[file:feature/debugger/README.org][debugger]]: A (nigh-)universal debugger in Emacs ++ [[file:feature/eval/README.org][eval]]: REPL & code evaluation support for a variety of languages ++ [[file:feature/evil/README.org][evil]] =+everywhere=: Vim in Emacs ++ [[file:feature/file-templates/README.org][file-templates]]: Auto-inserted templates in blank new files ++ [[file:feature/lookup/README.org][lookup]] =+docsets=: Universal jump-to & documentation lookup backend ++ [[file:feature/snippets/README.org][snippets]]: A templating system for Emacs for lazy typers (aka programmers) ++ [[file:feature/workspaces/README.org][workspaces]]: Isolated workspaces + +* :completion +Swappable completion modules for quickly narrowing down lists of candidates. + ++ [[file:completion/company/README.org][company]] =+auto +childframe=: The ultimate code completion backend ++ [[file:completion/helm/README.org][helm]] =+fuzzy +childframe=: *Another* search engine for love and life ++ [[file:completion/ido/README.org][ido]]: The /other/ *other* search engine for love and life ++ [[file:completion/ivy/README.org][ivy]] =+fuzzy +childframe=: /The/ search engine for love and life + +* :ui +Aesthetic modules that affect the Emacs interface or user experience. + ++ [[file:ui/deft/README.org][deft]]: ++ [[file:ui/doom/README.org][doom]]: ++ [[file:ui/doom-dashboard/README.org][doom-dashboard]]: ++ [[file:ui/doom-quit/README.org][doom-quit]]: ++ [[file:ui/evil-goggles/README.org][evil-goggles]]: ++ [[file:ui/fci/README.org][fci]]: ++ [[file:ui/hl-todo/README.org][hl-todo]]: ++ [[file:ui/modeline/README.org][modeline]]: ++ [[file:ui/nav-flash/README.org][nav-flash]]: ++ [[file:ui/neotree/README.org][neotree]]: ++ [[file:ui/treemacs/README.org][treemacs]]: ++ [[file:ui/popup/README.org][popup]] =+all +defaults=: Makes temporary/disposable windows less intrusive ++ [[file:ui/pretty-code/README.org][pretty-code]]: ++ [[file:ui/tabbar/README.org][tabbar]]: ++ [[file:ui/unicode/README.org][unicode]]: ++ [[file:ui/vc-gutter/README.org][vc-gutter]]: ++ [[file:ui/vi-tilde-fringe/README.org][vi-tilde-fringe]]: ++ [[file:ui/window-select/README.org][window-select]]: + +* :editor +Modules that affect and augment your ability to write and edit text. + ++ [[file:editor/fold/README.org][fold]]: universal code folding ++ [[file:editor/format/README.org][format]] =+onsave=: ++ [[file:editor/lispy/README.org][lispy]]: ++ [[file:editor/multiple-cursors/README.org][multiple-cursors]]: ++ [[file:editor/parinfer/README.org][parinfer]]: ++ [[file:editor/rotate-text/README.org][rotate-text]]: + +* :emacs +Modules that reconfigure packages or features built into Emacs + ++ [[file:emacs/dired/README.org][dired]] =+ranger +icons=: ++ [[file:emacs/electric/README.org][electric]]: ++ [[file:emacs/eshell/README.org][eshell]]: ++ [[file:emacs/imenu/README.org][imenu]]: ++ [[file:emacs/term/README.org][term]]: ++ [[file:emacs/vc/README.org][vc]]: + +* :tools +Small modules that give Emacs access to external tools & services. + ++ [[file:tools/ansible/README.org][ansible]]: ++ [[file:tools/docker/README.org][docker]]: ++ [[file:tools/editorconfig/README.org][editorconfig]]: ++ [[file:tools/ein/README.org][ein]]: ++ [[file:tools/flyspell/README.org][flyspell]]: Spell checking ++ [[file:tools/flycheck/README.org][flycheck]]: Live error/warning highlights ++ [[file:tools/gist/README.org][gist]]: ++ [[file:tools/lsp/README.org][lsp]]: ++ [[file:tools/macos/README.org][macos]]: ++ [[file:tools/make/README.org][make]]: ++ [[file:tools/magit/README.org][magit]]: ++ [[file:tools/password-store/README.org][password-store]]: ++ [[file:tools/pdf/README.org][pdf]]: ++ [[file:tools/prodigy/README.md][prodigy]]: ++ [[file:tools/rgb/README.org][rgb]]: ++ [[file:tools/terraform/README.org][terraform]]: ++ [[file:tools/tmux/README.org][tmux]]: ++ [[file:tools/upload/README.org][upload]]: ++ [[file:tools/wakatime/README.org][wakatime]]: ++ [[file:tools/vterm/README.org][vterm]]: + +* :lang +Modules that bring support for a language or group of languages to Emacs. + ++ [[file:lang/assembly/README.org][assembly]]: ++ [[file:lang/cc/README.org][cc]] =+lsp=: ++ [[file:lang/clojure/README.org][clojure]]: ++ [[file:lang/common-lisp/README.org][common-lisp]]: ++ [[file:lang/coq/README.org][coq]]: ++ [[file:lang/crystal/README.org][crystal]]: ++ [[file:lang/csharp/README.org][csharp]]: ++ [[file:lang/data/README.org][data]]: ++ [[file:lang/erlang/README.org][erlang]]: ++ [[file:lang/elixir/README.org][elixir]]: ++ [[file:lang/elm/README.org][elm]]: ++ [[file:lang/emacs-lisp/README.org][emacs-lisp]]: ++ [[file:lang/ess/README.org][ess]]: ++ [[file:lang/go/README.org][go]] =+lsp=: ++ [[file:lang/haskell/README.org][haskell]] =+intero +dante=: ++ [[file:lang/hy/README.org][hy]]: ++ [[file:lang/idris/README.org][idris]]: ++ [[file:lang/java/README.org][java]] =+meghanada=: ++ [[file:lang/javascript/README.org][javascript]] =+lsp=: ++ [[file:lang/julia/README.org][julia]]: ++ [[file:lang/latex/README.org][latex]]: ++ [[file:lang/ledger/README.org][ledger]]: ++ [[file:lang/lua/README.org][lua]]: ++ [[file:lang/markdown/README.org][markdown]]: ++ [[file:lang/nim/README.org][nim]]: ++ [[file:lang/nix/README.org][nix]]: ++ [[file:lang/ocaml/README.org][ocaml]] =+lsp=: ++ [[file:lang/org/README.org][org]] =+attach +babel +capture +export +present +ipython=: ++ [[file:lang/perl/README.org][perl]]: ++ [[file:lang/php/README.org][php]] =+lsp=: ++ [[file:lang/plantuml/README.org][plantuml]]: ++ [[file:lang/purescript/README.org][purescript]]: ++ [[file:lang/python/README.org][python]] =+lsp=: ++ [[file:lang/qt/README.org][qt]]: ++ [[file:lang/racket/README.org][racket]]: ++ [[file:lang/rest/README.org][rest]]: ++ [[file:lang/ruby/README.org][ruby]] =+lsp=: ++ [[file:lang/rust/README.org][rust]] =+lsp=: ++ [[file:lang/scala/README.org][scala]]: ++ [[file:lang/sh/README.org][sh]] =+fish +lsp=: ++ [[file:lang/solidity/README.org][solidity]]: ++ [[file:lang/swift/README.org][swift]]: ++ [[file:lang/web/README.org][web]] =+lsp=: ++ [[file:lang/vala/README.org][vala]]: + +* :app +Large, opinionated modules that transform and take over Emacs to serve + ++ [[file:app/calendar/README.org][calendar]]: ++ [[file:app/email/README.org][email]] =+gmail=: ++ [[file:app/irc/README.org][irc]]: ++ [[file:app/regex/README.org][regex]]: ++ [[file:app/rss/README.org][rss]] =+org=: ++ [[file:app/twitter/README.org][twitter]]: ++ [[file:app/write/README.org][write]] =+wordnut +langtool=: + +* :collab +Modules that enable collaborative programming over the internet. + ++ [[file:collab/floobits/README.org][floobits]]: ++ [[file:collab/impatient-mode/README.org][impatient-mode]]: + +* :config +Modules that configure Emacs one way or another, or focus on making it easier +for you to customize it yourself. + ++ [[file:config/literate/README.org][literate]]: ++ [[file:config/default/README.org][default]] =+bindings +smartparens=: