125 KiB
Spacemacs layers list
- Description
- Chats
- Checkers
- Completion
- Emacs
- File trees
- Fonts
- Fun
- Internationalization
- Miscellaneous
- Copy-as-format
- Dtrt-indent
- Ietf
- Multiple-cursors
- Nav-flash
- Parinfer
- Spacemacs-completion
- Spacemacs-defaults
- Spacemacs-editing
- Spacemacs-editing-visual
- Spacemacs-evil
- Spacemacs-language
- Spacemacs-layouts
- Spacemacs-misc
- Spacemacs-modeline
- Spacemacs-navigation
- Spacemacs-org
- Spacemacs-project
- Spacemacs-purpose
- Spacemacs-visual
- Music
- Operating systems
- Pair programming
- Programming languages
- Readers
- README.org files that need proper tags
- Source control
- Spacemacs
- Tagging
- Themes
- Tools
- Ansible
- Bm
- CFEngine
- Chrome
- CMake
- Command-log
- DAP
- Debug
- Docker
- Eww
- EXWM
- Fasd
- Finance
- Geolocation
- Imenu-list
- Import-js
- Kubernetes
- LSP
- Meson
- Nginx
- Node
- Pandoc
- Pass
- Prettier
- Prodigy
- Puppet
- Ranger
- Rebox
- Restclient
- Saltstack
- Shell
- Sphinx
- Systemd
- Tern
- Terraform
- Tide Layer
- Tmux
- Transmission
- Vagrant
- Web-beautify
- Xclipboard
- Vim
- Web services
Description
THIS FILE IS AUTO-GENERATED! Don't edit it directly. See "README.org tags" section of CONTRIBUTING.org for the instructions.
This is an overview of Spacemacs configuration layers. For information about configuration layer development see Configuration layers development.
Chats
ERC
Layer for ERC IRC chat.
Features:
- Highlight nicks (using erc-hl-nicks)
- Image inline support (using erc-image)
- Logging to
~/.emacs.d/.cache/erc-logs
andViewLogMode
for viewing logs (using erc-view-log) - YouTube videos Thumbnails inline (using erc-yt)
- Social Graph for ERC messages (using erc-social-graph)
- Optional SASL authentication via the variable
erc-enable-sasl-auth
(using erc-sasl) - D-BUS notifications via the variable
erc-enable-notifications
- Completion of Emojis using company-emoji (still needs a way of showing, either
using the
emoji
layer or having a proper font) 👏
Jabber
This layer adds support for the Jabber (XMPP) client for Emacs
Features:
- Use Jabber without having to leave Spacemacs
RCIRC
This layer provide support for rcirc with optional support for authinfo and ZNC.
Features:
- Store channel logs into
~/.emacs.d/.cache/rcirc-logs/<channel>
- Support for credentials stored in
~/.authinfo.gpg
(need to have gnutls) - Support ZNC support (with optional
~/.authinfo.gpg
) - Colored nicknames
- Real-time change when people use
s/foo/bar/
in chat - Completion of Emojis using company-emoji (still needs a way of showing, either
using the
emoji
layer or having a proper font) 👏
Slack
This layer provides an interface to the Slack chat service via the emacs-slack package. Where possible, this layer aims to reuse key bindings from the IRC packages in Spacemacs.
Features:
- Real time messaging with emacs-websocket
- Connect to multiple slack instances
- Notifications with alert.el
Checkers
Spell Checking
+checkers/spell-checking/README.org
This layer provides spell checking capabilities to Spacemacs.
Features:
- Buffer-wide spell checking via external command (ispell, hunspell, aspell) run through Flyspell.
- Spell as you type
- Optional correction popups, controlled by
enable-flyspell-auto-completion
variable. - Auto dictionary mode for some languages.
Syntax Checking
+checkers/syntax-checking/README.org
This layer adds on the fly syntax checking to all supported language layers.
Features:
- Support for automatic syntax checking with Flycheck for various language layers
- Tooltip syntax errors with
popwin
Completion
Auto-completion
+completion/auto-completion/README.org
This layer adds auto-completion to all supported language layers.
Features:
- Support for code completion with company or auto-complete for various language layers
- Frequency-based suggestions via company-statistics for
company
- Integration with yasnippet and auto-yasnippet
- Automatic configuration of hippie-expand
- Automatic docstring tooltips are provided by company-quickhelp
Compleseus
+completion/compleseus/README.org
This layer adds a new way of completion provided by the following core packages:
consult
embark
marginalia
orderless
selectrum
orvertico
This is an WIP and only supports emacs 27 or later. Please contribute.
Features:
- Same features as
ivy
orhelm
Helm
This layer enables Helm everywhere in Spacemacs. The alternative to this layer is the Ivy layer which brings the same level of integration as Helm.
These completion systems are the central control towers of Spacemacs, they are used to manage buffers, projects, search results, configuration layers, toggles and more…
Mastering your choice of completion system will make you a Spacemacs power user.
Features:
- Project wide
grep
like text search viahelm-dir-smart-do-search
- Project wide text replacements using
helm-edit-mode
- Buffer wide dynamic text search via
helm-swoop
- Fuzzy matching for most
helm-sources
- Detailed configuration parameters for helms appearance
- Intuitive
transient state
Ivy
This layer enables Ivy for completion. It will replace the default completion by Helm.
These completion systems are the central control towers of Spacemacs, they are used to manage buffers, projects, search results, configuration layers, toggles and more…
Mastering your choice of completion system will make you a Spacemacs power user.
Features:
- Project wide
grep
like text search viasearch-auto
- Project wide text replacements using
counsel-imenu
- Buffer wide dynamic text search via
swiper
- Detailed configuration parameters for ivy appearance
- Intuitive
transient state
- Advanced buffer information with
ivy-rich
Templates
+completion/templates/README.org
This layer provides templates to Spacemacs. A template consists of text that is automatically inserted into a new file when it is opened. This is done via yatemplate, which leverages yasnippet.
Features:
- Auto-insert snippets when creating specific new files.
Gnus
This layer integrates a general purpose email/newsgroup client into Spacemacs.
Features:
Mu4e
This layer adds support for the Mu4e
email client.
Features:
- Search, read, reply, move, and delete email.
- Search-based: no folders, only queries.
- UI optimized for speed: quick keystrokes for common actions.
- Very extendable and customizable.
- Integration with Helm.
- Maildir summary using mu4e-mailidirs-extension
- Notifications using mu4e-alert
Notmuch
Notmuch offers a fast, global-search and tag-based email system to use within your text editor or in a terminal.
This layer integrates the Notmuch Emacs package into Spacemacs.
Features:
- Email searching
- Email tagging
Emacs
Better Defaults
+emacs/better-defaults/README.org
This layer enhances the default commands of Emacs and is primarily intended to
be used with the emacs
editing style as it does not change anything in the Vim
key bindings.
However the emacs
editing style is not required. You can still use this layer
while you are using the vim
editing style if you have some kind of mixed
style, but some of the layer bindings might be shadowed by the evil key bindings.
The commands defined in this layer are taken from various sources like Prelude.
Features:
- Smart line navigation: Subsequent presses of
C-a
toggles between the beginning of the line and the first non-whitespace character. Similarly, subsequent presses ofC-e
will toggle between the end of the code and the end of the comments. spacemacs/backward-kill-word-or-region
: A combination ofkill-region
andbackward-kill-word
, depending on whether there is an active region. If there's an active region kill that. If not kill the preceding word.- Fill or unfill paragraph: Pressing
M-q
for the first time fills current paragraph and pressingM-q
for the second time unfills it. Note that some modes override this key binding so it's not available everywhere. Due to implementation details unfilling doesn't work when called twice viaM-x
.
Helpful
This layer replaces the existing emacs related help buffers with more detailed ones.
Features:
- Better help buffers with helpful for emacs related buffers
- Source code shown implicitly in help buffer for all lisp objects
- More detailed descriptions in the emacs specific function, variable and key help buffers
- Better formatted elisp docstrings
IBuffer
This layer configures Emacs IBuffer for Spacemacs.
Features:
- Grouping of buffers by major-modes
- Grouping of buffers by projects
Org
This layer enables org mode for Spacemacs.
Features:
- Vim inspired key bindings are provided by evil-org-mode
- Nicer bullet via org-superstar-mode
- A pomodoro method integration via org-pomodoro
- Presentation mode via org-present
- Insertion of images via org-download
- Project-specific TODOs via org-projectile
- Easy insert of URLs from clipboard with org format via org-cliplink
- Rich insert of code (into a source block with highlighting, and a link) from other buffers via org-rich-yank
- Pixel-perfect visual alignment for Org and Markdown tables via valign
Outshine
Quickurl
Quickurl is a package in vanilla emacs for saving and inserting URLs. These are key bindings for the various methods of insertion, which are not bound by default.
Features:
- Key bindings to dispatch Quickurl (which is in vanilla Emacs).
Semantic
CEDET is a *C*ollection of *E*macs *D*evelopment *E*nvironment *T*ools written with the end goal of creating an advanced development environment in Emacs. CEDET includes common features such as intelligent completion, source code navigation, project management, code generation with templates. CEDET also provides a framework for working with programming languages; support for new programming languages can be added and use CEDET to provide IDE-like features. This framework is called Semantic.
Semantic is a package that provides a framework for writing parsers. Parsing is a process of analyzing source code based on programming language syntax. The packages relies on Semantic for analyzing source code and uses its results to perform smart code refactoring that based on code structure of the analyzed language, instead of plain text structure. Semantic is the core of CEDET.
Features:
- Display function or variable definition at the bottom.
- Display current function cursor is in at the top. See this page for demos in some programming languages.
- Support common C/C++ refactoring with semantic-refactor. See this page for demonstration of refactoring features.
- Support Lisp source code formatting with semantic-refactor. See this page for demonstration of Lisp formatting features.
Smex
This layer provides a more traditional alternative to helm-M-x
based on ido
.
Features:
- Provides an alternative way for
helm-M-x
based onido
and smex
Tabs
This layer adds support for tabs. Implementation is done using Centaur Tabs.
Features:
- Sets up tabs using Centaur tabs as backend
- Optionally auto hide tabs after delay
Typography
This layer provides support for typographic text editing in Spacemacs.
Features:
- Modes to automatically insert and cycle among typographic characters
- Typo Mode automatically inserts and cycles among typographic Unicode characters on some keys.
- Tildify Mode automatically inserts non-breaking spaces where required (Only available on Emacs 25).
File trees
Neotree
This layer setups a file tree navigator buffer using Neotree (replacing the Treemacs layer).
Features:
- intuitive evil key bindings integration
- supports multiple themes
- transient state by pressing on
?
- version-control integration
Treemacs
This layer sets up a file navigation and project explorer side-window via Treemacs.
Features:
A detailed overview of the features of Treemacs is available in the Treemacs readme. In short, Treemacs offers:
- Simple and powerful navigation and ability to detail exactly how and where a file should be opened.
- Good looking icons.
- Display of multiple file trees organized as projects residing in a workspace.
- Ability to show tags contained in files. Tags are provided by Imenu, so nearly every filetype is supported.
- Mouse interface for single and double left clicks in line with modern GUI standards (clicking on an icon will also display the file's tags).
- Location awareness: commands like
find-file
ormagit-status
will use the location of the node at point (with$HOME
as fallback). - Optional fontifying of files based on their git status.
- Optional collapsing of single-dir-child directories into one.
- Doing both asynchronously for an imperceptible performance cost.
- Optional
follow-mode
to automatically focus the currently selected file or tag. - Optional
filewatch-mode
to automatically refresh the view after (and only after) changes to the shown filesystem.
Fonts
Unicode-fonts
+fonts/unicode-fonts/README.org
This layer adds support for unicode-fonts package. It is recommended to install the fonts listed in the Quickstart section of the unicode-fonts README.
Features:
- Display unicode glyphs using the best available font.
- Easily override glyphs or sections of glyphs.
- Display color emoji on both the macOS port version of Emacs and emacs-plus (with
unicode-fonts-force-multi-color-on-mac
set to non nil). - Enable support for font ligature in Emacs 27 + via ligatures.el.
Fun
Emoji
This layer adds support for Emoji emoticons from emoji-cheat-sheet.
Features:
- Browse Emoji in a dedicated buffer
- Display Emoji images in buffer
- Insert one or several Emoji with a helm front-end
- Completion of Emojis using company-emoji
Games
This layer allows you to play evilified games in Spacemacs.
Features:
- 2048-game
- Pacmacs (Pacman for Emacs)
- Sudoku
- Tetris
- Typit
Selectric
This layer makes your Emacs sound like an IBM Selectric typewriter, for those moments when your loud, clicky mechanical keyboard is not at hand, yet, you'd still wish to enjoy the sound.
Features:
- Brings back fond memories about your first programming job where you started with that big mechanical keyboard and the small monochrome display working on the latest IBM Iseries server.
Xkcd
This layer adds a xkcd navigation mode using emacs-xkcd.
Features:
- Load a random xkcd
- Show the text in the modeline
- Open explanation and current comic in browser
- Cache the comics in
.cache/xkcd
Internationalization
Chinese
This layer adds support for traditional Chinese script to Spacemacs.
Features:
- Support for the Pinyin (拼音) input method via chinese-pyim.
- Support for the Wubi (五笔) input method via chinese-wbim.
- Integration of the native input method framework fcitx via cute-jumper/fcitx.el.
- Integration of the Youdao (有道) Dictionary via youdao-dictionary.
- Support for file searches in
dired
using Chinese Pinyin characters via find-by-pinyin-dired. - Support for jumping to Chinese Pinyin characters with
ace-jump-mode
via ace-pinyin. - Support for conversion between simplified and traditional Chinese texts via chinese-conv.
- Automatic visual separation of Chinese and Latin characters via coldnew/pangu-spacing.
- Automatic joining of consecutive Chinese lines into a single long line without unwanted space when exporting org-mode to html.
Japanese
This Layer adds Japanese related packages.
Features:
- evil-tutor-ja: Japanese Vimtutor adapted to Emacs+Evil and wrapped in a major mode
- migemo: Japanese incremental search through dynamic pattern expansion
- helm-migemo-mode: helm with migemo
- avy-migemo: avy with migemo
- ddskk: Simple Kana to Kanji conversion program (SKK)
- japanese-holidays: calendar functions for the Japanese calendar
- pangu-spacing: emacs minor-mode to add space between Japanese and English characters.
- Join consecutive Japanese lines into a single long line without unwanted space when exporting org-mode to html.
Keyboard-layout
+intl/keyboard-layout/README.org
This layer configures some key bindings in Spacemacs, to make it compatible with
keyboard layouts that differ from the traditional en-us
QWERTY
layout.
Features:
- Support alternative keyboard layouts within Spacemacs
- Remap navigation commands to the homerow of your chosen layout
- Remap missing commands automatically to elsewhere in the layout
Miscellaneous
Copy-as-format
+misc/copy-as-format/README.org
This layer adds support for copy-as-format.
Features:
- Function to copy buffer locations as GitHub/Slack/JIRA/HipChat/… formatted code
Dtrt-indent
This is a simple layer wrapping the dtrt-indent Emacs package for automatic detection and switching of indentation style.
It is automatically enabled using the method suggested here.
Features:
- Indentation style detection and automatic configuration to match file in open buffer.
Ietf
The IETF
layer collects various useful packages for participating in the
Internet Engineering Task Force (https://www.ietf.org).
Features:
- Fetching and opening IETF documents.
- Viewing IETF documents.
- Writing IETF documents.
Multiple-cursors
Nav-flash
This layer adds nav-flash package which temporarily highlights the line containing the point, which is sometimes useful for orientation after a navigation command.
Features:
- Fancy flashing line on navigation.
Parinfer
This layer provides an implementation of parinfer, a lisp editing paradigm that controls indentation based on parentheses or vice versa.
Features:
- Automatic management of parenthesis in clojure, emacs lisp, common-lisp and scheme following the parinfer editing paradigm.
- Powered by a native library in the background
Spacemacs-completion
+spacemacs/spacemacs-completion/README.org
This layer does basic setup for completion frameworks like helm
, ivy
and
ido
.
Its main role is to ensure sane defaults and consistent UI between helm
and ivy
because even when you are using only one of them you could still
need to use the other (for instance a package that supports only helm
).
Advanced configuration of these packages can be found in their respective
layers in +completion
layer directory.
Features:
- Base preconfiguration of
helm
andivy
for other layers to use. - Basic support for
ido-navigation
configuration and transient state.
Spacemacs-defaults
+spacemacs/spacemacs-defaults/README.org
This layer configures mostly Emacs built-in packages to given them better defaults.
Features:
-
Configures packages:
- abbrev
- archive-mode
- bookmark
- conf-mode
- cus-edit
- dired
- dired-x
- display-line-numbers (only in Emacs 26.x and newer)
- electric-indent-mode
- easypg
- ediff
- eldoc
- help-fns+
- hi-lock
- image-mode
- imenu
- linum (only in Emacs 25.x and older)
- occur-mode
- package-menu
- page-break-lines
- process-menu
- quickrun
- recentf
- savehist
- saveplace
- subword
- tar-mode
- uniquify
- url
- visual-line-mode
- whitespace
- winner
- zone
Spacemacs-editing
+spacemacs/spacemacs-editing/README.org
This layer adds packages to improve editing with Spacemacs.
Features:
- Support for automatic indentation of code via
aggressive-indent
. - Support for jumping to chars using a decision tree via
avy
. - Improvements for evaluating sexps via
eval-sexp-fu
. - Selecting and editing of multiple text elements via
expand-region
. - Support for editing files in hex format via
hexl
. - Deletion of consecutive horizontal whitespace with a single key
via
hungry-delete
. - Support for selecting, copying and opening links using
avy
vialink-hint
. - Adding of sample text via
lorem-ipsum
. - Transient state for moving text via
move-text
. - Support for folding of code via
origami
andevil-vimish-fold
. - Support for password generation via
password-generator
. - Support for improving parenthesis handling via
smartparens
. - Automatic whitespace cleanup on save via
spacemacs-whitespace-cleanup
. - Support for converting definitions to certain styles via
string-inflection
. - Support for generating UUIDs via
uuidgen
. - Support for conversion between Emacs regexps and PCRE regexps.
- Support for persistent scratch via
persistent-scratch
. - Support for unkillable scratch via
unkillable-scratch
. - Support for sorting (press
s
) viadired-quick-sort
- Support for
evil-easymotion
if the editing style isvim
orhybrid
. - Support for cycling between multi line block styles via
multi-line
. - Support for editing strings inplace via
string-edit
Spacemacs-editing-visual
+spacemacs/spacemacs-editing-visual/README.org
This layer defines a lot of functions used to visually enhance the currently edited line in Spacemacs.
Features:
- Adaptive wrapping
- Hiding of comments
- Highlighting of columns longer than 80 chars
- Highlighting of different indentations
- Automatic highlighting of numbers
- Automatic highlighting of parentheses
Spacemacs-evil
+spacemacs/spacemacs-evil/README.org
This layer adds various adjustments to packages to create an evilified experience throughout the entirety of Spacemacs.
Features:
- Add evil tutorial with
evil-tutor
- Add relative line number with
linum-relative
(only in Emacs 25.x and older) - Add escaping under
fd
by default withevil-escape
- Add occurrences count in mode-line when searching a buffer
- Add support for lisp structure manipulation with
evil-lisp-state
- Add safe structural editing of lisp dialects with
evil-cleverparens
- Add
evil-exchange
to swap text - Add easy live editing of multiple occurrences with
evil-iedit-state
- Add new vim text objects for indentation with
evil-indent-plus
- Add operations to align text with
evil-lion
- Easy management of comments with
evil-nerd-commenter
- Navigation between pairs with
evil-matchit
- Advanced navigation on brackets with
evil-unimpaired
- Easy increment and decrement of numbers with
evil-number
- Support for additional vim movements via
evil-args
- Support for surrounding the marked area with a given character via
evil-surround
- Evilification of various modes if the editing style is
vim
orhybrid
- Improves the comment function to be able to also do the inverse operation
- Persistent highlight of searched text with
evil-search-highlight-persist
- Display tildes in non-buffer area with
vi-tilde-fringe
- Add
evil-collection
Spacemacs-language
+spacemacs/spacemacs-language/README.org
This layer adds support various language related services to Spacemacs.
Features:
- Show definition of word at point via define-word.
- Integration of google-translate into Emacs via google-translate.
Spacemacs-layouts
+spacemacs/spacemacs-layouts/README.org
This layer adds support for distinct layouts/workspaces to Spacemacs.
Layouts provide an easy way to group buffers for a project or any arbitrary buffer grouping you wish. Layouts also restrict actions to the buffers in the current layout.
Features:
- Support for distinct layouts via
eyebrowse
- Integration with
helm
andivy
to search for buffers within layouts
Spacemacs-misc
+spacemacs/spacemacs-misc/README.org
This layer adds some general packages into Spacemacs.
Features:
- Support for jumping to definitions via
dumb-jump
orevil-goto-definition
. - Support for an easy http request client via
request
.
Spacemacs-modeline
+spacemacs/spacemacs-modeline/README.org
This layer adds various mode-lines to Spacemacs.
Features:
-
Display of a vim-powerline like mode-line being able to show various information like
- Current battery status
- All active minor modes displayed as unicode symbols
- The active major mode
- The current branch if the file is in version control
- The current cursor position
- The system clock
- Display of a small system monitor in a separate mode-line.
Spacemacs-navigation
+spacemacs/spacemacs-navigation/README.org
This layer adds general navigation functions to all supported layers.
Features:
-
Support for ace-links in
spacemacs
bufferinfo-mode
help-mode
eww-mode
- Support for keeping the cursor centered on the screen
- Evilified version of
doc-view-mode
- Tweaks for
golden-ratio-mode
- Support for
paradox
a modern emacs package manager - Shortcuts for restarting
emacs
- Shortcuts for easily switching between windows
Spacemacs-org
+spacemacs/spacemacs-org/README.org
This layer tweaks org-mode
to integrate nicely into Spacemacs.
Features:
- Configuration for
flyspell
to checkorg-buffers
for typos. - Support for automatically generated Table-Of-Contents via
toc-org
. - Support for custom bullet markers via
org-superstar
. - Support for a special view mode for org documents via
space-doc
.
Spacemacs-project
+spacemacs/spacemacs-project/README.org
This layer tweaks projectile
to integrate nicely into Spacemacs.
Features:
- Setup of
projectile
key bindings, including functions for project search, switching, version control and compilation. - Additional path helper functions, to copy the location of a buffer relative to the project root.
Spacemacs-purpose
+spacemacs/spacemacs-purpose/README.org
This layer enables window-purpose, which provides an alternative, purpose-based window manager for Emacs. With this layer, your window layout should be robust and shouldn't change too much when opening all sorts of buffers.
Regular popwin is not triggered when window-purpose is enabled. However,
the window-purpose layer provides a purpose-popwin
extension, which
brings popwin's behavior to window-purpose and solves that problem.
Features:
- Window layout is more robust and less likely to change unintentionally
- Dedicate window to a purpose
- User-defined purposes
- Extensible window display behavior
- Empty
purpose-mode-map
, to avoid conflicts with other key maps - Replicate popwin behavior for purpose-mode - almost no regression in popup behavior from using window-purpose.
- Reuses popwin's settings:
popwin:special-display-config
,popwin:popup-window-height
andpopwin:popup-window-width
. - Difference from popwin: when several windows are open, popup window is sometimes bigger than with regular popwin in the same situation.
Spacemacs-visual
+spacemacs/spacemacs-visual/README.org
This layer adds various modes to enhance Spacemacs visual appearance.
Features:
- Automatic colorization of compilation buffers via
ansi-colors
. - Support for resuming the last layout when starting Spacemacs via
desktop
. - Support for showing a thin vertical line to indicate the fill column
via
fill-column-indicator
. - Automatic highlighting of
TODO-tags
in programming and text modes viahl-todo
. - Support for temporary windows which close automatically via
popwin
. - Support for text zooming via
zoom-frm
.
Music
Alda Layer
Alda is a music composition language allowing music to easily be written and edited in a text file.
This layer adds key bindings for alda-mode
's functions, which allow Alda code
to be interpreted and played by the running Alda server. It will also start the
Alda server if it is not running.
Features:
- Syntax highlighting for Alda files.
- Play portions of a buffer, or the entire buffer, through a running Alda server.
Extempore
This layer adds support for the Extempore programming environment.
Features:
- run Extempore (inferior extempore buffer)
- connect to & evaluate code
- eldoc support
Pianobar
This layer integrates an online music service into Spacemacs.
Features:
- Support for listening to music from within Emacs via Pianobar.
Spotify
This layer integrates an online music service into Spacemacs.
Features:
- Support for listening to music from within Emacs via Spotify.
TidalCycles
This layer adds a major mode to control TidalCycles, a programming language for live coding.
Features:
tidal-mode
to interact with TidalCycles- Spacemacs friendly key bindings
Operating systems
NixOS
This layer adds tools for better integration of Emacs in NixOS.
Features:
- Nix-mode using nix-mode
- Auto-completion of NixOS Options using company-nixos-options
- Helm Lookup for NixOS Options helm-nixos-options
OSX
Spacemacs is not just Emacs plus Vim. It can have macOS key bindings too! This layer globally defines common macOS key bindings.
Features:
⌘
is set tohyper
and⌥
is set tometa
- In
dired
usegls
instead ofls
- Fix separator colors of Spaceline mode-line
Pair programming
Floobits
+pair-programming/floobits/README.org
This layer adds support for the peer programming tool floobits to Spacemacs.
Features:
- Loading of floobits configuration files with fixed commands
- Creation of floobits workspaces and populating it with content
- Marking of the current cursor position for all users within the current workspace
- Follow recent changes by other users
Programming languages
Domain-specific (DSLs)
Lisp dialects
Clojure
This layer adds support for Clojure language using CIDER, providing Clojure REPL management and a full suite of tooling for Clojure development.
Features:
- REPL via CIDER
- Code formatting via CIDER using Cljfmt
- Refactoring via clj-refactor
- Aligning of code forms via clojure-mode
- Debugging with sayid
- Advanced help with helm-cider
- Structuraly safe editing using optional evil-cleverparens
- Linting via clj-kondo (joker and squiggly-clojure also available)
Related layers
The following Spacemacs layers should also be added for a complete experience.
- auto-completion
- syntax-checking (provides flycheck for linter support)
- LSP
Other optional features
- Refactoring via clj-refactor
- Debugging with sayid
References
Common Lisp
This layer provides support for Common Lisp to Spacemacs.
Features:
Emacs Lisp
This layer gathers all the configuration related to emacs-lisp. This should always be in your dotfile, it is not recommended to uninstall it.
Features:
- Auto-completion using company
- Linting using flycheck integration
- Linting package file metadata using flycheck-package
- Repl support via
IELM
- Support for specific lisp navigation styles via
emacs-lisp-mode
- Auto-compile via auto-compile package
- Debugging via edebug
- Ert test runner with overseer
- Nameless package prefix with optional nameless
- Structurally safe editing using optional evil-cleverparens
- Visual feedback when evaluation using eval-sexp-fu
Scheme
This layer adds support for Scheme via Geiser. Note that combined usage of racket-mode and geiser has not been tested.
Features:
- Support the Scheme compiler Chicken
- Support for the extension language platform Guile
- Structurally safe editing using optional evil-cleverparens
Markup & configuration
Asciidoc
BibTeX
BibTeX and BibLaTeX files are a common way to manage bibliographies. The format was original designed to work with LaTeX files and subsequently has been adopted by other markup formats such as MarkDown and Org mode.
This layer adds support to manipulate BibTeX and BibLaTeX files in Spacemacs.
Features:
- Syntax highlighting for BibTeX and BibLaTeX files.
- Utilities for automatically adding entries from different data sources.
- Support for inserting citations in various other modes.
CSV
This layer adds tools for better integration of CSV files in Spacemacs.
Features:
- Detecting of fields for various separators
- Aligning of fields
- Traversal of fields
- Killing of fields
- Sorting of rows
- Transposing of rows/columns
- Intelligent yanking of fields
Dhall
This layer adds support for the Dhall Configuration Language, a non-repetitive alternate to YAML.
Features:
- Syntax highlighting for
.dhall
source files - Automatic buffer reformatting on save (configurable)
- Type error display in side-buffer
Note: You will need a dhall
binary on your PATH
. Official releases can be
found here.
Graphviz
This layer adds support for the open-source graph declaration system graphviz to Spacemacs.
Features:
- Syntax highlighting for
.dot
files - Integration of a live-preview of
.dot
files via graphviz-dot-mode. - Control of the graphviz compiler directly from emacs.
- Support for formatting
.dot
files automatically.
HTML
This layer adds support for editing HTML and CSS.
Features:
- Editing HTML and CSS file using web-mode
- Support for Sass/Scss and Less files
- Generate HTML and CSS coding using emmet-mode
- Tags navigation on key
%
using evil-matchit - Support for editing Slim and Pug templates using slim-mode and pug-mode
- See the effects of typed HTML using impatient-mode
- imenu support for CSS and Sass through counsel-css
- Formatting with web-beautify
JSON
This layer adds support for JSON files with json-mode
Features:
- Syntax highlighting
- Auto-completion
- Get the path to a JSON value with json-snatcher
- Navigate JSON hierarchy with json-nagivator
- Formatting with web-beautify or prettier
Jsonnet
This layer provides support for Jsonnet template provided by jsonnet-mode.
Features:
- syntax highlighting
- buffer formatting
- jump to definition
- buffer evaluation
LaTeX
This layer adds support for LaTeX files with AucTeX.
Features:
- Auto-build with auctex-latexmk
- Syntax highlighting
- Auto-completion
- Tags navigation on
%
with evil-matchit - Labels, references, citations and index entries management with RefTeX
Markdown
This layer adds markdown support to Spacemacs.
Features:
- markdown files support via markdown-mode
- mdx file support via markdown-mode
- Fast GitHub-flavored live preview via vmd-mode
- TOC generation via markdown-toc
- Completion of Emojis using company-emoji (still needs a way of showing, either
using the
emoji
layer or having a proper font) 👏
Plantuml
This layer enables support for plantuml-mode, which provides a major-mode for plantuml. PlantUML is a tool to generate UML diagrams from plain-text.
For help with how to use plantuml, see the plantuml website and the reference guide.
The official file extension supported by this layer is .pum
. If you want something else,
set it in your user-config
function of your ~/.spacemacs
file.
For example, the following diagram can be defined as follows:
@startuml
JAremko->robbyoconnor : I think the docs can benefit from some kind of illustration
JAremko<-robbyoconnor : I'm too lazy -- I have actual work to do. I link to the docs. If you can write me a diagram in plantuml, I'll gladly compile and add it.
JAremko->robbyoconnor : *gives ths diagram*
robbyoconnor<-JAremko : *robbyoconnor adds it and JAremko is happy*
...
robbyoconnor->theOtherPerson : And they thinks it's funny? Yup, they definitely finds it funny. Right?
@enduml
Features:
- Syntax highlighting
- Diagram preview in various output formats
- Embedding into org documents
- Controlling the
Plantuml
compiler directly from emacs
ReStructuredText
+lang/restructuredtext/README.org
The layer adds ReStructuredText (ReST) support to Spacemacs and adds some
functions to rst-mode
.
Note: to add Sphinx
specific support use the layer sphinx
.
Features:
rst
files are supported via Emacs built-inrst.el
.- Lists are inserted by new functions.
- Directives can be inserted easily.
- snippet support via
yasnippet
.
Semantic Web
This layer adds support for RDF files in N3 and Turtle syntax using ttl-mode and for SPARQL queries using sparql-mode.
SPARQL-mode supports the execution of queries. When first called, you will be prompted for a SPARQL HTTP endpoint in the minibuffer, which defaults to http://localhost:2020/. Once set, it will be used for all subsequent queries in that buffer. Results will be displayed in another buffer in CSV format.
Features:
- Provides an alternative way to search the web using SPARQL queries.
YAML
This layer provides support for the YAML file format.
Features:
- Syntax highlighting
- Syntax checking via flycheck
Yang
This layer provides support for the YANG file format.
Features:
- Syntax highlighting
- Syntax checking via flycheck
Scripting
Autohotkey
Syntax highlighting and Emacs functions for use with AutoHotkey or AutoHotkey_L.
Using a combined implementation of ahk-mode from Xah Lee's xahk-mode
and Robert Widhopf-Fenk's autohotkey-mode
. Updated with the latest
ahk and ahk_l commands found in the latest revision of
SciTE4AutoHotkey.
Contributed and maintained by Rich Alesi.
Features:
- Auto-completion
- Documentation Lookup
- Execute Code Snippets
- Correct Indentation and Commenting
Graphql
This layer adds support for graphql file. It builds around graphql-mode. Please check its site for extra info.
Features:
- Syntax highlight and graphql calls with
graphql-mode
- Autocomplete with
comapy-dabbrev
- Format buffer with
prettier
- Go to definition with
ahs
Shell Scripts
+lang/shell-scripts/README.org
This simple layer adds support for shell scripting.
Supported scripting files:
.sh
.fish
: fish shell
Note: For Windows scripting see the layer windows-scripts
Features:
- Auto-completion using company-shell
Sh
scripts linting using shellcheckSh
scripts style checking using bashate- Support for the Language Server Protocol (experimental)
Vimscript language
This layer adds support for vimscript and pentadactyl config files.
Features:
- Syntax highlighting
- Auto-completion (with LSP)
- Syntax-checking (with LSP)
Windows Scripting
+lang/windows-scripts/README.org
This simple layer adds support for the Powershell scripting language as well as support for batch files.
Features:
- Syntax highlighting of powershell
.ps1
files via powershell.el - Syntax highlighting of batch
.bat
files via bat-mode - Auto-completion, code-navigation and refactoring capabilities of batch files via bmx-mode
Coq
This layer adds support for the Coq proof assistant (adapted from spacemacs-coq) to Spacemacs.
Features:
- Syntax highlighting
- Syntax-checking
- Auto-completion
- Debugging of mathematical proofs from within Emacs using a special proof layout
- Replacement of certain constants with the correct mathematical signs
- Inserting of certain preconfigured proof elements
Elasticsearch
+tools/elasticsearch/README.org
This layer adds Elasticsearch query and monitoring support to Spacemacs.
Features:
- Autocompletion for Elasticsearch Query DSL
- Support for Org-Babel
- Support for an Elasticsearch Command Center to monitor a cluster
ESS (R)
This layer adds support for statistical programming languages to Spacemacs.
Features:
- Syntax highlighting
- Auto-completion
- Syntax-checking via lintr
- Additional data viewer for R via ess-R-data-view
- Support for Org-Babel
- Showing of inline help for
R
constructs - Repl support via
R terminal
- Support for
S
,SAS
andR
- Much more via the ESS Project
Extra Languages
This layer adds a number of packages for less common languages and major modes.
Features:
-
Support for:
- Arch Linux PKGBUILDs
- Arduino
- Android Logcat (not associated with any file types by default)
- Gentoo ebuilds
- Hoon
- MATLAB
- QML
- OpenScad
- Stan
- Thrift
- Vala
- Wolfram Language / Mathematica
Faust
This layer adds support for the faust language to Spacemacs.
Features:
- Syntax highlighting
- Auto-completion
GPU
This layer adds support for GPU related languages like CUDA, OpenCL and various Shader formats to Spacemacs.
Features:
-
Syntax highlighting for
.cl
(OpenCL).cu
(CUDA).cuh
(CUDA).fsh
(Shaders).vsh
(Shaders).glsl
(Shaders).vert
(Shaders).frag
(Shaders).comp
(Shaders).geom
(Shaders).tesc
(Shaders).tese
(Shaders)
-
Simple auto-completion via company-glsl for
.vert
(Shaders).geom
(Shaders).tesc
(Shaders).tese
(Shaders).frag
(Shaders).comp
(Shaders)
Kivy
This layer adds support for Kivy, cross-platform GUI framework for Python.
Features:
- Syntax Highlighting
Mercury
This layer adds support for the Mercury language.
Features:
- Indentation.
- Syntax highlighting.
- Compiling and running.
Octave
This layer adds support for GNU Octave
files to Spacemacs.
Features:
- Syntax highlighting for
.m
files via octave-mode. - REPL support
- Support for directly running
Octave
scripts from Emacs. - Integration with
Octaves
documentation search function.
Prolog
This layer adds support for Prolog using the bundled Prolog mode for Emacs. In addition it also adds ediprolog support for better interaction with SWI-Prolog.
Features:
- Designed for SWI-Prolog as a default, but can be used with other Prologs that Prolog mode supports.
- Interactive consulting and compiling.
- Auto-formatting.
- Apropos and help lookup.
Solidity Layer
A layer to support Solidity development in Spacemacs.
Features:
- Syntax highlighting
- Syntax checking
- Gas estimation
SQL
This layer adds support for a wide range of SQL dialects to Spacemacs.
Features:
-
Syntax highlighting for the following SQL dialects
- ANSI
- DB2
- Informix
- Ingres
- Interbase
- Linter
- Microsoft
- MySQL
- Oracle
- Postgres
- Solid
- SQLite
- Sybase
- Vertica
- Syntax-checking via sqlint for ANSI SQL.
- Format code with
sqlfmt
- Snippet insertion for the more general SQL constructs.
- REPL support via
SQLi
buffer. - Automatic capitalization of keywords.
- LSP support via sqls.
Frameworks
Django
This layer adds support for the Python web framework Django to Spacemacs.
Features:
- Test execution directly from emacs
- Starting/stopping of the Django test server
- Starting of an interactive Python shell in the current project for debugging
- Fixed commands to open various Django specific settings files
- Automatic deployment with Fabric directly from emacs
- Control of South database migration tool
Emberjs
+frameworks/emberjs/README.org
This enables helpers for working with Ember.js projects.
This also includes ember-yasnippets. See the README for ember-yansippets for the snippet keys.
To use this, you need to add add a .dir-locals.el
file with the following in the root of your ember project:
((nil . ((mode . ember))))
If you do not wish to do the following, you may also just do M-x ember-mode
, however it will make things easier.
Additionally, temporary backup, autosave, and lockfiles interfere with broccoli watcher, so they need to either be moved out of the way or disabled.
Add the following to your dotspacemacs/user-config
:
(setq backup-directory-alist `((".*" . ,temporary-file-directory)))
(setq auto-save-file-name-transforms `((".*" ,temporary-file-directory t)))
(setq create-lockfiles nil)
Features:
- Ability to easily switch between various files
- Key bindings for generators and also easily revert generator actions
- Ability to build, start server, and run tests
Phoenix
+frameworks/phoenix/README.org
This layer adds key bindings for Alchemist's already built in phoenix mode.
Features:
- Key bindings for navigation to files
React
ES6 and JSX ready configuration layer for React
It will automatically recognize .jsx
files and files with react
imported.
Features:
- on-the-fly syntax checking
- proper syntax highlight and indentation with jsx
- backend support for autocompletion as in rjsx-mode
- jsfmt automatic formatting
- js2-refactor
- js-doc
Ruby on Rails
+frameworks/ruby-on-rails/README.org
This layer aims at providing support for the Ruby on Rails framework.
Features:
- Quick file navigation with with projectile-rails
- Run server
- Run generators
- Rake runner
- Interactive Rails console
Vue
Layer for Vue, for working with .vue
files.
Note: This layer creates a derived mode called vue-mode
on the fly out of
web-mode
to handle vue files. It will conflict with the vue-mode package, make sure
you don't use that package together with this layer.
Features:
- Wholesome features from
web-mode
, especially on template part - Better performance
- On-the-fly syntax checking with
eslint
- Proper syntax highlight and indentation with
vue-mode
- Two options for backend support for autocompletion and code analysis:
lsp
anddumb
- Code autocompletion with
company-mode
- Formatting code with
prettier
layer evil-matchit
%
to jump between open and close tagsemmet-mode
andyasnippet
for code expanding with theTAB
key
General-purpose
Imperative
Asm
This layer adds support for Assembly code. The built-in major mode for
editing assembly code in Emacs is asm-mode
.
The layer also adds nasm-mode
for NASM-specific syntax. Although nasm-mode
is intended for NASM, it actually works well with other variants of Assembly
in general, and provides Imenu integration so you can jump around with SPC s j
.
Features:
- Improved syntax highlighting.
- Automatic indentation.
- Auto-completion for symbol in opened buffers.
- Look up documentation for current instruction at cursor.
- Imenu integration.
Forth
This layer adds basic support for the Forth family of languages to spacemacs.
Features:
- Syntax highlighting
- Showing meaning of objects in context of the current
Forth
session. - Eval of entire files or regions in current
Forth
session. - Passing interactive commands to current
Forth
session.
Multi-paradigm
JavaScript dialects
CoffeeScript
This layer adds support for the CoffeeScript language using coffee-mode.
Features:
- Syntax highlighting
- Auto-completion with
auto-completion
layer - Syntax checking and linting with
syntax-checking
layer Org-Babel
integration- REPL support
JavaScript
This layer adds support for the JavaScript language using js2-mode.
Features:
- Multiple backends support: Tern and LSP
- Smart code folding
- Refactoring: done using js2-refactor.
- Auto-completion and documentation
- Browser based REPL available via skewer-mode and livid-mode
- Server based REPL with nodejs-repl
- Formatting with web-beautify or prettier
- Interactive debugger using dap-mode
- Display Flow & Typescript type information
Purescript
This layer provides basic Purescript editing support for spacemacs.
Features:
- Syntax highlighting through purescript-mode
- Automatic insert of imports through psc-ide-emacs
- REPL through psci
- Syntax checking through flycheck
- Autocompletion through company
TypeScript
This layer adds support for TypeScript and TSX editing.
Features:
- Multiple backends support: Tide and LSP
- Eldoc-mode
- Documentation at point
- Auto complete
- Flycheck with either tslint or eslint
- Jump to definition, Jump to type definition
- Find occurrences (Imenu-mode)
- Rename symbol
- tsx mode
- formatting
- TypeScript playground integration
C#
This layer adds support for the C# language using the omnisharp-roslyn language server with either the omnisharp-emacs or the lsp-mode packages.
Features:
- Syntax checking with flycheck (when
syntax-checking
layer is used) - Support for auto-completion (when
auto-completion
layer is used) - Refactoring
- Navigation to cross-references
- Inspecting types in metadata
C/C++
This layer adds configuration for C/C++ language.
Features:
-
Multiple backends support:
- LSP with either
clangd
or ccls - rtags (gtags)
- emacs-ycmd
- LSP with either
- Support for debuggers realgud and dap (with LSP backend)
- Support syntax checking via flycheck (
syntax-checking
layer required) - Auto-completion via company (
auto-completion
layer required) - Support code reformatting with clang-format.
- Support for disassembly of code with disaster.
-
sematic
layer integration:- Function or variable definition at the bottom
- Current function cursor is at the top. See stickyfunc-demos for demos in some programming languages.
- Support common refactoring with semantic-refactor. See srefactor-demos for demonstration of refactoring features.
-
cscope
layer integration:- code navigation
Crystal
This layer provides support for the Crystal language.
Features:
- Format on save
- Integration of play.crystal-lang.org using play-crystal.el
- Syntax checking
- Auto completion
- Test execution (
crystal spec
) crystal tool
integration- Interactive REPL (inf-crystal.el and icr)
- Static code analysis using ameba
D language
This simple layer adds support for the D language to Spacemacs.
Features:
- Syntax highlighting
- Auto completion via
company
- Syntax checking via
flycheck
Dart
This layer adds support for Dart language, and could be optionally used for Flutter development as well.
Features:
- Syntax Highlight
- Error checking with
flycheck
- Go to Definition
- Dart Analyzer integration
- Key bindings
Elixir
This layer adds support for Elixir.
Alchemist brings the Elixir tooling to Emacs and comes with a bunch of features. Lsp-mode brings IDE like features following Language Server Protocol, through elixir-ls
As Alchemist is no longer maintained, elixir-ls is a preferred solution, even though it has less features at the moment.
Features:
- Powerful IEx integration
- Mix integration
- Compile & Execution of Elixir code
- Inline code evaluation
- Documentation lookup
- Definition lookup
- Smart code completion
- Elixir project management
- Integration with company-mode
- Flycheck support for credo
- Flycheck support for test results
- Interactive debugger using dap-mode
Erlang
This layer adds support for Erlang.
Enabling Lsp-mode brings IDE like
features following Language Server Protocol
, through erlang_ls
Features:
- Syntax highlighting
- Syntax checking via
Flycheck
integration - Auto-completion via
Company
integration - Code Completion
- Go To Definition
- Go To Implementation for OTP Behaviours
- Signature Suggestions
- Compiler Diagnostics
- Dialyzer Diagnostics
- Elvis Diagnostics
- Edoc
- Navigation for Included Files
- Find/Peek References
- Outline
- Workspace Symbols
- Code Folding
F#
This layer adds support for F# language using fsharpbinding and fsharp-mode.
Features:
- Auto-completion
- Syntax-checking
- Syntax highlighting
- REPL
Factor Layer
A spacemacs layer for Factor language support.
Features:
- Syntax Highlighting
- Factor REPL integration
- Auto-Completion in REPL
- Scaffolding support
- Refactoring support
- Running graphical Listeners
- Reloading emacs-lisp portion of FUEL
Go
This layer adds extensive support for the Go programming language.
Features:
- Run gofmt / goimports on file save (see Autoformat)
- Auto-completion
- Source analysis using go-guru (see Guru)
- Refactoring with godoctor
- Edit struct field tags with gomodifytags
- Syntax checking with flycheck's built-in checkers or golangci-lint (see Linting)
- Test generation via go-gen-test (see Tests)
- Coverage profile visualization (see Coverage)
- List packages faster with gopkgs
- Fill a structure with default values using the fillstruct
- Gopls backend support (see LSP backend)
- Interactive debugger with LSP using dap-mode
Groovy
This layer supports Groovy development in Spacemacs.
Features:
- Auto-completion
- Syntax-checking
- Auto-generate imports with groovy-imports
- Groovy REPL integration
- Syntax highlighting
Hy
This layer adds support for the Hy language based on Python.
Features:
- syntax-highlighting
- Auto-completion
- Code Navigation
- Python test runners (see python layer)
- Virtual Environment using pyvenv and pyenv
- Org Babel support
Java
This layer adds support for the Java language.
Features:
JR Concurrent Programming Language
This layer adds syntax highlighting for the JR Concurrent Programming Language. JR is the implementation of the SR language for Java.
Features:
- Syntax highlighting
Julia
This layer adds support for Julia to Spacemacs.
Features:
- Syntax highlighting
- Repl support
- Linting
- Completion
- Jump-to-definition
- Documentation on hover
Kotlin
This layer adds support for Kotlin to Spacemacs.
Features:
- Syntax highlighting
- Auto-completion
- Syntax-checking with ktlint and flycheck-kotlin
- Navigation with
ggtags
Lua
This layer adds support for editing Lua.
Features:
Nim
This layer adds support for the multi-paradigm language Nim
.
Features:
- Auto-completion
- Syntax-checking
- Jump to definition.
Ocaml
This is a very basic layer for editing ocaml files.
Features:
- Syntax highlighting (major-mode) via tuareg-mode
- Error reporting, completion and type display via merlin
- auto-completion with company mode via merlin
- syntax-checking via flycheck-ocaml (or alternatively merlin)
dune
file syntax highlighting and template insertion via dune-mode- Automatic formatting via ocamlformat
Pact
This layer adds support for the Pact Smart Contract Language.
Features:
- Syntax highlighting for
.pact
source files - Easy interaction with an embedded Pact REPL
- Flycheck integration
Note: You will need a pact
binary on your PATH
for REPL features to function.
Perl5
This layer adds support for the Perl5 language.
Features:
PHP
This layer adds PHP language support to Spacemacs.
Features:
- Edit PHP files using php-mode
- Edit Drupal files
- Complete and jump to define with company-php
- Run tests with PHPUnit
- Reformat code with PHP CBF
- Debug your programs with XDebug (via geben or dap-mode)
- Refactor source files with help of phpactor.el
- Support for the Language Server Protocol (experimental)
The gtags
layer is recommended to benefit from better eldoc
and
helm-gtags
.
Python
This layer adds support for the Python language.
Features:
-
Support for the following backends:
- anaconda (default),
-
Language Server Protocol (experimental - 2 implementations),
- python-lsp-server
- Microsoft python language server
- Auto-completion
- Code Navigation
- Documentation Lookup using anaconda-mode and pylookup
- Test Runners using nose.el or pytest
- Virtual Environment using pyvenv and pyenv as well as pipenv and poetry
- semantic mode is enabled
- PEP8 compliant formatting via YAPF or black
- PEP8 checks with flake8 or pylint
- Suppression of unused import with autoflake
- Use the
%
key to jump between blocks with evil-matchit - Sort imports with isort
- Fix a missing import statement with importmagic
- Pip package manager with pippel
- Interactive debugger using dap-mode
Racket
Adds support for the Racket programming language.
Features:
- Syntax highlighting with
racket-mode
- Test runner
- Interactive REPL
- Code navigation with
gtags
- Structurally safe editing using optional evil-cleverparens
Raku
This layer provides an environment for the Raku Programming Language that was previously known as Perl 6.
Features:
- Jump to definition & Code completion via ctags-universal
- Syntax checking via flycheck-raku and
raku -c
- Syntax highlighting & Syntax indentation via raku-mode
META6.json
highlighting via json-mode-
Provides Evil text objects for:
- double-angle-brackets
- corner-brackets
- single-quotation-marks
- double-quotation-marks
ReasonML
Spacemacs layer for ReasonML, based around reason-mode.
Features:
- Syntax highlighting / indentation
- Autocomplete (via
merlin
) - Lint / error display (via
merlin
, andflycheck
ifsyntax-checking
layer is enabled) - REPL via
rtop
- Auto-formatting (via
refmt
)
Ruby
This layer provides support for the Ruby programming language.
Features:
- Version manager (rbenv, rvm or chruby)
- Integration with bundler
- Test runner (ruby-test and rspec)
- Rake runner
- Linter (rubocop)
- Formatter (prettier)
- Interactive REPL and code navigation (robe)
- Interactive debugger using dap-mode
Rust
Scala
This layer adds support for the Scala language to Spacemacs.
Features:
- Syntax highlighting
- Support for language backend using LSP and Metals
- Debugging support via
dap
- Auto-completion
- Treeview support for viewing project structure and triggering compilation
- Syntax-checking
- Refactoring
- Incremental compilation
- Style linting
- Optional GGTags search
SML
Adds support for the SML programming language to Spacemacs.
Features:
- Syntax highlighting
- Integration of the
SML Repl
into Emacs - Basic completion of SML forms via
sml-electric-space
Swift
This layer adds support for Apple's Swift programming language, used as a general purpose scripting language.
Features:
- Syntax highlighting with swift-mode
- Indentation
- Code navigation using
imenu
(built-in) - Automatic syntax checking with
flycheck
(available with thesyntax-checking
layer)
Zig
This layer adds support for the zig programming language https://ziglang.org/
Features:
- Syntax Highlighting
- LSP support via
zls
(see LSP)
Purely functional
Agda
This layer adds support for the Agda programming language.
Features:
- Faces redefined to correctly play with themes.
- Spacemacs bindings to Agda's interactive tools.
This layer is in construction, it needs your contributions and bug reports.
Elm
This layer adds support for Elm.
It relies on elm-mode and flycheck-elm.
Features:
- Syntax highlighting.
- Intelligent indentation
- Auto-completion integration for company (default) or auto-complete modes
- Syntax checking support using flycheck
- Integration with elm-make
- Integration with elm-repl
- Integration with elm-reactor
- Integration with elm-package
Haskell
This layer adds support for the Haskell language.
Features:
- syntax highlighting for haskell source, cabal files, C– source
- auto-completion and syntax-checking with one of the selected backends (
dante
orlsp
).
Idris
This layer adds support for the Idris language to Spacemacs.
Features:
- Syntax highlighting
- Syntax checking via
flycheck
- Integration of the
Idris
REPL - Integration of the
Idris
build system
Utilities
Conda Layer
This layer adds support for the Anaconda python environment for numerical computations to Spacemacs.
Features:
- Controlling
Anaconda
orMiniconda
environments directly from emacs with conda.el
Dotnet
This layer adds support for the dotnet cli package.
Features:
- dotnet project operations
IPython Notebook
+tools/ipython-notebook/README.org
This layer adds support for the package emacs-ipython-notebook
.
Do not hesitate to check the original package README here. Also the wiki has lots of informative stuff.
Features:
- Key bindings available through transient-state or leader key
- Lazy-loading
- Auto-completion
Protocol Buffers
Highlighting and syntax checking for Protocol Buffer files.
Features:
- Syntax highlighting
- Syntax checking using Flycheck (
protoc
compiler must be available) - Correct indentation and commenting
- Quickly browse file contents using imenu (default key binding
SPC b t
).
Sailfish OS developer
+tools/sailfish-developer/README.org
This layer adds support of sailfish-os development packages.
Features:
- sailfish-scratchbox: handy sb2 interaction.
Readers
Dash
This layer integrates offline API browsers into Emacs. It provides one for macOS, Linux and Windows.
Features:
Deft
This layer adds a search driven note taking system into Spacemacs.
Features:
- Browsing and creating notes with a powerful search function via Deft.
- Integration of
org-mode
as note editor. - Configurable list of extensions to recognize as notes.
- Zettelkasten system with zetteldeft
Elfeed
This layer integrates a web feed reader into spacemacs.
Features:
- Support for reading RSS and Atom feeds directly within emacs via Elfeed.
- Support for managing feeds via org files supplied by elfeed-org.
- Support for displaying feed database content in the browser via web interface.
Epub
This layer provides support for reading EPUB-formatted eBooks in Spacemacs using the excellent nov.el package.
Features:
- Basic navigation (jump to TOC, previous/next chapter)
- Remembering and restoring the last read position
- Jump to next chapter when scrolling beyond end
- Renders EPUB2 (.ncx) and EPUB3 (<nav>) TOCs
- Hyperlinks to internal and external targets
- Supports textual and image documents
- View source of document files
- Metadata display
- Image rescaling
This layer enables support for PDF with the pdf-tools package.
According to the official repository:
"PDF Tools is, among other things, a replacement of DocView for PDF files. The key difference is, that pages are not pre-rendered by e.g. ghostscript and stored in the file-system, but rather created on-demand and stored in memory."
Features:
- Searching and slicing with
occur
. - Show document headings in outline buffer.
- Manipulate annotations.
- Fit PDF to screen.
Speed Reading
+readers/speed-reading/README.org
A speed reading mode for Emacs.
Features:
- Support for
speed-reading
of arbitrary texts
README.org files that need proper tags
LanguageTool
+tools/languagetool/README.org
This layer adds grammar checking using LanguageTool. LanguageTool will use the
language set using SPC S d
if the spell-checking
layer is enabled.
Features:
- Spelling and grammar checking
Source control
Git
+source-control/git/README.org
This layers adds extensive support for git to Spacemacs.
Features:
- git repository management the indispensable magit package
- forge add-on for magit.
- git-flow add-on for magit.
- quick in buffer history browsing with git-timemachine.
- quick in buffer last commit message per line with git-messenger
- colorize buffer line by age of commit with smeargle
- git grep with helm-git-grep
- gitignore generator with helm-gitignore
- org integration with magit via orgit
New to Magit? Checkout the official intro.
GitHub
+source-control/github/README.org
This layers adds support for GitHub.
Features:
- forge: integration with various forges, such as GitHub and GitLab.
- gist.el: full-featured mode to browse and post GitHub gists.
- git-link: quickly generate URLs for commits or files.
- github-clone allows for easy cloning and forking of repositories.
- grip-mode Github-flavored Markdown/Org preview using Grip.
Perforce
+source-control/perforce/README.org
This layer integrates Perforce
SCM system into Spacemacs.
Features:
- Support for running Perforce (p4) SCM commands directly from Emacs.
Version-Control
+source-control/version-control/README.org
This layers adds general configuration for Emacs VC. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc…
Features:
- highlights uncommitted changes in the fringe or margin with diff-hl, git-gutter, or git-gutter+
- adds vcs transient-state
SPC g.
to allow quick navigation and modification of buffer hunks.
Spacemacs
Distributions
Spacemacs distribution
+distributions/spacemacs/README.org
This is the default distribution for Spacemacs.
Features:
-
Easy access to the Spacemacs experience by adding below auxiliary layers to the base distribution.
- helm
- treemacs
- spacemacs-completion
- spacemacs-layouts
- spacemacs-editing
- spacemacs-editing-visual
- spacemacs-evil
- spacemacs-language
- spacemacs-misc
- spacemacs-modeline
- spacemacs-navigation
- spacemacs-org
- spacemacs-purpose
- spacemacs-visual
Spacemacs-base distribution
+distributions/spacemacs-base/README.org
This is the base distribution for Spacemacs.
Features:
- Minimalistic approach to Spacemacs, contains only the core packages. Good starting point to make something completely new. This distribution should not be used for a new standalone Spacemacs installation except you have very good reasons to.
Spacemacs-bootstrap distribution
+distributions/spacemacs-bootstrap/README.org
This layer loads the necessary packages for spacemacs to start-up.
Features:
- Loads
evil
key bindings and macros for auto-evilification of maps - Loads
holy
andhybrid
modes - Loads the official Spacemacs theme
- Loads
use-package
which is used to load other packages more easily - Loads
hydra
which is used to create transient modes - Loads
which-key
which is used to show key bindings in other modes - Loads
async
which is used to run background processes - Loads
bind-map
andbind-key
which are used to realize various Spacemacs specific key binding commands
Tagging
Cscope
Helm Gtags
counsel-gtags
, helm-gtags
and ggtags
are clients for GNU Global. GNU
Global is a source code tagging system that allows querying symbol locations in
source code, such as definitions or references. Adding the gtags
layer enables
both of these modes.
Features:
- Select any tag in a project retrieved by gtags
- Resume previous helm-gtags session
- Jump to a location based on context
- Find definitions
- Find references
- Present tags in current function only
- Create a tag database
- Jump to definitions in file
- Show stack of visited locations
- Manually update tag database
- Jump to next location in context stack
- Jump to previous location in context stack
- Jump to a file in tag database
- Enables
eldoc
in modes that otherwise might not support it. - Enables
company complete
in modes that otherwise might not support it.
Themes
Colors
This layer colors your life by enhancing the existing coloration of identifiers as well as providing you with a more colorful process indicator.
Features:
- Colorize all identifiers (Christmas tree mode :-)) with mostly unique colors, and the ability to choose saturation and lightness with rainbow-identifiers.
- Colorize only identifiers recognized as variables with color-identifiers.
- Colorize strings representing colors with the color they represent as background with rainbow-mode.
- Display a Nyan cat progress bar in the mode-line with nyan-mode.
Nyan-mode
+themes/colors/local/nyan-mode/README.org
Nyan Mode - Turn your Emacs into Nyanmacs! :) The mode is an analog indicator of your position in the buffer. The Cat should go from left to right in your mode-line, as you move your point from 0% to 100%.
Features:
- Mind dumbing content included,
- Experimental animation (M-x nyan-start-animation, M-x nyan-stop-animation),
- Wavy rainbow (M-x set-variable <ret> nyan-wavy-trail <ret> t),
- Music, mplayer is needed (M-x nyan-start-music, M-x nyan-stop-music),
- Customizable properties.
Themes Megapack
+themes/themes-megapack/README.org
This layer installs around 100 themes for Emacs.
Features:
- Have access to all included themes in this theme gallery from Rob Merrell.
- Easily try a theme by invoking helm-themes with:
SPC T s
.
Theming
This layer allows for a simple way of modifying themes.
Features:
- Modify themes from your
.spacemacs
. - Tweak face attributes and other aspects of themes.
- Includes three additional layer variables for tweaking headings.
Tools
Ansible
This layer adds support for editing Ansible configuration files in Spacemacs.
Features:
- Syntax highlighting for Ansible-flavored YAML and Jinja2 templates.
- Auto-completion via
company-ansible
. - Integration of
ansible-vault
into emacs for automatic encryption/decryption of files.
Bm
BM provides visible, buffer local, bookmarks and the ability to jump forward and backward to the next bookmark.
Features:
- Auto remove bookmark after jump to it by
bm-next
orbm-previous
- Cycle through bookmarks in all open buffers in LIFO order
- Toggle bookmarks. Jump to next/previous bookmark.
- Setting bookmarks based on a regexp. (Useful when searching logfiles.)
- Mouse navigation.
- Annotate bookmarks.
- Different wrapping modes.
- Different bookmarks styles, line-only, fringe-only or both.
- Persistent bookmarks.
- List bookmarks (in all buffers) in a separate buffer.
- Cycle through bookmarks in all open buffers.
CFEngine
This layer adds support for CFEngine policies to Spacemacs.
Features:
- Syntax highlighting (CFEngine DSL, Mustache)
- On the fly syntax checking via
flycheck
integration. - Auto completion via
company
integration. - Execution of
cfengine3
SRC
blocks inorg-mode
viaob-cfengine3
package.
Chrome
This layer provides some integration with the Google Chrome browser.
Features:
- Edit text boxes with Emacs using edit-server
- Write markdown in Emacs and realtime show in chrome using flymd
- gmail message mode uses standard markdown key bindings
CMake
This layer adds support CMake scripts.
Features:
- Syntax highlighting
- Auto-completion
- Support for CMake configure/build (with limited support for other build systems) and
automatic generation of
compile_commands.json
(compile flags). - Run selected test using
Helm
interface viahelm-ctest
. - Extraction of compile parameters from
compile_commands.json
with cmake-ide
Command-log
This layer adds handy commands for demonstrating Spacemacs.
Features:
- Support for logging all entered keys and triggered commands in a designated buffer via command-log-mode.
- Experimental support for logging the last command directly in the mode line via keycast.
- Provides the best way to demonstrate the connection between keystrokes and commands in Emacs.
- Provides an easy way to create command logs for training classes.
DAP
Experimental integrated visual debugger using Debug Adapter Protocol.
Debug Adapter Protocol is a wire protocol for communication between client and Debug Server. It similar to the LSP but providers integration with debug server.
Features:
Fully featured IDE-like debugger providing:
- Launch/Attach
- Breakpoints
- Exceptions
- Pause & Continue
- Step In/Out/Over
- Callstacks
- Threads
- Multiple simultaneous debug sessions
- Evaluating statements
- Debug/Run configurations
- Debug REPL
Debug
This layer adds interactive debuggers for multiple languages using realgud.
Features:
- Modern rewrite of the Emacs GUD debugger family
- Visual interface including breakpoint and line indicators
- Advanced features like stack frame navigation and mouse support
- Extensible framework for adding your own external debuggers
Docker
This layer integrates basic container management into Spacemacs.
Features:
Eww
Ewww.. So ergonomic!
Features:
- Adds evil key bindings support to eww-mode (including eww-buffers/bookmarks/history-mode)
- Adds spacemacs functionality to eww-mode
- Adds ability to easily navigate eww buffers
EXWM
+window-management/exwm/README.org
Thanks to @ch11ng and his EXWM project we can now use Emacs as our window manager, that means that you can spawn a Browser Window, or your music player, or anything.
Features:
- Support for using Emacs as window manager
Fasd
This layer integrates the fasd command line tool into Spacemacs.
Features:
- Adds easy shortcuts to reference recent files and directories.
- Provides
fasd
with recent open file lists from Emacs. - Allows to filter
fasd
results withhelm
orivy
.
Finance
This layer integrates a full fledged accounting system into Spacemacs.
Features:
- Support for maintaining a double-entry accounting system run by text files via ledger-mode.
- Display of finance reports directly within Emacs.
- Integration of Emacs calculator mode for editing post amounts.
- Support for easy account reconciliation via
Ledger-Reconcile
. - Extended support for
evil
style editing with evil-ledger.
Geolocation
This layer offers location sensitive adjustments to Emacs.
Features:
-
Supports the following adjustments:
- Automatic switching between light (day) and dark (night) themes via theme-changer
- Local weather forecast via sunshine
- Integration with macOS's CoreLocation service via osx-location
- Manual location setting via variables in your dotfile
Imenu-list
This layer uses imenu-list to show the current buffer's index in a side bar.
This is similar to `SPC j i` but displayed in a persistent sidebar instead of a completion buffer.
Features:
- IDE like outline view of current buffer showing all significant symbols in one view
Import-js
This layer adds support for import-js
Features:
- Import Javascript/Typescript modules to buffer
- Import missing modules and remove unused one
- Go to module location
Kubernetes
This layer provides the kubernetes-el package, a magit-style interface to the Kubernetes command-line client.
Features:
- Live-updating lists of kubernetes resources
- Viewing and deleting pods, configmaps and secrets
- Switching contexts and namespaces.
- Showing logs and exec'ing into containers
- Describing pods
- Tramp support for pods
- Evil bindings
LSP
This layer adds support for basic language server protocol packages speaking language server protocol.
Different language servers may support the language server protocol to varying degrees
and they may also provide extensions; check the language server's website for
details.
M-x lsp-describe-session
in a LSP buffer to list capabilities of the server.
Features:
- Cross references (definitions, references, document symbol, workspace symbol search and others)
- Workspace-wide symbol rename
- Symbol highlighting
- Flycheck
- Completion with
LSP
- Signature help with
eldoc
- Symbol documentation in a child frame (
lsp-ui-doc
) - Navigation using
imenu
- Consistent core key bindings in LSP modes
- Code folding (
lsp-origami
)
Meson
This layer adds support Meson scripts.
Features:
- Support for meson build scripts through meson-mode.
- Syntax highlighting.
Nginx
This layer adds support for configuring nginx a powerful alternative for the Apache web server.
Features:
- Syntax highlighting of nginx configuration files via nginx-mode.
- Syntax-aware indentation
Node
This layer introduces packages that target Node.js. Currently this layer should not be used directly, as it will be used by other layers.
Features:
- Integration of packages necessary to execute node.js modules from other layers.
Pandoc
This layer adds support for Pandoc.
Pandoc is a universal document converter. It makes it easy to e.g. convert a Markdown file to org mode or vice versa. It can also export your text to PDF or DOCX.
Features:
- Mode independent document conversions via
global pandoc menu
Org-export
integration via ox-pandoc
Pass
This layer adds integration with pass, the unix password manager.
You must have pass
installed and available in your path for this layer to
function properly.
Features:
- Use Spacemacs as your password manager
- Support for OTP via (password-store-otp)
- Use password-store as an Emacs auth source (auth-source-pass) See its info page for more details on using it.
Prettier
Prodigy
This layer adds support for the prodigy package to manage external services from within Emacs, check the package's documentation for more details.
It is recommended to put your prodigy services in the dotspacemacs/user-config
part of your ~/.spacemacs
file.
Features:
- Managing of pre-declared services from within Emacs
- Showing of process output in special buffers
- Filtering of processes for tags or names
Puppet
This layer provides support for the Puppet DSL to Spacemacs.
Features:
- Syntax highlighting via puppet-mode
- Syntax-checking via puppet-lint
- Navigation commands to jump between blocks
- Applying the content of the current manifest directly from Emacs
Ranger
This layer brings Ranger features to spacemacs from the ranger
package.
To use this configuration layer, add it to your ~/.spacemacs
. You will need to
add ranger
to the existing dotspacemacs-configuration-layers
list in this
file.
To use ranger/deer by default set ranger-override-dired
to ranger/deer
like
shown in the example below (setting this via customize as explained by the
original ranger installation instructions will not work). To default with
preview enabled when entering ranger set ranger-show-preview
to t
. The following
example code shows how you can set both variables at once via the
dotspacemacs-configuration-layers
of your dotfiles as follows:
(setq-default dotspacemacs-configuration-layers
'(ranger :variables
ranger-override-dired 'ranger
ranger-show-preview t))
Features:
- use ranger to display dired with ranger like preview and stacked parent windows.
Rebox
This layer adds support for rebox2 package which is a minor-mode allowing to easily add ASCII text boxes to a buffer.
A nice video demonstration by the package author can be found here.
Features:
- Auto-wrap correctly in comments,
- Auto-fill correctly in comments,
- Boxes auto-adapt as text is inserted or deleted,
S-RET
to continue a comment on the next line,- Kill/yank within the box,
- Apparently works well with ancient
filladpt-mode
(see authors video).
Restclient
This layer provides a REPL-like interface for http requests.
Features:
- REPL for http requests via restclient
- Alternative
org
integration via ob-http
Saltstack
This layer provides syntax highlighting for Saltstack files.
Features:
- Syntax highlighting
- Display of salt documentation
Shell
This layer configures the various shells available in Emacs.
Features:
- Shell integration
- Running external terminal emulator in current/project directory
Sphinx
The layer adds support for the documentation generation system Sphinx
to
the restructuredtext
layer.
Features:
- Support for
Sphinx
project compilation - Support for opening
Sphinx
project target - Support for opening
Sphinx
config file
Systemd
This layer adds support for editing systemd
configuration files in Spacemacs.
Features:
- Syntax highlighting
- Auto completion
- Syntax checking via
systemd-analyze
Tern
This layer adds support for tern stand-alone code-analysis engine for JavaScript.
Features:
- TODO: list the feature of tern supported by tern package
Terraform
This layer provides basic support for Terraform .tf
files.
Features:
- Basic syntax highlighting via terraform-mode
- Auto formatting on save via
terraform fmt
- LSP support for terraform-lsp via
terraform-backend
Tide Layer
This layer installs tide package which allows communication with
standalone typescript server tsserver
for JavaScript/TypeScript development.
Features:
- First class support from
tsserver
just likevscode
: speed and accuracy - Linter
- Refactor
- Go to definition
- Find references
Tmux
This layer adds basic tmux
key bindings to Spacemacs.
Features:
- Calling of
tmux
navigation commands directly from Emacs via evil-tmux-navigator.
Transmission
+tools/transmission/README.org
This layer integrates a BitTorrent client into Spacemacs.
Features:
- Integration of Transmission into Emacs.
Vagrant
This layer adds support for working with Vagrant using vagrant.el and vagrant-tramp.
Features:
- Manage boxes (under the
SPC a t v
prefix) - Remote editing on Vagrant boxes via Tramp
Web-beautify
+tools/web-beautify/README.org
This layer adds support for web-beautify.
Features:
- Format buffer to be beautiful
Xclipboard
xclipboard
integration layer.
Features:
- adds copy support to the X-clipboard from the terminal.
- adds paste support to the X-clipboard from the terminal.
- cliphist package: integration with clipboard managers on Linux and macOS.
Vim
Evil-better-jumper
+vim/evil-better-jumper/README.org
This layer adds support for better-jumper. A configurable jump list implementation for Emacs that can be used to easily jump back to previous locations.
Features:
- jump back and forth
Evil-commentary
+vim/evil-commentary/README.org
This layer replaces evil-nerd-commenter with evil-commentary for those who prefer the behaviour of vim-commentary.
Features:
- Provides the original vim behaviour for commenting out lines via evil-commentary.
Evil-snipe
This layer adds various replacements for vim's default search functions.
Features:
- Alternative implementation of vim's default search operations.
- Replacement of evil-surround with a two-character search.
- Support for alternative scopes for default search operations.
- Support for alternative motions based on configurable regexps.
Vim-empty-lines
+vim/vim-empty-lines/README.org
This layer is a drop-in replacement for the vi-tilde-fringe
mode, for those
who desire behaviour closer to vim
's.
It has better compatibility with retina displays, as it uses a text overlay
using your font, rather than a pixel-art tilde. The empty line indicators are
overlaid in within the buffer as in vim
, and not in the fringe. The indicator
behaviour with trailing empty lines matches vim
's behaviour.
For details, see the vim-empty-lines-mode repository.
Features:
- Emulation of original vim behaviour.
- Brings you as close to vim as one can be without using vim itself.
Vinegar
This layer is a port of vim-vinegar for Emacs.
It is based on tpope's vinegar.vim, simplifying dired
with a limited number of details and exposing the -
command in all
buffers to enter dired.
Features:
- navigation up folders with
-
key - simplify dired buffer to show only file names
- better evil/vim bindings for navigation within dired buffer
- keep only one active dired buffer
- Use dired-k extension to show time / vcs related information in single bar
- right mouse click moves up directory if in blank space or shows context menu
Web services
Confluence
+web-services/confluence/README.org
This layer adds support for Atlassian Confluence.
Features:
- Creating/editing of Confluence pages
- Exporting of org buffers to Confluence
wiki
format
Eaf
This layer adds support for the Emacs Application Framework (EAF).
Features:
- Browse using a full-fledged browser within Emacs
- PDF viewer (with continuous scroll)
- Video player
- Image viewer
- See EAF documentation for many more features
Evernote
+web-services/evernote/README.org
This layer adds support for the famous Evernote note taking service to Spacemacs. It does so by grouping together various packages to work with Evernote.
Features:
+web-services/pocket/README.org
This layer adds Pocket support to Spacemacs via the package pocket-reader.
Features:
- Manage reading list: add, remove, delete, tag, view, favorite, etc.
- Open links in Emacs or external browser
- Sort views by date, title, domain, tags, favorite, etc.
- Search items by keywords, tags, favorite status, unread/archived status, etc.
Search Engine
+web-services/search-engine/README.org
This layer adds support for the Search Engine package.
Features:
- Browser search integration
+web-services/twitter/README.org
This layer adds Twitter support to Spacemacs via the package twittering-mode.
Features:
-
Activities on Twitter
-
Viewing various timelines
- Home timeline
- Replies
- User's timeline
- Public timeline
- Favorites timeline
- Retweets timeline
- Merged timeline
- Timeline without tweets satisfying a condition
-
Posting tweets
- Direct message
- ReTweet
- Hash tag
- Signature
- Following and removing users
- Marking tweets as favorites
-
- HTTP Proxy support
- Secure connection via HTTPS (cURL, GNU Wget, OpenSSL or GnuTLS is required)
Wakatime
+web-services/wakatime/README.org
This layer adds support for Wakatime.
WakaTime was built to solve time tracking for programmers. Since we work inside a text editor, why should we have to start and stop a timer? WakaTime uses open-source text editor plugins to automatically track the time you spend programming so you never have to manually track it again!
P.S. wakati means time in Swahili
Features:
- Integration with Wakatime cloud based time tracking service