diff --git a/README.md b/README.md index 04c097efd..839d3a87e 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,8 @@ the start of this file. That will populate your `~/.emacs.d` directory, which is what transforms a regular Emacs into Spacemacs. *After* you have completed the [install process below](#install), it is also - recommended to add the [osx layer][] to your [dotfile][]. Install instructions are available in the [osx layer][] documentation. + recommended to add the [osx layer][] to your [dotfile][]. Install instructions + are available in the [osx layer][] documentation. Note that the `emacs-mac-port` server behaves differently than the regular Emacs server which in particular **DOES NOT** allow multi-tty if you start GUI i.e. diff --git a/layers/+config-files/ansible/README.org b/layers/+config-files/ansible/README.org index 7f189c631..433daa0c1 100644 --- a/layers/+config-files/ansible/README.org +++ b/layers/+config-files/ansible/README.org @@ -12,11 +12,9 @@ This layer adds support for Ansible-flavored YAML buffers. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(ansible)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ansible= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+config-files/dockerfile/README.org b/layers/+config-files/dockerfile/README.org index b92433c63..3ce1fa087 100644 --- a/layers/+config-files/dockerfile/README.org +++ b/layers/+config-files/dockerfile/README.org @@ -12,11 +12,9 @@ This layer provides syntax highlighting and build functionality for Docker files. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(dockerfile)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =dockerfile= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+config-files/puppet/README.org b/layers/+config-files/puppet/README.org index fc46f239d..318b82c83 100644 --- a/layers/+config-files/puppet/README.org +++ b/layers/+config-files/puppet/README.org @@ -12,11 +12,9 @@ This layer aims at providing support for the Puppet DSL using [[https://github.com/lunaryorn/puppet-mode][puppet-mode]]. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(puppet)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =puppet= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings The following key bindings are available in Puppet Mode: diff --git a/layers/+config-files/salt/README.org b/layers/+config-files/salt/README.org index 307634df9..4e52fed82 100644 --- a/layers/+config-files/salt/README.org +++ b/layers/+config-files/salt/README.org @@ -12,11 +12,9 @@ This layer provides syntax highlighting for Saltstack files. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(salt)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =Saltstack= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+config-files/terraform/README.org b/layers/+config-files/terraform/README.org index 63d0710d6..492d24a37 100644 --- a/layers/+config-files/terraform/README.org +++ b/layers/+config-files/terraform/README.org @@ -13,8 +13,6 @@ This layer provides syntax support for Terraform `.tf` files using [terraform-mode](https://github.com/syohex/emacs-terraform-mode). * Install -To use this layer add it to your `~/.spacemacs` - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(terraform)') -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =terraform= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+email/gnus/README.org b/layers/+email/gnus/README.org index cbb455942..1c05bdf8f 100644 --- a/layers/+email/gnus/README.org +++ b/layers/+email/gnus/README.org @@ -1,4 +1,4 @@ -#+TITLE: Gnus contribution layer for Spacemacs +#+TITLE: Gnus layer #+HTML_HEAD_EXTRA: [[file:img/gnus.gif]] @@ -12,12 +12,9 @@ - [[Keybindings][Keybindings]] * Install - -To use this contribution layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(gnus)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =gnus= to the existing =dotspacemacs-configuration-layers= list in this +file. * Basic Concepts diff --git a/layers/+email/mu4e/README.org b/layers/+email/mu4e/README.org index f77a16a59..cdb944313 100644 --- a/layers/+email/mu4e/README.org +++ b/layers/+email/mu4e/README.org @@ -2,14 +2,14 @@ #+HTML_HEAD_EXTRA: * Table of Contents :TOC_4_org:noexport: - - [[Installation][Installation]] + - [[Install][Install]] - [[Commands][Commands]] - [[Configuration][Configuration]] - [[Multiple Accounts][Multiple Accounts]] - [[Example configuration][Example configuration]] - [[See also][See also]] -* Installation +* Install In order to use this layer you must install mu and mu4e separately. Typically mu4e will be bundled with mu (this is the case on many Linux distributions). @@ -22,6 +22,9 @@ the layer variable =mu4e-installation-path=, for example: mu4e-installation-path "/usr/share/emacs/site-lisp"))) #+end_src +Then add this layer to your =~/.spacemacs=. You will need to add =Gnus= to the +existing =mu4e= list in this file. + * Commands | Keybinding | Command | diff --git a/layers/+frameworks/django/README.org b/layers/+frameworks/django/README.org index a8c83e06a..c4cfa624b 100644 --- a/layers/+frameworks/django/README.org +++ b/layers/+frameworks/django/README.org @@ -1,4 +1,4 @@ -#+TITLE: Python layer +#+TITLE: Django layer #+HTML_HEAD_EXTRA: [[file:img/django.png]] @@ -18,11 +18,9 @@ This layer adds support for the Python [[https://www.djangoproject.com/][Django]] framework via [[https://github.com/davidmiller/pony-mode][pony-mode]]. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(django)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =django= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings Django related key bindings uses [[https://github.com/davidmiller/pony-mode][pony-mode]] and are behind the prefix ~SPC m j~. diff --git a/layers/+frameworks/react/README.org b/layers/+frameworks/react/README.org index 2a26ec6f5..bcccbdcf3 100644 --- a/layers/+frameworks/react/README.org +++ b/layers/+frameworks/react/README.org @@ -1,4 +1,4 @@ -#+TITLE: React contribution layer for Spacemacs +#+TITLE: React layer #+HTML_HEAD_EXTRA: [[file:img/react.png]] @@ -31,12 +31,9 @@ It will automatically recognize =.jsx= and =.react.js= files - js-doc * Install - -To use this contribution add it to your =~/.spacemacs= - -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(react)) -#+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =react= to the existing =dotspacemacs-configuration-layers= list in this +file. You will also need to install =tern= to use the auto-completion and documentation features: diff --git a/layers/+frameworks/ruby-on-rails/README.org b/layers/+frameworks/ruby-on-rails/README.org index 9d51ee8f5..3b4e625ce 100644 --- a/layers/+frameworks/ruby-on-rails/README.org +++ b/layers/+frameworks/ruby-on-rails/README.org @@ -16,11 +16,9 @@ This layer aims at providing support for the Ruby on Rails framework. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(ruby-on-rails)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ruby-on-rails= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings ** Code Navigation diff --git a/layers/+fun/emoji/README.org b/layers/+fun/emoji/README.org index ac3bf3e96..438393dc9 100644 --- a/layers/+fun/emoji/README.org +++ b/layers/+fun/emoji/README.org @@ -20,11 +20,9 @@ This layer adds support for Emoji emoticons from [[http://www.emoji-cheat-sheet. - Completion of Emojis using [[https://github.com/dunn/company-emoji][company-emoji]] * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(emoji)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =emoji= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+fun/games/README.org b/layers/+fun/games/README.org index b89f1e8ab..ec7ab27c3 100644 --- a/layers/+fun/games/README.org +++ b/layers/+fun/games/README.org @@ -20,11 +20,9 @@ The games available now are: - Tetris * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(games)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =games= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings To run a game: diff --git a/layers/+fun/selectric/README.org b/layers/+fun/selectric/README.org index 44920e4c0..dff8d7095 100644 --- a/layers/+fun/selectric/README.org +++ b/layers/+fun/selectric/README.org @@ -14,11 +14,9 @@ loud, clicky mechanical keyboard is not at hand, yet, you'd still wish to enjoy the sound. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(selectric)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =selectric= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+fun/xkcd/README.org b/layers/+fun/xkcd/README.org index 78be147d6..01307cc28 100644 --- a/layers/+fun/xkcd/README.org +++ b/layers/+fun/xkcd/README.org @@ -20,11 +20,9 @@ Features: - Cache the comics in =.cache/xkcd= * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(xkcd)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =xkcd= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings ** Tell me how to spawn the xkcd greatness!! diff --git a/layers/+irc/erc/README.org b/layers/+irc/erc/README.org index 5c3993519..037ab618c 100644 --- a/layers/+irc/erc/README.org +++ b/layers/+irc/erc/README.org @@ -32,11 +32,9 @@ Layer for [[http://www.emacswiki.org/emacs/ERC][ERC IRC chat]]. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(erc)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =erc= to the existing =dotspacemacs-configuration-layers= list in this +file. ** OS X It's recommended to install the [[https://github.com/alloy/terminal-notifier][terminal-notifier gem]] so that you get diff --git a/layers/+irc/rcirc/README.org b/layers/+irc/rcirc/README.org index 5d202d21f..c2e35fc8f 100644 --- a/layers/+irc/rcirc/README.org +++ b/layers/+irc/rcirc/README.org @@ -35,11 +35,9 @@ and ZNC. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(rcirc)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =rcirc= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Configuration There are several ways to configure rcirc supported by the layer: diff --git a/layers/+keyboard-layouts/bepo/README.org b/layers/+keyboard-layouts/bepo/README.org index f47555ed6..ffe618599 100644 --- a/layers/+keyboard-layouts/bepo/README.org +++ b/layers/+keyboard-layouts/bepo/README.org @@ -1,4 +1,4 @@ -#+TITLE: Bepo layer +#+TITLE: Bépo layer #+HTML_HEAD_EXTRA: #+CAPTION: logo @@ -25,11 +25,9 @@ try to correct the bugs introduced by these changes in other modes/packages. [[file:img/keymap.png]] * Install -To use this contribution add it to your =~/.spacemacs= - -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(bepo)) -#+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =bepo= to the existing =dotspacemacs-configuration-layers= list in this +file. It is possible to customize the layer via some variables. diff --git a/layers/+lang/agda/README.org b/layers/+lang/agda/README.org index 96af38676..faff1891e 100644 --- a/layers/+lang/agda/README.org +++ b/layers/+lang/agda/README.org @@ -20,11 +20,9 @@ This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(agda)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =agda= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Agda Quick instructions to install Agda assuming you have cabal installed: diff --git a/layers/+lang/asciidoc/README.org b/layers/+lang/asciidoc/README.org index 85e74bb76..596cb7e01 100644 --- a/layers/+lang/asciidoc/README.org +++ b/layers/+lang/asciidoc/README.org @@ -17,11 +17,9 @@ This layer adds [[https://asciidoctor.org][AsciiDoc]] markup language support to - `.adoc` files are associated with `adoc-mode` by default * Install -To use this contribution add it to your `~/.spacemacs` - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(asciidoc)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =asciidoc= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings ** Element insertion diff --git a/layers/+lang/autohotkey/README.org b/layers/+lang/autohotkey/README.org index eaee1d7ee..a448f4828 100644 --- a/layers/+lang/autohotkey/README.org +++ b/layers/+lang/autohotkey/README.org @@ -29,12 +29,9 @@ Contributed and maintained by [[https://www.github.com/ralesi][Rich Alesi]]. - Correct Indentation and Commenting * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(autohotkey)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =autohotkey= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/c-c++/README.org b/layers/+lang/c-c++/README.org index 38e86da97..508f76564 100644 --- a/layers/+lang/c-c++/README.org +++ b/layers/+lang/c-c++/README.org @@ -31,11 +31,9 @@ scripts. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(c-c++)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =c-c++= to the existing =dotspacemacs-configuration-layers= list in this +file. *Note:* [[https://github.com/tuhdo/semantic-refactor][semantic-refactor]] is only available for Emacs 24.4+ diff --git a/layers/+lang/clojure/README.org b/layers/+lang/clojure/README.org index 7f15427e8..69eb7d718 100644 --- a/layers/+lang/clojure/README.org +++ b/layers/+lang/clojure/README.org @@ -31,24 +31,19 @@ - [[test-report-mode][test-report-mode]] * Description - This layer adds support for [[http://clojure.org][Clojure]] language using [[https://github.com/clojure-emacs/cider][CIDER]]. * Features - - REPL via [[https://github.com/clojure-emacs/cider][CIDER]] - Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]] - Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]] - Aligning of code forms via [[https://github.com/gstamp/align-cljlet][align-cljlet]] * Install - ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(clojure)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =clojure= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Pretty Symbols Pretty symbols for anonymous functions, set literals and partial, like =(λ [a] @@ -68,7 +63,6 @@ Or set this variable when loading the configuration layer: #+END_SRC ** CIDER and clj-refactor - *** Quick Start with boot - Install =boot= (see https://github.com/boot-clj/boot#install) - Create a file =~/.boot/profile.boot= with the following content: diff --git a/layers/+lang/common-lisp/README.org b/layers/+lang/common-lisp/README.org index e47887879..702905ae1 100644 --- a/layers/+lang/common-lisp/README.org +++ b/layers/+lang/common-lisp/README.org @@ -25,11 +25,9 @@ you uninstall it before proceeding. You should clean up any config files tied to slime that are left behind as well. Linux users can just purge the slime package if it was a distribution install. -To use this contribution, add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(common-lisp)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =common-lisp= to the existing =dotspacemacs-configuration-layers= list in this +file. This layer defaults to using [[http://www.sbcl.org/][sbcl]]. If you want to use a different implementation of Common Lisp, you can specify it in your =~/.spacemacs= diff --git a/layers/+lang/csharp/README.org b/layers/+lang/csharp/README.org index 01c005817..7aa8af36c 100644 --- a/layers/+lang/csharp/README.org +++ b/layers/+lang/csharp/README.org @@ -23,29 +23,21 @@ - [[Code manipulation][Code manipulation]] * Description - This layer adds experimental support for C# language using [[https://github.com/OmniSharp/omnisharp-emacs][OmniSharp]]. * Packages Included - - [[https://github.com/OmniSharp/omnisharp-emacs][OmniSharp-emacs]] * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(csharp)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =csharp= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Prerequisites - *** ASP.NET 5 - Follow the instructions for your platform [[https://github.com/aspnet/home#getting-started][here]]. *** curl - You'll need [[http://curl.haxx.se/][curl]] to be able to use the Omnisharp package. Use your favorite package manager to install it (on Windows you can use [[https://chocolatey.org/][chocolatey]]). @@ -58,7 +50,6 @@ or set the variable =omnisharp--curl-executable-path= in your dotfile function #+END_SRC *** Omnisharp server - You have to compile the OmniSharp server following the instructions which can be found [[https://github.com/OmniSharp/omnisharp-server][here]]. @@ -75,7 +66,6 @@ OmniSharp should now automatically load and start a server when you open a =.cs= file. * Caveats - - It's currently not possible to create a C# solution outside of an IDE such as [[http://www.monodevelop.com/][MonoDevelop]], it's therefore recommended that you install it to create your solutions. @@ -83,8 +73,6 @@ OmniSharp should now automatically load and start a server when you open a - Debugging is possible using [[https://github.com/mono/sdb][SDB]]. * Key Bindings - - ** Compilation | Key Binding | Description | diff --git a/layers/+lang/d/README.org b/layers/+lang/d/README.org index 2558fa9d6..9072ce780 100644 --- a/layers/+lang/d/README.org +++ b/layers/+lang/d/README.org @@ -12,8 +12,6 @@ This simple layer adds support for the [[http://dlang.org/][D language]]. It adds =d-mode= as well as integrating it with =auto-completion= and =syntax-checking=. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(d)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =d= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+lang/elixir/README.org b/layers/+lang/elixir/README.org index 654f3893b..2f9c8e4b1 100644 --- a/layers/+lang/elixir/README.org +++ b/layers/+lang/elixir/README.org @@ -35,12 +35,9 @@ features like: - Integration with [[http://company-mode.github.io/][company-mode]] * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(elixir)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =elixir= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+lang/elm/README.org b/layers/+lang/elm/README.org index 5fd7f8116..67d0457b1 100644 --- a/layers/+lang/elm/README.org +++ b/layers/+lang/elm/README.org @@ -6,11 +6,11 @@ * Table of Contents :TOC_4_org:noexport: - [[Description][Description]] - [[Install][Install]] + - [[Layer][Layer]] - [[Elm Platform][Elm Platform]] - [[OS X and Windows installers][OS X and Windows installers]] - [[Universal installer using npm][Universal installer using npm]] - [[Source code][Source code]] - - [[elm-mode][elm-mode]] - [[elm-oracle][elm-oracle]] - [[Basic usage tips][Basic usage tips]] - [[Compilation][Compilation]] @@ -38,6 +38,11 @@ It relies on [[https://github.com/jcollard/elm-mode][elm-mode]] and [[https://gi - Integration with elm-package * Install +** Layer +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =elm= to the existing =dotspacemacs-configuration-layers= list in this +file. + ** Elm Platform The ~elm-platform~ is a bundle of tools, including the ~elm-compiler~, ~elm-make~, ~elm-reactor~, ~elm-repl~ and ~elm-package~. @@ -65,13 +70,6 @@ run, see this issue [[https://github.com/kevva/elm-bin/issues/28][https://github To build from source, see instructions here: [[https://github.com/elm-lang/elm-platform][https://github.com/elm-lang/elm-platform]] -** elm-mode -To use this contribution, add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(elm)) -#+END_SRC - ** elm-oracle ~elm-oracle~ can be used to show type signatures and docs for tokens under the cursor and provide support for auto-completion, but it is not part of the standard @@ -117,7 +115,6 @@ can be controlled by passing in these variables in your =~/.spacemacs=: #+END_SRC * Key bindings - ** elm-make | Key Binding | Description | diff --git a/layers/+lang/emacs-lisp/README.org b/layers/+lang/emacs-lisp/README.org index f00044a91..8dfd9ec4c 100644 --- a/layers/+lang/emacs-lisp/README.org +++ b/layers/+lang/emacs-lisp/README.org @@ -17,11 +17,9 @@ This layer gathers all the configuration related to emacs-lisp. This should always be in your dotfile, it is not recommended to uninstall it. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(emacs-lisp)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =emacs-lisp= to the existing =dotspacemacs-configuration-layers= list in this +file. * Auto-compile This layer adds the [[https://github.com/tarsius/auto-compile][auto-compile]] package to automatically keep the byte-compiled diff --git a/layers/+lang/erlang/README.org b/layers/+lang/erlang/README.org index 44b9bbb78..1a25a5933 100644 --- a/layers/+lang/erlang/README.org +++ b/layers/+lang/erlang/README.org @@ -13,9 +13,6 @@ Very basic layer for Erlang with support for basic =syntax-checking= and =auto-completion= with the corresponding layers. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(erlang)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =erlang= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+lang/ess/README.org b/layers/+lang/ess/README.org index 593f751f0..dbcb64b7e 100644 --- a/layers/+lang/ess/README.org +++ b/layers/+lang/ess/README.org @@ -1,4 +1,4 @@ -#+TITLE: R (ESS) layer +#+TITLE: ESS (R) layer #+HTML_HEAD_EXTRA: [[file:img/r.jpg]] @@ -11,11 +11,9 @@ - [[Options][Options]] * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(ess)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ess= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/fsharp/README.org b/layers/+lang/fsharp/README.org index f06d4a3fd..7e75f07a0 100644 --- a/layers/+lang/fsharp/README.org +++ b/layers/+lang/fsharp/README.org @@ -19,12 +19,9 @@ This layer adds support for F# language using [[https://github.com/fsharp/fsharp - [[https://github.com/fsharp/fsharpbinding][fsharp-mode]] * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(fsharp)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =fsharp= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/go/README.org b/layers/+lang/go/README.org index d96e00655..e634ffe55 100644 --- a/layers/+lang/go/README.org +++ b/layers/+lang/go/README.org @@ -42,11 +42,9 @@ For best results, make sure that the =auto-completion= and =syntax-checking= layers are enabled as well. ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(go)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =go= to the existing =dotspacemacs-configuration-layers= list in this +file. * Configuration ** Formatting diff --git a/layers/+lang/haskell/README.org b/layers/+lang/haskell/README.org index a0fd50bf8..5028f6b7a 100644 --- a/layers/+lang/haskell/README.org +++ b/layers/+lang/haskell/README.org @@ -43,11 +43,9 @@ This layer adds support for the [[https://www.haskell.org/][Haskell]] language. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(haskell)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =haskell= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Dependencies This layer requires some [[https://www.haskell.org/cabal/][cabal]] packages: diff --git a/layers/+lang/html/README.org b/layers/+lang/html/README.org index 5edd5ff0b..23cb12d3f 100644 --- a/layers/+lang/html/README.org +++ b/layers/+lang/html/README.org @@ -21,11 +21,9 @@ This layer adds support for editing HTML and CSS. - Tags navigation on key ~%~ using [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(html)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =html= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings ** Web mode diff --git a/layers/+lang/idris/README.org b/layers/+lang/idris/README.org index a41bda2d2..033f38bf3 100644 --- a/layers/+lang/idris/README.org +++ b/layers/+lang/idris/README.org @@ -22,11 +22,9 @@ This layer adds support for the [[http://www.idris-lang.org/][Idris]] language. * Install ** Layer -To use this layer, add it to your =~/.spacemacs= - -#+BEGIN_SRC elisp -(setq-default dotspacemacs-configuration-layers '(idris)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =idris= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Idris diff --git a/layers/+lang/ipython-notebook/README.org b/layers/+lang/ipython-notebook/README.org index e8cb7c197..1f6056185 100644 --- a/layers/+lang/ipython-notebook/README.org +++ b/layers/+lang/ipython-notebook/README.org @@ -42,9 +42,9 @@ This is a WIP, feel free to collaborate. * Install ** Layer -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(ipython-notebook)) -#+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ipython-noteboolk= to the existing =dotspacemacs-configuration-layers= list +in this file. ** Dependencies Install IPython > 3 #+begin_src sh diff --git a/layers/+lang/java/README.org b/layers/+lang/java/README.org index 40e5233d7..235c3c042 100644 --- a/layers/+lang/java/README.org +++ b/layers/+lang/java/README.org @@ -27,11 +27,9 @@ This layer adds support for the Java language using the [[http://eclim.org][Ecli * Layer Installation ** Layer -Add this layer to your =~/.spacemacs=. - -#+BEGIN_SRC elisp -(setq-default dotspacemacs-configuration-layers '(java)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =java= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Eclim Eclim provides the ability to access Eclipse features such as code completion, diff --git a/layers/+lang/javascript/README.org b/layers/+lang/javascript/README.org index cfd99dce5..bdc393257 100644 --- a/layers/+lang/javascript/README.org +++ b/layers/+lang/javascript/README.org @@ -30,11 +30,9 @@ This layer adds support for the JavaScript language using [[https://github.com/m - Get the path to a JSON value with [[https://github.com/Sterlingg/json-snatcher][json-snatcher]] * Install - -To use this contribution add it to your =~/.spacemacs= -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(javascript)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =javascript= to the existing =dotspacemacs-configuration-layers= list in this +file. You will also need to install =tern= to use the auto-completion and documentation features: diff --git a/layers/+lang/latex/README.org b/layers/+lang/latex/README.org index 1342b312f..b8329d73a 100644 --- a/layers/+lang/latex/README.org +++ b/layers/+lang/latex/README.org @@ -28,11 +28,9 @@ This layer adds support for LaTeX files with [[https://savannah.gnu.org/projects * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(latex)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =latex= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Auto-completion Add the layer =auto-completion= to the variable diff --git a/layers/+lang/lua/README.org b/layers/+lang/lua/README.org index 66305233d..2da9031e4 100644 --- a/layers/+lang/lua/README.org +++ b/layers/+lang/lua/README.org @@ -19,12 +19,9 @@ This layer adds support for editing Lua. - Sending code to a lua REPL * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(lua)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =lua= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/markdown/README.org b/layers/+lang/markdown/README.org index f157ddf51..39183ea71 100644 --- a/layers/+lang/markdown/README.org +++ b/layers/+lang/markdown/README.org @@ -31,12 +31,9 @@ This layer adds markdown support to Spacemacs. using the =emoji= layer or having a proper font) :clap: * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(markdown)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =markdown= to the existing =dotspacemacs-configuration-layers= list in this +file. * Usage diff --git a/layers/+lang/nim/README.org b/layers/+lang/nim/README.org index b733b11e2..1addbeb28 100644 --- a/layers/+lang/nim/README.org +++ b/layers/+lang/nim/README.org @@ -15,14 +15,10 @@ This layer adds support for nim (nimrod). * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(nim)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =nim= to the existing =dotspacemacs-configuration-layers= list in this +file. * Working with Nim diff --git a/layers/+lang/ocaml/README.org b/layers/+lang/ocaml/README.org index 776567e3a..d2facc10a 100644 --- a/layers/+lang/ocaml/README.org +++ b/layers/+lang/ocaml/README.org @@ -27,11 +27,9 @@ This is a very basic layer for editing ocaml files. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(ocaml)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ocaml= to the existing =dotspacemacs-configuration-layers= list in this +file. ** OPAM packages This layer requires some [[http://opam.ocaml.org][opam]] packages: diff --git a/layers/+lang/octave/README.org b/layers/+lang/octave/README.org index 212951033..fb6f9d8f2 100644 --- a/layers/+lang/octave/README.org +++ b/layers/+lang/octave/README.org @@ -19,11 +19,9 @@ Make sure that [[https://gnu.org/software/octave/][GNU Octave]] is installed and in your PATH. For information about setting up $PATH, check out the corresponding section in the FAQ (=SPC h SPC $PATH RET=). -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(octave)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =octave= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings ** Inferior REPL process diff --git a/layers/+lang/php/README.org b/layers/+lang/php/README.org index d4aa988dd..1e9e13338 100644 --- a/layers/+lang/php/README.org +++ b/layers/+lang/php/README.org @@ -23,12 +23,9 @@ The =gtags= layer is recommended to benefit from better =eldoc= and =helm-gtags=. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(php)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =php= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+lang/purescript/README.org b/layers/+lang/purescript/README.org index 6a129b64f..6a5a1c735 100644 --- a/layers/+lang/purescript/README.org +++ b/layers/+lang/purescript/README.org @@ -21,12 +21,9 @@ thanks to the following packages: - [[https://github.com/epost/psc-ide-emacs][psc-ide-emacs]] * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(purescript)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =purescript= to the existing =dotspacemacs-configuration-layers= list in this +file. If you want to get autocompletions and type information you have to install [[https://github.com/kRITZCREEK/psc-ide][psc-ide]]. diff --git a/layers/+lang/python/README.org b/layers/+lang/python/README.org index 509deed76..d62294dc3 100644 --- a/layers/+lang/python/README.org +++ b/layers/+lang/python/README.org @@ -39,11 +39,9 @@ This layer adds support for the Python language. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(python)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =python= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Test runner Both =nose= and =pytest= are supported. By default =nose= is used. diff --git a/layers/+lang/racket/README.org b/layers/+lang/racket/README.org index 5901a78ab..9f3385e1c 100644 --- a/layers/+lang/racket/README.org +++ b/layers/+lang/racket/README.org @@ -18,12 +18,9 @@ Adds support for the [[http://racket-lang.org/][Racket]] programming language. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(racket)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =racket= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/ruby/README.org b/layers/+lang/ruby/README.org index 93fbaca81..093c97037 100644 --- a/layers/+lang/ruby/README.org +++ b/layers/+lang/ruby/README.org @@ -24,11 +24,9 @@ This layer provides support for the Ruby language with the following feature: - interactive REPL and code navigation (robe) * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(ruby)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ruby= to the existing =dotspacemacs-configuration-layers= list in this +file. This layer supports two different Ruby modes: Emacs' built-in Ruby Mode and [[https://github.com/zenspider/enhanced-ruby-mode][enh-ruby-mode]]. By default the built-in Ruby mode is enabled. To switch to the diff --git a/layers/+lang/rust/README.org b/layers/+lang/rust/README.org index 051802a7e..c7279c65b 100644 --- a/layers/+lang/rust/README.org +++ b/layers/+lang/rust/README.org @@ -19,11 +19,9 @@ though Racer needs some additional configurations as described on their page. * Install ** Layer -To use this layer, add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(rust)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =rust= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Cargo [[http://doc.crates.io/index.html][Cargo]] is a project management command line tool for Rust. Installation diff --git a/layers/+lang/scala/README.org b/layers/+lang/scala/README.org index 02b539079..2b136b053 100644 --- a/layers/+lang/scala/README.org +++ b/layers/+lang/scala/README.org @@ -32,12 +32,9 @@ This layer adds support for the Scala language using the excellent [[https://git client/server. * Layer Installation - -Add this contribution to your =~/.spacemacs=. - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(scala)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =scala= to the existing =dotspacemacs-configuration-layers= list in this +file. * Ensime diff --git a/layers/+lang/scheme/README.org b/layers/+lang/scheme/README.org index 86b983fd7..ba746f585 100644 --- a/layers/+lang/scheme/README.org +++ b/layers/+lang/scheme/README.org @@ -18,15 +18,12 @@ A spacemacs contribution layer providing Scheme support via [[http://www.nongnu.org/geiser/][Geiser]]. * Install - The scheme layer currently supports: Chicken and Guile. Combined usage of racket-mode and geiser has not been tested. -To use this layer, simply add it to =~/.spacemacs=: - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(scheme)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =scheme= to the existing =dotspacemacs-configuration-layers= list in this +file. For full Chicken support, the following commands should be run: diff --git a/layers/+lang/shell-scripts/README.org b/layers/+lang/shell-scripts/README.org index fb9057b7e..07bdf1a6c 100644 --- a/layers/+lang/shell-scripts/README.org +++ b/layers/+lang/shell-scripts/README.org @@ -1,4 +1,4 @@ -#+TITLE: Shell Scripting layer +#+TITLE: Shell Scripts layer #+HTML_HEAD_EXTRA: [[file:img/fish.png]] @@ -18,12 +18,9 @@ Incuded packages for extensions: *Note:* For Windows scripting see the layer =windows-scripts= * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(shell-scripts)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =shell-scripts= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/sml/README.org b/layers/+lang/sml/README.org index 6e2166c77..56dc5c82a 100644 --- a/layers/+lang/sml/README.org +++ b/layers/+lang/sml/README.org @@ -15,12 +15,9 @@ Adds support for the [[http://www.smlnj.org][SML]] programming language. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC elisp -(setq-default dotspacemacs-configuration-layers '(sml)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =sml= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+lang/sql/README.org b/layers/+lang/sql/README.org index 1c77e1e4e..cedc5663c 100644 --- a/layers/+lang/sql/README.org +++ b/layers/+lang/sql/README.org @@ -18,12 +18,9 @@ This layer adds key bindings and configuration for =sql-mode=, which manages interactive SQL buffers and highlights a wide range of SQL dialects. * Install - -To use this contribution layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (set-default dotspacemacs-configuration-layers '(sql)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =sql= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+lang/swift/README.org b/layers/+lang/swift/README.org index 421e3d21e..241f79ca4 100644 --- a/layers/+lang/swift/README.org +++ b/layers/+lang/swift/README.org @@ -25,14 +25,17 @@ following features: ~syntax-checking~ layer) * Install -To be able to use this layer you should be able to run this from the -command line: +First check that you are able to run this from the command line: On OS X: #+BEGIN_SRC sh xcrun swift #+END_SRC +Then to use this configuration layer, add it to your =~/.spacemacs=. You will +need to add =swift= to the existing =dotspacemacs-configuration-layers= list in +this file. + * Usage information Unless configured by the user, the REPL will be invoked using the command ~xcrun swift~. diff --git a/layers/+lang/typescript/README.org b/layers/+lang/typescript/README.org index 97624655f..3dcc9a37b 100644 --- a/layers/+lang/typescript/README.org +++ b/layers/+lang/typescript/README.org @@ -22,14 +22,10 @@ This layer provides: - jump-to-definition * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(typescript)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =typescript= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Prerequisites diff --git a/layers/+lang/vimscript/README.org b/layers/+lang/vimscript/README.org index 1221b5707..85f0fd7ed 100644 --- a/layers/+lang/vimscript/README.org +++ b/layers/+lang/vimscript/README.org @@ -11,9 +11,6 @@ This layer adds syntax highlighting support for vim filetypes, in addition to the pentadactyl firefox extension. * Install - -To use this contribution layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(set-default dotspacemacs-configuration-layers '(vimscript)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =vimscript= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+lang/windows-scripts/README.org b/layers/+lang/windows-scripts/README.org index 240dc1f08..25dd277bd 100644 --- a/layers/+lang/windows-scripts/README.org +++ b/layers/+lang/windows-scripts/README.org @@ -19,11 +19,9 @@ Incuded packages for extensions: - =.bat=: [[http://www.emacswiki.org/emacs/dos.el][dos.el]] * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(windows-scripts)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =windows-scripts= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings ** Powershell diff --git a/layers/+lang/yaml/README.org b/layers/+lang/yaml/README.org index 1568e8abe..bdd45aea4 100644 --- a/layers/+lang/yaml/README.org +++ b/layers/+lang/yaml/README.org @@ -9,8 +9,6 @@ This layer provides syntax highlighting for YAML files. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(yaml)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =yaml= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+source-control/git/README.org b/layers/+source-control/git/README.org index ca167e684..e48d17348 100644 --- a/layers/+source-control/git/README.org +++ b/layers/+source-control/git/README.org @@ -41,11 +41,9 @@ New to Magit? Checkout the [[http://magit.vc/about.html][official intro]]. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(git)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =git= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Magit status fullscreen To display the =magit status= buffer in fullscreen set the variable diff --git a/layers/+source-control/github/README.org b/layers/+source-control/github/README.org index b9fa10b62..de0113d4b 100644 --- a/layers/+source-control/github/README.org +++ b/layers/+source-control/github/README.org @@ -26,14 +26,10 @@ This layers adds support for [[http://github.com][Github]]. - [[https://github.com/dgtized/github-clone.el][Github clone]] allows for easy cloning and forking of repositories. * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(github)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =github= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/+source-control/perforce/README.org b/layers/+source-control/perforce/README.org index b2c0bbf6a..2c01492b5 100644 --- a/layers/+source-control/perforce/README.org +++ b/layers/+source-control/perforce/README.org @@ -13,12 +13,9 @@ This layer adds support for [[http://www.perforce.com/][Perforce]] (p4). * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(perforce)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =perforce= to the existing =dotspacemacs-configuration-layers= list in this +file. You'll have to install the =p4== command line tool from the [[http://www.perforce.com/downloads][download page]]. diff --git a/layers/+source-control/version-control/README.org b/layers/+source-control/version-control/README.org index 9183a1ec0..55771a233 100644 --- a/layers/+source-control/version-control/README.org +++ b/layers/+source-control/version-control/README.org @@ -23,11 +23,9 @@ buffer hunks. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(version-control)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =version-control= to the existing =dotspacemacs-configuration-layers= list in this +file. * Configuration You can choose the package to facilitate the diff micro-state and show margins @@ -60,7 +58,6 @@ one over the other: | Stage hunks from buffer | | X | X | | Dired support | X | | | - * Key Bindings | Key Binding | Description | diff --git a/layers/+tools/command-log/README.org b/layers/+tools/command-log/README.org index 2e8b0217f..55e624587 100644 --- a/layers/+tools/command-log/README.org +++ b/layers/+tools/command-log/README.org @@ -12,11 +12,9 @@ keystrokes get logged into a designated buffer, along with the command bound to them. For more info check [[https://github.com/lewang/command-log-mode][command-log-mode]]. * Install -To use this contribution add it to your =~/.spacemacs= - -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(command-log)) -#+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =command-log= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/+tools/dash/README.org b/layers/+tools/dash/README.org index e9e457704..e3200d6b0 100644 --- a/layers/+tools/dash/README.org +++ b/layers/+tools/dash/README.org @@ -34,12 +34,9 @@ prefix argument C-u to edit the search string first. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(dash)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =dash= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Dash (OS X) @@ -48,7 +45,6 @@ You have to install [[http://kapeli.com/dash][dash]] on your machine. It is recommended to set the =HUD mode= in your Dash application preferences when using this layer. - ** Zeal (Linux & Windows) You have to install [[http://zealdocs.org/][zeal]] on your machine. diff --git a/layers/+tools/elfeed/README.org b/layers/+tools/elfeed/README.org index 3619774eb..c867d3147 100644 --- a/layers/+tools/elfeed/README.org +++ b/layers/+tools/elfeed/README.org @@ -1,10 +1,9 @@ -* Elfeed layer +#+TITLE: Elfeed layer #+HTML_HEAD_EXTRA: [[file:img/elfeed.png]] * Table of Contents :TOC_4_org:noexport: - - [[Elfeed layer][Elfeed layer]] - [[Description][Description]] - [[Install][Install]] - [[Layer][Layer]] @@ -24,11 +23,9 @@ feeds. It'll optionally enable supporting packages, such as =elfeed-web= and * Install ** Layer -To use this layer, add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(elfeed)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =elfeed= to the existing =dotspacemacs-configuration-layers= list in this +file. By default, =elfeed= stores its database under =~/.elfeed=. diff --git a/layers/+tools/evernote/README.org b/layers/+tools/evernote/README.org index 895d71706..a779c0586 100644 --- a/layers/+tools/evernote/README.org +++ b/layers/+tools/evernote/README.org @@ -23,11 +23,9 @@ layer provides key bindings for all of geeknote.el's exposed features. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(evernote)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =evernote= to the existing =dotspacemacs-configuration-layers= list in this +file. ** geeknote The command =geeknote= is expected to be present in your =$PATH=. To diff --git a/layers/+tools/fasd/README.org b/layers/+tools/fasd/README.org index 9c48f7f7e..59510b9bc 100644 --- a/layers/+tools/fasd/README.org +++ b/layers/+tools/fasd/README.org @@ -4,7 +4,7 @@ * Table of Contents :TOC_4_org:noexport: - [[Description][Description]] - [[Install][Install]] - - [[Layer][Layer]] + - [[Layer ][Layer ]] - [[fasd][fasd]] - [[Keybindings][Keybindings]] @@ -16,17 +16,12 @@ to quickly jump between locations in a POSIX shell. The integration is implemented in the package [[https://github.com/steckerhalter/emacs-fasd][emacs-fasd]]. * Install - -** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(fasd)) -#+END_SRC +** Layer +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =fasd= to the existing =dotspacemacs-configuration-layers= list in this +file. ** fasd - [[https://github.com/clvv/fasd][fasd]] must be installed on your system. The general installation instructions can be found in the repository [[https://github.com/clvv/fasd#install][README]] diff --git a/layers/+tools/pandoc/README.org b/layers/+tools/pandoc/README.org index f3d8bea2e..596643788 100644 --- a/layers/+tools/pandoc/README.org +++ b/layers/+tools/pandoc/README.org @@ -20,21 +20,15 @@ DOCX. This layer automatically install an org exporter using the [[https://github.com/kawabata/ox-pandoc][ox-pandoc]]. * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(pandoc)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =pandoc= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Pandoc - To use the mode please [[http://pandoc.org/installing.html][install]] pandoc first. * Usage - For a full list of possible conversions see the [[http://johnmacfarlane.net/pandoc][Pandoc documentation]]. An explanation of all the options offered by =pandoc-mode= can be found at the [[http://joostkremers.github.io/pandoc-mode][Pandoc-mode website]]. diff --git a/layers/+tools/ranger/README.org b/layers/+tools/ranger/README.org index 31eb311b8..b78c39990 100644 --- a/layers/+tools/ranger/README.org +++ b/layers/+tools/ranger/README.org @@ -14,11 +14,9 @@ This layer brings Ranger features to spacemacs from the =ranger= package. -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(ranger)) -#+END_SRC +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 default with preview enabled when entering ranger: #+BEGIN_SRC emacs-lisp @@ -31,7 +29,6 @@ To default with preview enabled when entering ranger: - use ranger to display dired with ranger like preview and stacked parent windows. * Configuration - Most parameters can be toggled on and off and stay within the current emacs session. Any settings that are desired on startup should be set below. diff --git a/layers/+tools/vagrant/README.org b/layers/+tools/vagrant/README.org index 1eaf6e8e3..faf49ccd0 100644 --- a/layers/+tools/vagrant/README.org +++ b/layers/+tools/vagrant/README.org @@ -22,25 +22,19 @@ This layer adds support for working with Vagrant using [[https://github.com/ottb - Remote editing on Vagrant boxes via Tramp * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(ruby vagrant)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =vagrant= to the existing =dotspacemacs-configuration-layers= list in this +file. *Note:* Since vagrant files are written in =ruby= it is recommended to install the =ruby= layer as well. ** Vagrant - Follow the [[http://docs.vagrantup.com/v2/installation/index.html][Installing Vagrant]] and [[http://docs.vagrantup.com/v2/getting-started/index.html][Getting Started]] guides in Vagrant's documentation. ** Testing - If you'd like to test this layer out in a simple way (for example to make sure you have Vagrant configured correctly) there is a [[file:Vagrantfile][Vagrantfile]] in this directory. diff --git a/layers/+tools/wakatime/README.org b/layers/+tools/wakatime/README.org index 17439b661..a0590131d 100644 --- a/layers/+tools/wakatime/README.org +++ b/layers/+tools/wakatime/README.org @@ -22,7 +22,6 @@ time you spend programming so you never have to manually track it again! P.S. wakati means time in Swahili * Install - ** Wakatime Program You can follow wakatime installation instructions here https://github.com/wakatime/wakatime-mode. @@ -38,14 +37,21 @@ sudo pip install wakatime #+END_SRC ** Layer -To use this contribution add it to your =~/.spacemacs= +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =wakatime= to the existing =dotspacemacs-configuration-layers= list in this +file. +Example: #+BEGIN_SRC emacs-lisp (setq-default dotspacemacs-configuration-layers - '((wakatime :variables - wakatime-api-key "your-api-key" - ;; use the actual wakatime path - wakatime-cli-path "/usr/bin/wakatime"))) + '( + ;; ... + (wakatime :variables + wakatime-api-key "your-api-key" + ;; use the actual wakatime path + wakatime-cli-path "/usr/bin/wakatime") + ;; ... + )) #+END_SRC ** API Keys diff --git a/layers/+tools/ycmd/README.org b/layers/+tools/ycmd/README.org index 60c653279..6aed3f9f5 100644 --- a/layers/+tools/ycmd/README.org +++ b/layers/+tools/ycmd/README.org @@ -15,27 +15,21 @@ This layer adds [[https://github.com/abingham/emacs-ycmd][emacs-ycmd]] support. * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(ycmd)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ycmd= to the existing =dotspacemacs-configuration-layers= list in this +file. ** YCMD - In order to use this layer you must have a local [[https://github.com/Valloric/ycmd#building][ycmd]] installation and must set the =ycmd-server-command= variable to reflect the path to that installation. See the [[https://github.com/abingham/emacs-ycmd][emacs-ycmd]] readme for more instructions on this. ** Other Requirements - This package requires the =auto-completion= layer in order to get actual completion. The =syntax-checking= layer is required for flycheck support. * Configuration - By default this layer only activates ycmd for =c++-mode=. If you want ycmd suppoert in other modes you might just want to add it for diff --git a/layers/+vim/evil-cleverparens/README.org b/layers/+vim/evil-cleverparens/README.org index 94b020e57..55c7e8b32 100644 --- a/layers/+vim/evil-cleverparens/README.org +++ b/layers/+vim/evil-cleverparens/README.org @@ -13,12 +13,9 @@ the repository for more details. All the layer does right now is to add a hook to load evil-cleverparens with emacs-lisp-mode. * Install - -To use this contribution add it to your =~/.spacemacs=. - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(evil-cleverparens)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =evil-cleverparens= to the existing =dotspacemacs-configuration-layers= list in this +file. Then enable it in your =user-config= function: diff --git a/layers/+vim/evil-commentary/README.org b/layers/+vim/evil-commentary/README.org index a67c1daa1..63c78c9dd 100644 --- a/layers/+vim/evil-commentary/README.org +++ b/layers/+vim/evil-commentary/README.org @@ -18,11 +18,9 @@ who prefer the behaviour of [[https://github.com/tpope/vim-commentary][vim-comme For more details see the [[https://github.com/linktohack/evil-commentary][evil-commentary]] repository. * Install -To use this contribution add it to your =~/.spacemacs=. - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(evil-commentary)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =evil-commentary= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings | Key Binding | Description | diff --git a/layers/+vim/evil-snipe/README.org b/layers/+vim/evil-snipe/README.org index 6614bf3f0..e7e643fac 100644 --- a/layers/+vim/evil-snipe/README.org +++ b/layers/+vim/evil-snipe/README.org @@ -26,17 +26,12 @@ search command, namely ~s~ / ~S~. buffer with two chars. * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(evil-snipe)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =evil-snipe= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Improved f and t search behavior - With evil-snipe you can define your own search scope for ~f~ and ~t~ searches which means that you won't have to jump to the correct line before searching with ~f~ / ~t~ / ~F~ / ~T~. And after you have found a match, you can just press @@ -51,7 +46,6 @@ layer variable =evil-snipe-enable-alternate-f-and-t-behaviors= to =t=: #+END_SRC ** Two-character search with s - With the ~s~/~S~ keys you can do a simple search like ~f~/~t~, but instead of searching for one character, you search for two. This makes the search a lot more precise than regular ~f~/~t~ searches. While you can search forward or @@ -60,7 +54,6 @@ don't require you to press enter and they are precise enough for many common purposes. ** More scopes - Evil-snipe also adds several scope options for searches (set =evil-snipe-scope= and =evil-snipe-repeat-scope= to one of these, the default value is =buffer=): @@ -78,7 +71,6 @@ remove this line from =evil-snipe/packages.el=: =(evil-snipe-replace-evil)= ** Symbol groups - With symbol groups you can let a character stand for a regex, for example a group of characters. By adding a pair of ='(CHAR REGEX)= to the list ='evil-snipe-symbol-groups= you can search for a regex very simply: diff --git a/layers/+vim/unimpaired/README.org b/layers/+vim/unimpaired/README.org index 3ceb0da85..b69eab034 100644 --- a/layers/+vim/unimpaired/README.org +++ b/layers/+vim/unimpaired/README.org @@ -6,7 +6,6 @@ - [[Key bindings][Key bindings]] * Description - This layer ports some of the functionality of [[https://github.com/tpope/vim-unimpaired][tpope's vim-unimpaired]]. This plugin provides several pairs of bracket maps using ~[~ to denote diff --git a/layers/+vim/vim-empty-lines/README.org b/layers/+vim/vim-empty-lines/README.org index 415e05eab..41c938678 100644 --- a/layers/+vim/vim-empty-lines/README.org +++ b/layers/+vim/vim-empty-lines/README.org @@ -18,9 +18,6 @@ behaviour with trailing empty lines matches =vim='s behaviour. For details, see the [[https://github.com/jmickelin/vim-empty-lines-mode][vim-empty-lines-mode]] repository. * Install - -To use this contribution add it to your =~/.spacemacs=. - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(vim-empty-lines)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =vim-empty-lines= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+vim/vim-powerline/README.org b/layers/+vim/vim-powerline/README.org index 263cadcc5..e64650ddd 100644 --- a/layers/+vim/vim-powerline/README.org +++ b/layers/+vim/vim-powerline/README.org @@ -9,9 +9,6 @@ A powerline theme modeled after the vim powerline theme. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(vim-powerline)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =vim-powerline= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/+vim/vinegar/README.org b/layers/+vim/vinegar/README.org index af870a1d7..935ab6bf9 100644 --- a/layers/+vim/vinegar/README.org +++ b/layers/+vim/vinegar/README.org @@ -8,7 +8,6 @@ - [[Key bindings][Key bindings]] * Description - This layer is a port contribution layer for vim-vinegar for emacs. A port of tpope's vinegar.vim @@ -17,7 +16,6 @@ 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 diff --git a/layers/+window-management/eyebrowse/README.org b/layers/+window-management/eyebrowse/README.org index 8eee912e2..501930fa5 100644 --- a/layers/+window-management/eyebrowse/README.org +++ b/layers/+window-management/eyebrowse/README.org @@ -1,4 +1,4 @@ -#+TITLE: Eyebrowse contribution layer for Spacemacs +#+TITLE: Eyebrowse layer #+HTML_HEAD_EXTRA: [[file:img/eyebrowse.gif]] [[file:img/i3wm.png]] @@ -32,11 +32,9 @@ It is also possible to give a label to a the current workspace by pressing * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(eyebrowse)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =eyebrowse= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Removing additional help Once you know the key bindings to navigate between the workspaces you diff --git a/layers/+window-management/spacemacs-layouts/README.org b/layers/+window-management/spacemacs-layouts/README.org index 3edaa6271..7e64b68e5 100644 --- a/layers/+window-management/spacemacs-layouts/README.org +++ b/layers/+window-management/spacemacs-layouts/README.org @@ -23,11 +23,11 @@ Layouts are window configurations that have buffer isolation between each other. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= +This layer is automatically included if you use the =spacemacs= distribution. -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(spacemacs-layouts)) -#+END_SRC +If you use =spacemacs-base= distribution then to use this configuration layer, +add it to your =~/.spacemacs=. You will need to add =spacemacs-layout= to the +existing =dotspacemacs-configuration-layers= list in this file. * Features diff --git a/layers/auto-completion/README.org b/layers/auto-completion/README.org index b8bb5f085..ef2a59d1a 100644 --- a/layers/auto-completion/README.org +++ b/layers/auto-completion/README.org @@ -32,11 +32,9 @@ Snippets are supported via [[https://github.com/capitaomorte/yasnippet][yasnippe This layer also configures =hippie-expand=. * Install -To use this configuration layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(auto-completion)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =auto-completion= to the existing =dotspacemacs-configuration-layers= list in this +file. * Configuration ** Key bindings diff --git a/layers/better-defaults/README.org b/layers/better-defaults/README.org index 28bdc1b67..01563767a 100644 --- a/layers/better-defaults/README.org +++ b/layers/better-defaults/README.org @@ -23,11 +23,9 @@ style. The commands defined in this layer are taken from various sources like [[https://github.com/bbatsov/prelude][Prelude]]. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(better-defaults)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =better-defaults= to the existing =dotspacemacs-configuration-layers= list in this +file. * Functions ** =spacemacs/smart-move-beginning-of-line= diff --git a/layers/chinese/README.org b/layers/chinese/README.org index 7f71707dd..a6f29db21 100644 --- a/layers/chinese/README.org +++ b/layers/chinese/README.org @@ -32,11 +32,9 @@ This Layer adds Chinese related packages: * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(chinese)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =chinese= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Configuration *** Configure the Default Input Method(配置默认中文输入法) diff --git a/layers/chrome/README.org b/layers/chrome/README.org index e73157575..283517d56 100644 --- a/layers/chrome/README.org +++ b/layers/chrome/README.org @@ -19,12 +19,9 @@ This layer provides some integration with the Google Chrome browser. * Install ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(chrome)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =chrome= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Chrome extension [[http://melpa.org/#/edit-server][edit-server]] is a server that responds to edit requests sent Chrome via the diff --git a/layers/colors/README.org b/layers/colors/README.org index 784a1c5b1..3fb51ada5 100644 --- a/layers/colors/README.org +++ b/layers/colors/README.org @@ -23,12 +23,9 @@ This layer colors your life with: - [[https://github.com/syl20bnr/nyan-mode][nyan mode]] display a Nyan cat progress bar in the mode-line. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(colors)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =colors= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Enable rainbow-identifiers diff --git a/layers/cscope/README.org b/layers/cscope/README.org index a0cddfec6..c012a526b 100644 --- a/layers/cscope/README.org +++ b/layers/cscope/README.org @@ -21,11 +21,9 @@ This layer provides bindings for using [[http://cscope.sourceforge.net][Cscope]] * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(cscope)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =cscope= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Cscope Install =Cscope= through your package manager, or download it from the diff --git a/layers/deft/README.org b/layers/deft/README.org index 7e58c6958..abd473df8 100644 --- a/layers/deft/README.org +++ b/layers/deft/README.org @@ -27,14 +27,10 @@ configuration by adding the following in your config file: Just add or substitute your preferred extension. * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(deft)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =deft= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Configuration By default deft tries to put notes in =~/.deft= but you can change diff --git a/layers/finance/README.org b/layers/finance/README.org index ee729ad80..1d67ac194 100644 --- a/layers/finance/README.org +++ b/layers/finance/README.org @@ -18,14 +18,10 @@ This layer adds finance related packages: [[file:img/ledger.png]] * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(finance)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =finance= to the existing =dotspacemacs-configuration-layers= list in this +file. * Configuration diff --git a/layers/floobits/README.org b/layers/floobits/README.org index 90026b7d7..cb8f16a49 100644 --- a/layers/floobits/README.org +++ b/layers/floobits/README.org @@ -14,11 +14,9 @@ This layer adds support for peer programming tool [[https://github.com/Floobits/ * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(floobits)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =floobits= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/geolocation/README.org b/layers/geolocation/README.org index 93d7d49be..d6cbfe9e7 100644 --- a/layers/geolocation/README.org +++ b/layers/geolocation/README.org @@ -25,11 +25,9 @@ CoreLocation services. - [[https://github.com/purcell/osx-location][osx-location]] * Install -To enable this contribution layer, add it to your =~/.spacemacs=~ like this: - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(geolocation)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =geolocation= to the existing =dotspacemacs-configuration-layers= list in this +file. All services are disable by default. To enable all, or some of them, add instead something like this: diff --git a/layers/gtags/README.org b/layers/gtags/README.org index 960394742..cac7d8016 100644 --- a/layers/gtags/README.org +++ b/layers/gtags/README.org @@ -11,7 +11,6 @@ - [[Key bindings][Key bindings]] * Description - =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. @@ -33,7 +32,6 @@ as definitions or references. - Jump to a file in tag database * Install - ** GNU Global You can install =helm-gtags= from the software repository of your OS. For example, in Ubuntu: @@ -61,11 +59,9 @@ To be able to use =ctags= and other backends, you need to copy the sample cp gtags.conf ~/.globalrc #+end_src -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(gtags)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =gtags= to the existing =dotspacemacs-configuration-layers= list in this +file. * Usage diff --git a/layers/ibuffer/README.org b/layers/ibuffer/README.org index 7e47fe795..5dd8fd935 100644 --- a/layers/ibuffer/README.org +++ b/layers/ibuffer/README.org @@ -13,14 +13,10 @@ This layer configures Emacs ibuffer for Spacemacs. * Install - ** Layer - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(ibuffer)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =ibuffer= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Grouping buffers diff --git a/layers/jabber/README.org b/layers/jabber/README.org index ef1a73fe7..4fbc50e64 100644 --- a/layers/jabber/README.org +++ b/layers/jabber/README.org @@ -16,10 +16,9 @@ This layer adds keybindings for jabber.el. jabber.el is a Jabber (XMPP) client for Emacs * Install -To use this contribution layer add it to your =~/.spacemacs= - #+begin_src emacs-lisp - (set-default dotspacemacs-configuration-layers '(jabber)) - #+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =jabber= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/nixos/README.org b/layers/nixos/README.org index a0016f783..a7ba65b96 100644 --- a/layers/nixos/README.org +++ b/layers/nixos/README.org @@ -21,13 +21,10 @@ This layer adds tools for better integration of emacs in NixOS. - Helm Lookup for NixOS Options [[https://github.com/travisbhartwell/nix-emacs/blob/master/helm-nixos-options.el][helm-nixos-options]] * Install - ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(nixos)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =nixos= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/org/README.org b/layers/org/README.org index 1bc6739a6..4ec56cffc 100644 --- a/layers/org/README.org +++ b/layers/org/README.org @@ -57,11 +57,9 @@ One way to avoid conflict is to wrap your =org= config code in a * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(org)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =org= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Github support To install Github related extensions like [[https://github.com/larstvei/ox-gfm][ox-gfm]] to export to Github diff --git a/layers/osx/README.org b/layers/osx/README.org index 87e054058..181138b8c 100644 --- a/layers/osx/README.org +++ b/layers/osx/README.org @@ -32,7 +32,9 @@ and we encourage you to do so :) ** Layer -To use this configuration layer, add it to your =~/.spacemacs=. You will need to add `osx` to the existing list of `dotspacemacs-configuration-layers` in this file. +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =osx= to the existing =dotspacemacs-configuration-layers= list in this +file. *** Use with non-US keyboard layouts diff --git a/layers/prodigy/README.org b/layers/prodigy/README.org index 69284eda0..450fcad62 100644 --- a/layers/prodigy/README.org +++ b/layers/prodigy/README.org @@ -19,12 +19,9 @@ It is recommended to put to put your prodigy services in the =dotspacemacs/user-config= part of your =~/.spacemacs= file. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(prodigy)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =prodigy= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/restclient/README.org b/layers/restclient/README.org index d128c67be..dbada8c7a 100644 --- a/layers/restclient/README.org +++ b/layers/restclient/README.org @@ -1,8 +1,9 @@ -#+TITLE: Restclient contribution layer +#+TITLE: Restclient layer #+HTML_HEAD_EXTRA: * Table of Contents :TOC_4_org:noexport: - [[What is this?][What is this?]] + - [[Install][Install]] - [[Keybindings][Keybindings]] * What is this? @@ -12,6 +13,11 @@ package's [[https://github.com/pashky/restclient.el][GitHub Page]]. Also there is an [[http://emacsrocks.com/e15.html][Emacs Rocks!]] episode of it. +* Install +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =restclient= to the existing =dotspacemacs-configuration-layers= list in this +file. + * Keybindings | Key Binding | Description | diff --git a/layers/search-engine/README.org b/layers/search-engine/README.org index c52af533f..5ddf0d50d 100644 --- a/layers/search-engine/README.org +++ b/layers/search-engine/README.org @@ -31,12 +31,9 @@ This layer adds support for the [[https://github.com/hrs/engine-mode/engine-mode - Wolfram Alpha * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(search-engine)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =search-engine= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/semantic/README.org b/layers/semantic/README.org index 7269a5278..eed8808c0 100644 --- a/layers/semantic/README.org +++ b/layers/semantic/README.org @@ -29,12 +29,9 @@ language, instead of plain text structure. Semantic is the core of CEDET. features. * Install - -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(semantic)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =semantic= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key Bindings diff --git a/layers/shell/README.org b/layers/shell/README.org index b0617cfb8..96444e822 100644 --- a/layers/shell/README.org +++ b/layers/shell/README.org @@ -22,11 +22,9 @@ This layer configures the various shells available in Emacs. * Install ** Layer -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(shell)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =shell= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Default shell Emacs supports three types of shell: @@ -130,7 +128,6 @@ Some advanced configuration is setup for =eshell= in this layer: layer is installed) - pressing ~i~ in normal state will automatically jump to the prompt - * Key bindings | Key Binding | Description | diff --git a/layers/smex/README.org b/layers/smex/README.org index 1be1a9a48..9bc6661d4 100644 --- a/layers/smex/README.org +++ b/layers/smex/README.org @@ -14,11 +14,9 @@ This layer replaces =helm-M-x= by [[https://github.com/nonsequitur/smex][smex]] activated in the Spacemacs layer. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(smex)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =smex= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/speed-reading/README.org b/layers/speed-reading/README.org index d073f6bc3..9c14a6406 100644 --- a/layers/speed-reading/README.org +++ b/layers/speed-reading/README.org @@ -10,11 +10,9 @@ A speed reading mode for Emacs. * Install -To use this contribution add it to your =~/.spacemacs= - -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(speed-reading)) -#+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =speed-reading= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/spell-checking/README.org b/layers/spell-checking/README.org index 7677b7392..e9ce1fb6d 100644 --- a/layers/spell-checking/README.org +++ b/layers/spell-checking/README.org @@ -15,11 +15,9 @@ This layer provides spell checking using [[http://www-sop.inria.fr/members/Manue * Install ** Layer -To use this configuration layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(spell-checking)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =spell-checking= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Spell Checker Configuration The built-in Emacs variable that controls which external spell-checking program diff --git a/layers/spotify/README.org b/layers/spotify/README.org index b71709b63..f71bcd5c5 100644 --- a/layers/spotify/README.org +++ b/layers/spotify/README.org @@ -13,12 +13,9 @@ This layer adds key bindings for controlling Spotify from inside Emacs. * Install - -To use this contribution layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(set-default dotspacemacs-configuration-layers '(spotify)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =spotify= to the existing =dotspacemacs-configuration-layers= list in this +file. * Key bindings diff --git a/layers/syntax-checking/README.org b/layers/syntax-checking/README.org index 6fd07225e..285fa4814 100644 --- a/layers/syntax-checking/README.org +++ b/layers/syntax-checking/README.org @@ -16,11 +16,9 @@ This layer provides on the fly syntax checking using [[http://www.flycheck.org/] * Install ** Layer -To use this configuration layer add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(syntax-checking)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =syntax-checking= to the existing =dotspacemacs-configuration-layers= list in this +file. ** Enabling/Disabling tooltips By default tooltips are enabled and used whenever it is possible. diff --git a/layers/themes-megapack/README.org b/layers/themes-megapack/README.org index 19de9ed30..e3a7d9297 100644 --- a/layers/themes-megapack/README.org +++ b/layers/themes-megapack/README.org @@ -12,8 +12,6 @@ for Emacs. You can try them easily by invoking helm-themes with: ~ T h~. You can see samples of all included themes in this [[http://themegallery.robdor.com][theme gallery]] from [[http://www.twitter.com/robmerrell][Rob Merrell]]. * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp -(setq-default dotspacemacs-configuration-layers '(themes-megapack)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =themes-megapack= to the existing =dotspacemacs-configuration-layers= list in this +file. diff --git a/layers/theming/README.org b/layers/theming/README.org index d3108a1f9..d15ff782b 100644 --- a/layers/theming/README.org +++ b/layers/theming/README.org @@ -13,11 +13,9 @@ This layer allows for a simple way of modifying themes. * Install -To use this contribution add it to your =~/.spacemacs= - -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(theming)) -#+end_src +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =theming= to the existing =dotspacemacs-configuration-layers= list in this +file. * Usage To use this layer, set the value of =theming-modifications=. It should be a list diff --git a/layers/typography/README.org b/layers/typography/README.org index 59a2a624e..833786b54 100644 --- a/layers/typography/README.org +++ b/layers/typography/README.org @@ -18,11 +18,9 @@ provides modes to automatically insert and cycle among typographic characters: available on Emacs 25). * Install -To use this contribution add it to your =~/.spacemacs= - -#+BEGIN_SRC emacs-lisp - (setq-default dotspacemacs-configuration-layers '(typography)) -#+END_SRC +To use this configuration layer, add it to your =~/.spacemacs=. You will need to +add =typography= to the existing =dotspacemacs-configuration-layers= list in this +file. Typographic editing however is disabled by default. To enable it by default set =typography-enable-typographic-editing= to =t=: