TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Convert documentation to publishable format

This commit is contained in:
Eivind Fonn 2015-10-30 12:20:58 +01:00 committed by syl20bnr
parent 9c7c148141
commit 13c5b1d24b
111 changed files with 1758 additions and 1850 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/CONTRIBUTE.org
View File

@ -1,28 +1,27 @@
* Contribute to Spacemacs #+SETUPFILE: theme-readtheorg.setup
** Table of Contents :TOC@4: * Contribute to Spacemacs :TOC_4_org:noexport:
- [[#contribute-to-spacemacs][Contribute to Spacemacs]] - [[Pull Request Guidelines][Pull Request Guidelines]]
- [[#pull-request-guidelines][Pull Request Guidelines]] - [[Ideally and for /simple/ PRs:][Ideally and for /simple/ PRs:]]
- [[#ideally-and-for-simple-prs][Ideally and for /simple/ PRs:]] - [[For complex pull requests:][For complex pull requests:]]
- [[#for-complex-pull-requests][For complex pull requests:]] - [[Getting Help][Getting Help]]
- [[#getting-help][Getting Help]] - [[Submitting a configuration layer][Submitting a configuration layer]]
- [[#submitting-a-configuration-layer][Submitting a configuration layer]] - [[Testing][Testing]]
- [[#testing][Testing]] - [[Submitting a banner][Submitting a banner]]
- [[#submitting-a-banner][Submitting a banner]] - [[Credits][Credits]]
- [[#credits][Credits]] - [[License][License]]
- [[#license][License]] - [[File header][File header]]
- [[#file-header][File header]] - [[Author of a contribution layer][Author of a contribution layer]]
- [[#author-of-a-contribution-layer][Author of a contribution layer]] - [[Contributor of a contribution layer][Contributor of a contribution layer]]
- [[#contributor-of-a-contribution-layer][Contributor of a contribution layer]]
** Pull Request Guidelines * Pull Request Guidelines
Spacemacs branch model is inspired from the [[http://nvie.com/posts/a-successful-git-branching-model/][git-flow]] model: Spacemacs branch model is inspired from the [[http://nvie.com/posts/a-successful-git-branching-model/][git-flow]] model:
You'll have to submit your contributions and fixes within a pull-request to You'll have to submit your contributions and fixes within a pull-request to
apply against the =develop= branch. apply against the =develop= branch.
/PR = pull request/ /PR = pull request/
*** Ideally and for /simple/ PRs: ** Ideally and for /simple/ PRs:
- branch from =develop= - branch from =develop=
- one topic per PR - one topic per PR
- one commit per PR - one commit per PR
@ -35,19 +34,19 @@ apply against the =develop= branch.
Those PRs are /fast-forwarded/ whenever it's possible and Those PRs are /fast-forwarded/ whenever it's possible and
/cherry-picked/ otherwise (most likely they will be cherry-picked). /cherry-picked/ otherwise (most likely they will be cherry-picked).
*** For complex pull requests: ** For complex pull requests:
- squash only the commits with uninteresting changes like typos, syntax - squash only the commits with uninteresting changes like typos, syntax
fixes, etc... and keep the important and /isolated/ steps in fixes, etc... and keep the important and /isolated/ steps in
different commits. different commits.
Those PRs are /merged/ and explicitly /not fast-forwarded/. Those PRs are /merged/ and explicitly /not fast-forwarded/.
*** Getting Help ** Getting Help
If you have any question on this process, join the [[https://gitter.im/syl20bnr/spacemacs][gitter If you have any question on this process, join the [[https://gitter.im/syl20bnr/spacemacs][gitter
chatroom]] and ask your questions there. It will be a pleasure to help you to chatroom]] and ask your questions there. It will be a pleasure to help you to
contribute! contribute!
** Submitting a configuration layer * Submitting a configuration layer
Contributed configuration layers are stored in the =layers= folder. The Contributed configuration layers are stored in the =layers= folder. The
=layers= folder also contains categories prefixed with =+= to put your =layers= folder also contains categories prefixed with =+= to put your
layers in. For example a layer for a language would go in the layers in. For example a layer for a language would go in the
@ -62,9 +61,9 @@ It is recommended to join a =README.org= file with your layer:
- if a logo exists for the layer you can add it at the top of the =README.org= - if a logo exists for the layer you can add it at the top of the =README.org=
before the TOC. The maximum recommended height is 200 pixels. before the TOC. The maximum recommended height is 200 pixels.
Please read the [[LAYERS.org][tips for writing layers]] first. Please read the [[file:LAYERS.org][tips for writing layers]] first.
** Testing * Testing
Tests live in the =tests= folder, with a folder structure corresponding to the Tests live in the =tests= folder, with a folder structure corresponding to the
rest of the repository. rest of the repository.
@ -104,7 +103,7 @@ To add tests for a layer, do the following:
Spacemacs is lacking tests, so contributions are welcome. Spacemacs is lacking tests, so contributions are welcome.
** Submitting a banner * Submitting a banner
The startup banner is by default randomly chosen among a pool of banners The startup banner is by default randomly chosen among a pool of banners
each time Spacemacs starts. Banners are located in directory each time Spacemacs starts. Banners are located in directory
=~/.emacs.d/core/banners=. =~/.emacs.d/core/banners=.
@ -114,8 +113,8 @@ If you have some ASCII skills you can submit your artwork!
You are free to choose a reasonable height size but the width size You are free to choose a reasonable height size but the width size
should be around 75 characters. should be around 75 characters.
** Credits * Credits
*** License ** License
The license is GPLv3 for all parts specific to Spacemacs, this The license is GPLv3 for all parts specific to Spacemacs, this
includes: - the initialization and core files - all the layer files. includes: - the initialization and core files - all the layer files.
@ -123,7 +122,7 @@ For files not belonging to Spacemacs like extensions and libraries,
refer to the header file. Those files should not have an empty header, refer to the header file. Those files should not have an empty header,
please report any file imported in Spacemacs without a proper header. please report any file imported in Spacemacs without a proper header.
*** File header ** File header
Template: Template:
#+BEGIN_EXAMPLE #+BEGIN_EXAMPLE
@ -140,14 +139,14 @@ Template:
;;; License: GPLv3 ;;; License: GPLv3
#+END_EXAMPLE #+END_EXAMPLE
*** Author of a contribution layer ** Author of a contribution layer
In the file header: - change =NAME= to the name of the layer, - change In the file header: - change =NAME= to the name of the layer, - change
the default author name =Sylvain Benner= to your name, - do not remove the default author name =Sylvain Benner= to your name, - do not remove
the line: =;; Copyright (c) 2012-2014 Sylvain Benner= - modify the the line: =;; Copyright (c) 2012-2014 Sylvain Benner= - modify the
second copyright line by replacing the default name and dates, *keep* second copyright line by replacing the default name and dates, *keep*
=& Contributors= in this line, - other lines should not be modified =& Contributors= in this line, - other lines should not be modified
*** Contributor of a contribution layer ** Contributor of a contribution layer
You should not modify any header file. A very cool way to show your You should not modify any header file. A very cool way to show your
contributions will be available in Spacemacs at some point, /Stay contributions will be available in Spacemacs at some point, /Stay
Tuned/. Tuned/.

144
doc/CONVENTIONS.org
View File

@ -1,43 +1,43 @@
* Spacemacs conventions #+SETUPFILE: theme-readtheorg.setup
** Table of Contents :TOC@4:
- [[#spacemacs-conventions][Spacemacs conventions]]
- [[#code-guidelines][Code guidelines]]
- [[#spacemacs-core-and-layer][Spacemacs core and layer]]
- [[#all-layers][All layers]]
- [[#key-bindings-conventions][Key bindings conventions]]
- [[#reserved-prefix][Reserved prefix]]
- [[#user-prefix][User prefix]]
- [[#major-mode-prefix][Major mode prefix]]
- [[#micro-state][Micro-state]]
- [[#evilified-buffers][Evilified buffers]]
- [[#navigation][Navigation]]
- [[#n-and-n][n and N]]
- [[#code-navigation][Code Navigation]]
- [[#insert-state-buffers][=insert state= buffers]]
- [[#evaluation][Evaluation]]
- [[#repls][REPLs]]
- [[#send-code][Send code]]
- [[#in-terminal][In terminal]]
- [[#building-and-compilation][Building and Compilation]]
- [[#debugging][Debugging]]
- [[#plain-text-markup-languages][Plain Text Markup Languages]]
- [[#headers][Headers]]
- [[#insertion-of-common-elements][Insertion of common elements]]
- [[#text-manipulation][Text manipulation]]
- [[#movement-in-normal-mode][Movement in normal mode]]
- [[#promotion-demotion-and-element-movement][Promotion, Demotion and element movement]]
- [[#table-editing][Table editing]]
- [[#tests][Tests]]
- [[#all-languages][All languages]]
- [[#language-specific][Language specific]]
- [[#toggles][Toggles]]
- [[#refactoring][Refactoring]]
- [[#help-or-documentation][Help or Documentation]]
- [[#writing-documentation][Writing documentation]]
- [[#spacing-in-documentation][Spacing in documentation]]
** Code guidelines * Spacemacs conventions :TOC_4_org:noexport:
*** Spacemacs core and layer - [[Code guidelines][Code guidelines]]
- [[Spacemacs core and layer][Spacemacs core and layer]]
- [[All layers][All layers]]
- [[Key bindings conventions][Key bindings conventions]]
- [[Reserved prefix][Reserved prefix]]
- [[User prefix][User prefix]]
- [[Major mode prefix][Major mode prefix]]
- [[Micro-state][Micro-state]]
- [[Evilified buffers][Evilified buffers]]
- [[Navigation][Navigation]]
- [[n and N][n and N]]
- [[Code Navigation][Code Navigation]]
- [[=insert state= buffers][=insert state= buffers]]
- [[Evaluation][Evaluation]]
- [[REPLs][REPLs]]
- [[Send code][Send code]]
- [[In terminal][In terminal]]
- [[Building and Compilation][Building and Compilation]]
- [[Debugging][Debugging]]
- [[Plain Text Markup Languages][Plain Text Markup Languages]]
- [[Headers][Headers]]
- [[Insertion of common elements][Insertion of common elements]]
- [[Text manipulation][Text manipulation]]
- [[Movement in normal mode][Movement in normal mode]]
- [[Promotion, Demotion and element movement][Promotion, Demotion and element movement]]
- [[Table editing][Table editing]]
- [[Tests][Tests]]
- [[All languages][All languages]]
- [[Language specific][Language specific]]
- [[Toggles][Toggles]]
- [[Refactoring][Refactoring]]
- [[Help or Documentation][Help or Documentation]]
- [[Writing documentation][Writing documentation]]
- [[Spacing in documentation][Spacing in documentation]]
* Code guidelines
** Spacemacs core and layer
Function names follow these conventions: Function names follow these conventions:
- =spacemacs/xxx= is an interactive function called =xxx= - =spacemacs/xxx= is an interactive function called =xxx=
- =spacemacs//xxx= is a private function called =xxx= (implementation details) - =spacemacs//xxx= is a private function called =xxx= (implementation details)
@ -47,22 +47,22 @@ Variables follow these conventions:
- =spacemacs-xxx= is a variable - =spacemacs-xxx= is a variable
- =spacemacs--xxx= is a private variable (implementation details) - =spacemacs--xxx= is a private variable (implementation details)
*** All layers ** All layers
A package is initialized in a function with name =<layer>/init-xxx= where: A package is initialized in a function with name =<layer>/init-xxx= where:
- =<layer>= is the layer name - =<layer>= is the layer name
- =xxx= is the package name - =xxx= is the package name
** Key bindings conventions * Key bindings conventions
*** Reserved prefix ** Reserved prefix
**** User prefix *** User prefix
~SPC o~ and ~SPC m o~ must not be used by any layer. They are reserved for the ~SPC o~ and ~SPC m o~ must not be used by any layer. They are reserved for the
user. user.
**** Major mode prefix *** Major mode prefix
~SPC m~ is reserved for the current major mode. Three keys bindings are not an ~SPC m~ is reserved for the current major mode. Three keys bindings are not an
issue (ie. ~SPC m h d~) since ~SPC m~ can be accessed via ~,~. issue (ie. ~SPC m h d~) since ~SPC m~ can be accessed via ~,~.
**** Micro-state *** Micro-state
Whenever possible a micro-state should be enabled with ~M-SPC~ and ~s-M-SPC~. We Whenever possible a micro-state should be enabled with ~M-SPC~ and ~s-M-SPC~. We
need the latter bindings on OS X since ~M-SPC~ is used by the OS for spotlight. need the latter bindings on OS X since ~M-SPC~ is used by the OS for spotlight.
@ -71,7 +71,7 @@ buffers are good candidates to be put on ~M-SPC~ and ~s-M-SPC~.
It is recommended to add ~q~ to leave the micro-state. It is recommended to add ~q~ to leave the micro-state.
*** Evilified buffers ** Evilified buffers
/Evilifying/ a buffer is to set the =evilified state= as the default /Evilifying/ a buffer is to set the =evilified state= as the default
state for the major mode of the buffer. state for the major mode of the buffer.
@ -100,17 +100,17 @@ rules:
If a key binding cannot be remapped then it is ignored and a warning message If a key binding cannot be remapped then it is ignored and a warning message
is displayed in =*Messages*=. is displayed in =*Messages*=.
*** Navigation ** Navigation
**** n and N *** n and N
To be consistent with the Vim way, ~n~ and ~N~ are favored over Emacs ~n~ and To be consistent with the Vim way, ~n~ and ~N~ are favored over Emacs ~n~ and
~p~. ~p~.
Ideally a micro-state should be provided to smooth the navigation Ideally a micro-state should be provided to smooth the navigation
experience. A micro-state allows to repeat key bindings without entering experience. A micro-state allows to repeat key bindings without entering
each time the prefix commands. More info on micro-states in the each time the prefix commands. More info on micro-states in the
[[DOCUMENTATION.org#micro-states][documentation]]. [[file:DOCUMENTATION.org::Micro-states][documentation]].
**** Code Navigation *** Code Navigation
The prefix for going to something is ~SPC m g~. The prefix for going to something is ~SPC m g~.
| Key | Description | | Key | Description |
@ -121,7 +121,7 @@ The prefix for going to something is ~SPC m g~.
| ~m g G~ | go to things under point in other window | | ~m g G~ | go to things under point in other window |
| ~m g t~ | go to corresponding test file if any | | ~m g t~ | go to corresponding test file if any |
**** =insert state= buffers *** =insert state= buffers
Navigation in buffers like =Helm= and =ido= which are in =insert state= Navigation in buffers like =Helm= and =ido= which are in =insert state=
should be performed with ~C-j~ and ~C-k~ bindings for vertical movements. should be performed with ~C-j~ and ~C-k~ bindings for vertical movements.
@ -130,7 +130,7 @@ should be performed with ~C-j~ and ~C-k~ bindings for vertical movements.
| ~C-j~ | go down | | ~C-j~ | go down |
| ~C-k~ | go up | | ~C-k~ | go up |
*** Evaluation ** Evaluation
Live evaluation of code is under the prefix ~SPC m e~. Live evaluation of code is under the prefix ~SPC m e~.
| Key | Description | | Key | Description |
@ -142,8 +142,8 @@ Live evaluation of code is under the prefix ~SPC m e~.
| ~m e l~ | evaluate line | | ~m e l~ | evaluate line |
| ~m e r~ | evaluate region | | ~m e r~ | evaluate region |
*** REPLs ** REPLs
**** Send code *** Send code
A lot of languages can interact with a REPL. To help keeping a A lot of languages can interact with a REPL. To help keeping a
consistent behavior between those languages the following conventions consistent behavior between those languages the following conventions
should be followed: should be followed:
@ -168,7 +168,7 @@ should be followed:
Note: we don't distinguish between the file and the buffer. Note: we don't distinguish between the file and the buffer.
**** In terminal *** In terminal
History navigation in shells or REPLs buffers should be bound as well to History navigation in shells or REPLs buffers should be bound as well to
~C-j~ and ~C-k~. ~C-j~ and ~C-k~.
@ -179,7 +179,7 @@ History navigation in shells or REPLs buffers should be bound as well to
| ~C-l~ | clear screen | | ~C-l~ | clear screen |
| ~C-r~ | search backward in history | | ~C-r~ | search backward in history |
*** Building and Compilation ** Building and Compilation
The base prefix for major mode specific compilation is ~SPC m c~. The base prefix for major mode specific compilation is ~SPC m c~.
| Key Binding | Description | | Key Binding | Description |
@ -191,7 +191,7 @@ The base prefix for major mode specific compilation is ~SPC m c~.
Note: we don't distinguish between the file and the buffer. We can Note: we don't distinguish between the file and the buffer. We can
implement an auto-save of the buffer before compiling the buffer. implement an auto-save of the buffer before compiling the buffer.
*** Debugging ** Debugging
The base prefix for debugging commands is ~SPC d~. The base prefix for debugging commands is ~SPC d~.
| Key Binding | Description | | Key Binding | Description |
@ -213,11 +213,11 @@ Notes:
the spacemacs level and ideally the function should be proposed as a patch the spacemacs level and ideally the function should be proposed as a patch
upstream (major mode repository). upstream (major mode repository).
*** Plain Text Markup Languages ** Plain Text Markup Languages
For layers supporting markup languages please follow the following For layers supporting markup languages please follow the following
keybindings whenever applicable. keybindings whenever applicable.
**** Headers *** Headers
All header functionality should be grouped under ~SPC m h~ All header functionality should be grouped under ~SPC m h~
| Key Binding | Description | | Key Binding | Description |
@ -226,7 +226,7 @@ All header functionality should be grouped under ~SPC m h~
| ~m h I~ | Insert a header alternative method (if existing) | | ~m h I~ | Insert a header alternative method (if existing) |
| ~m h 1..10~ | Insert a header of level 1..10 (if possible) | | ~m h 1..10~ | Insert a header of level 1..10 (if possible) |
**** Insertion of common elements *** Insertion of common elements
Insertion of common elements like links or footnotes should be grouped Insertion of common elements like links or footnotes should be grouped
under ~SPC m i~ under ~SPC m i~
@ -238,7 +238,7 @@ under ~SPC m i~
| ~m i u~ | Insert url | | ~m i u~ | Insert url |
| ~m i w~ | Insert wiki-link | | ~m i w~ | Insert wiki-link |
**** Text manipulation *** Text manipulation
Manipulation of text regions should be grouped under ~SPC m x~ Manipulation of text regions should be grouped under ~SPC m x~
| Key Binding | Description | | Key Binding | Description |
@ -252,7 +252,7 @@ Manipulation of text regions should be grouped under ~SPC m x~
| ~m x u~ | Make region underlined | | ~m x u~ | Make region underlined |
| ~m x v~ | Make region verbose | | ~m x v~ | Make region verbose |
**** Movement in normal mode *** Movement in normal mode
In normal mode Vim style movement should be enabled with these keybindings: In normal mode Vim style movement should be enabled with these keybindings:
| Key Binding | Description | | Key Binding | Description |
@ -262,7 +262,7 @@ In normal mode Vim style movement should be enabled with these keybindings:
| ~g k~ | Move to previous heading on same level | | ~g k~ | Move to previous heading on same level |
| ~g l~ | Move down one level in headings | | ~g l~ | Move down one level in headings |
**** Promotion, Demotion and element movement *** Promotion, Demotion and element movement
Promotion, demotion and movement of headings or list elements (whatever is Promotion, demotion and movement of headings or list elements (whatever is
possible) should be enabled with the following keys in any mode possible) should be enabled with the following keys in any mode
@ -273,17 +273,17 @@ possible) should be enabled with the following keys in any mode
| ~M-k~ | Move element up | | ~M-k~ | Move element up |
| ~M-l~ | Demote heading by one level | | ~M-l~ | Demote heading by one level |
**** Table editing *** Table editing
If table specific commands are available the they are grouped under the If table specific commands are available the they are grouped under the
~SPC m t~ group. ~SPC m t~ group.
*** Tests ** Tests
A lot of languages have their own test frameworks. These frameworks A lot of languages have their own test frameworks. These frameworks
share common actions that we can unite under the same key bindings: share common actions that we can unite under the same key bindings:
- ~SPC m t~ is the prefix for test execution. - ~SPC m t~ is the prefix for test execution.
- ~SPC m t X~ is used to execute ~SPC m t x~ but in debug mode (if supported). - ~SPC m t X~ is used to execute ~SPC m t x~ but in debug mode (if supported).
**** All languages *** All languages
| Key | Description | | Key | Description |
|---------+--------------------------------------------------------------| |---------+--------------------------------------------------------------|
@ -298,7 +298,7 @@ Note: we don't distinguish between the file and the buffer. We can
implement an auto-save of the buffer before executing the tests of implement an auto-save of the buffer before executing the tests of
buffer. buffer.
**** Language specific *** Language specific
| Key | Description | | Key | Description |
|---------+--------------------------------------------------| |---------+--------------------------------------------------|
| ~m t m~ | execute the tests of the current module | | ~m t m~ | execute the tests of the current module |
@ -309,14 +309,14 @@ buffer.
Note that there are overlaps, depending on the language we will choose Note that there are overlaps, depending on the language we will choose
one or more bindings for the same thing one or more bindings for the same thing
*** Toggles ** Toggles
- Global toggles are under ~SPC t~, ~SPC T~ and ~SPC C-t~ - Global toggles are under ~SPC t~, ~SPC T~ and ~SPC C-t~
- Major mode toggles are only under ~SPC m T~ - Major mode toggles are only under ~SPC m T~
*** Refactoring ** Refactoring
Refactoring prefix is ~SPC m r~. Refactoring prefix is ~SPC m r~.
*** Help or Documentation ** Help or Documentation
The base prefix for help commands is ~SPC h~. Documentation is considered The base prefix for help commands is ~SPC h~. Documentation is considered
as an help command. as an help command.
@ -325,11 +325,11 @@ as an help command.
| ~m h h~ | documentation of thing under point | | ~m h h~ | documentation of thing under point |
| ~m h r~ | documentation of selected region | | ~m h r~ | documentation of selected region |
** Writing documentation * Writing documentation
Spacemacs provides an example layer =README.org= file in Spacemacs provides an example layer =README.org= file in
=~/.emacs.d/core/templates/layer-README.template=. =~/.emacs.d/core/templates/layer-README.template=.
*** Spacing in documentation ** Spacing in documentation
Spacemacs tries to keep the documentation consistent between all layers by Spacemacs tries to keep the documentation consistent between all layers by
providing some rules for spacing: providing some rules for spacing:
- After each header, you should not add an empty line - After each header, you should not add an empty line

788
doc/DOCUMENTATION.org
View File

File diff suppressed because it is too large Load Diff

116
doc/FAQ.org
View File

@ -1,64 +1,66 @@
* FAQ :TOC@4: #+SETUPFILE: theme-readtheorg.setup
- [[#common][Common]]
- [[#which-version-of-spacemacs-am-i-running][Which version of Spacemacs am I running?]]
- [[#what-is-the-official-pronunciation-of-spacemacs][What is the official pronunciation of Spacemacs?]]
- [[#why-are-packages-installed-with-package-install-automatically-deleted-by-spacemacs-when-it-boots][Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?]]
- [[#the-spacemacs-banner-is-ugly-what-should-i-do][The Spacemacs banner is ugly, what should I do?]]
- [[#the-powerline-separators-are-ugly-how-can-i-fix-them][The powerline separators are ugly, how can I fix them?]]
- [[#the-powerline-separators-have-no-anti-aliasing-what-can-i-do][The powerline separators have no anti-aliasing, what can I do?]]
- [[#why-is-after-init-hook-not-executed][Why is after-init-hook not executed?]]
- [[#what-is-the-difference-between-spacemacs-base-and-spacemacs-distributions][What is the difference between =spacemacs-base= and =spacemacs= distributions?]]
- [[#how-can-i-change-or-define-an-alias-for-an-evil-leader-prefix][How can I change or define an alias for an =evil-leader= prefix?]]
- [[#should-i-place-my-settings-in-user-init-or-user-config][Should I place my settings in =user-init= or =user-config=?]]
- [[#why-do-some-of-my-org-related-settings-cause-problems][Why do some of my =org=-related settings cause problems?]]
- [[#how-do-i][How do I]]
- [[#disable-a-package-completely][Disable a package completely?]]
- [[#disable-a-package-only-for-a-specific-major-mode][Disable a package only for a specific major-mode?]]
- [[#disable-company-for-a-specific-major-mode][Disable company for a specific major-mode?]]
- [[#change-special-buffer-rules][Change special buffer rules?]]
- [[#enable-navigation-by-visual-lines][Enable navigation by visual lines?]]
- [[#disable-evilification-of-a-mode][Disable evilification of a mode?]]
- [[#include-underscores-in-word-motions][Include underscores in word motions?]]
- [[#setup-path][Setup =$PATH=?]]
- [[#windows][Windows]]
- [[#why-do-the-fonts-look-crappy-on-windows][Why do the fonts look crappy on Windows?]]
- [[#why-is-there-no-spacemacs-logo-in-the-startup-buffer][Why is there no Spacemacs logo in the startup buffer?]]
- [[#why-are-all-packages-unavailable][Why are all packages unavailable?]]
- [[#os-x][OS X]]
- [[#why-are-the-powerline-colors-not-correct-on-os-x][Why are the powerline colors not correct on OS X?]]
** Common * FAQ :TOC_4_org:noexport:
*** Which version of Spacemacs am I running? - [[Common][Common]]
- [[Which version of Spacemacs am I running?][Which version of Spacemacs am I running?]]
- [[What is the official pronunciation of Spacemacs?][What is the official pronunciation of Spacemacs?]]
- [[Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?][Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?]]
- [[The Spacemacs banner is ugly, what should I do?][The Spacemacs banner is ugly, what should I do?]]
- [[The powerline separators are ugly, how can I fix them?][The powerline separators are ugly, how can I fix them?]]
- [[The powerline separators have no anti-aliasing, what can I do?][The powerline separators have no anti-aliasing, what can I do?]]
- [[Why is after-init-hook not executed?][Why is after-init-hook not executed?]]
- [[What is the difference between =spacemacs-base= and =spacemacs= distributions?][What is the difference between =spacemacs-base= and =spacemacs= distributions?]]
- [[How can I change or define an alias for an =evil-leader= prefix?][How can I change or define an alias for an =evil-leader= prefix?]]
- [[Should I place my settings in =user-init= or =user-config=?][Should I place my settings in =user-init= or =user-config=?]]
- [[Why do some of my =org=-related settings cause problems?][Why do some of my =org=-related settings cause problems?]]
- [[How do I...][How do I...]]
- [[Disable a package completely?][Disable a package completely?]]
- [[Disable a package only for a specific major-mode?][Disable a package only for a specific major-mode?]]
- [[Disable company for a specific major-mode?][Disable company for a specific major-mode?]]
- [[Change special buffer rules?][Change special buffer rules?]]
- [[Enable navigation by visual lines?][Enable navigation by visual lines?]]
- [[Disable evilification of a mode?][Disable evilification of a mode?]]
- [[Include underscores in word motions?][Include underscores in word motions?]]
- [[Setup =$PATH=?][Setup =$PATH=?]]
- [[Windows][Windows]]
- [[Why do the fonts look crappy on Windows?][Why do the fonts look crappy on Windows?]]
- [[Why is there no Spacemacs logo in the startup buffer?][Why is there no Spacemacs logo in the startup buffer?]]
- [[Why are all packages unavailable?][Why are all packages unavailable?]]
- [[OS X][OS X]]
- [[Why are the powerline colors not correct on OS X?][Why are the powerline colors not correct on OS X?]]
* Common
** Which version of Spacemacs am I running?
The version is displayed on the upper right corner of the loading screen. You The version is displayed on the upper right corner of the loading screen. You
may also just type ~SPC f e v~. may also just type ~SPC f e v~.
*** What is the official pronunciation of Spacemacs? ** What is the official pronunciation of Spacemacs?
As it is written, that is _space_ then _macs_. As it is written, that is _space_ then _macs_.
*** Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots? ** Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?
To declare new packages you have to create a new configuration layer, see the To declare new packages you have to create a new configuration layer, see the
[[file:QUICK_START.org][quick start guide]]. [[file:QUICK_START.org][quick start guide]].
*** The Spacemacs banner is ugly, what should I do? ** The Spacemacs banner is ugly, what should I do?
Install the default font supported by Spacemacs or choose a fixed width font. Install the default font supported by Spacemacs or choose a fixed width font.
More information in the font section of the [[file:DOCUMENTATION.org][documentation]]. More information in the font section of the [[file:DOCUMENTATION.org][documentation]].
*** The powerline separators are ugly, how can I fix them? ** The powerline separators are ugly, how can I fix them?
Use the property =:powerline-scale= of the variable =dotspacemacs-default-font=. Use the property =:powerline-scale= of the variable =dotspacemacs-default-font=.
See font section of the [[file:DOCUMENTATION.org][documentation]] for more details. See font section of the [[file:DOCUMENTATION.org][documentation]] for more details.
*** The powerline separators have no anti-aliasing, what can I do? ** The powerline separators have no anti-aliasing, what can I do?
Emacs powerline uses XMP images to draw the separators in a graphical Emacs powerline uses XMP images to draw the separators in a graphical
environment. You can have anti-aliasing if you use the =utf8= separator. Note environment. You can have anti-aliasing if you use the =utf8= separator. Note
that by default the =utf8= separator is used in a terminal. See the powerline that by default the =utf8= separator is used in a terminal. See the powerline
section in the font section of the [[file:DOCUMENTATION.org][documentation]]. section in the font section of the [[file:DOCUMENTATION.org][documentation]].
*** Why is after-init-hook not executed? ** Why is after-init-hook not executed?
Don't launch Spacemacs with =emacs -q -l init.el= command. This command will run Don't launch Spacemacs with =emacs -q -l init.el= command. This command will run
the hooked function in =after-init-hook= before the evaluation of the passed =-l the hooked function in =after-init-hook= before the evaluation of the passed =-l
init.el= file. init.el= file.
*** What is the difference between =spacemacs-base= and =spacemacs= distributions? ** What is the difference between =spacemacs-base= and =spacemacs= distributions?
The =distribution= concept was introduced in 0.104.x. You can now choose The =distribution= concept was introduced in 0.104.x. You can now choose
between two distributions =spacemacs= or =spacemacs-base=. between two distributions =spacemacs= or =spacemacs-base=.
=spacemacs-base= contains only a minimal set of packages; whereas =spacemacs= =spacemacs-base= contains only a minimal set of packages; whereas =spacemacs=
@ -68,7 +70,7 @@ Set the distribution with =dotspacemacs-distribution= variable. The default is
check out the =packages.el= file in the respective folders in the check out the =packages.el= file in the respective folders in the
=+distribution= folder of the =layers/= directory. =+distribution= folder of the =layers/= directory.
*** How can I change or define an alias for an =evil-leader= prefix? ** How can I change or define an alias for an =evil-leader= prefix?
It is possible to change an =evil-leader= prefix by binding its keymap to It is possible to change an =evil-leader= prefix by binding its keymap to
another sequence. For instance, if you want to switch ~SPC l~ another sequence. For instance, if you want to switch ~SPC l~
(=evil-avy-goto-line=) with ~SPC L~ (=perspectives= layer) to make the later (=evil-avy-goto-line=) with ~SPC L~ (=perspectives= layer) to make the later
@ -80,21 +82,21 @@ easier to reach, you can use:
"L" 'evil-avy-goto-line) "L" 'evil-avy-goto-line)
#+end_src #+end_src
*** Should I place my settings in =user-init= or =user-config=? ** Should I place my settings in =user-init= or =user-config=?
Any variable that layer configuration code will *read* and *act on* must be set Any variable that layer configuration code will *read* and *act on* must be set
in =user-init=, and any variable that Spacemacs explicitly sets but you wish to in =user-init=, and any variable that Spacemacs explicitly sets but you wish to
*override* must be set in =user-config=. *override* must be set in =user-config=.
Anything that isn't just setting a variable should 99% be in =user-config=. Anything that isn't just setting a variable should 99% be in =user-config=.
*** Why do some of my =org=-related settings cause problems? ** Why do some of my =org=-related settings cause problems?
Since version 0.104, spacemacs uses the `org` version from the org ELPA Since version 0.104, spacemacs uses the `org` version from the org ELPA
repository instead of the one shipped with emacs. Then, any `org` related code repository instead of the one shipped with emacs. Then, any `org` related code
should not be loaded before `dotspacemacs/user-config`, otherwise both versions should not be loaded before `dotspacemacs/user-config`, otherwise both versions
will be loaded and will conflict. will be loaded and will conflict.
** How do I * How do I...
*** Disable a package completely? ** Disable a package completely?
To completely disable a package and effectively uninstalling it even if To completely disable a package and effectively uninstalling it even if
it is part of your used layers, look for the variable it is part of your used layers, look for the variable
=dotspacemacs-excluded-packages= in your dotfile and add the package =dotspacemacs-excluded-packages= in your dotfile and add the package
@ -104,7 +106,7 @@ name to it:
(setq-default dotspacemacs-excluded-packages '(package1 package2 ...)) (setq-default dotspacemacs-excluded-packages '(package1 package2 ...))
#+end_src #+end_src
*** Disable a package only for a specific major-mode? ** Disable a package only for a specific major-mode?
This is done by removing the hook added by Spacemacs. For example to This is done by removing the hook added by Spacemacs. For example to
remove =flycheck= support in python buffers, look for the function remove =flycheck= support in python buffers, look for the function
=dotspacemacs/user-config= in your dotfile and add the following code: =dotspacemacs/user-config= in your dotfile and add the following code:
@ -116,7 +118,7 @@ remove =flycheck= support in python buffers, look for the function
*Hint* to know the name of the major-mode of the current buffer press: *Hint* to know the name of the major-mode of the current buffer press:
~SPC h d v major-mode RET~ ~SPC h d v major-mode RET~
*** Disable company for a specific major-mode? ** Disable company for a specific major-mode?
It may be handy to disable =company= for a given mode if you plan on It may be handy to disable =company= for a given mode if you plan on
configuring =auto-complete= instead. On easy way to do it is to use the configuring =auto-complete= instead. On easy way to do it is to use the
macro =spacemacs|disable-company= in the function =dotspacemacs/user-config= macro =spacemacs|disable-company= in the function =dotspacemacs/user-config=
@ -127,7 +129,7 @@ of your dotfile. The following snippet disables company for
(spacemacs|disable-company python-mode) (spacemacs|disable-company python-mode)
#+end_src #+end_src
*** Change special buffer rules? ** Change special buffer rules?
To change the way spacemacs marks buffers as useless, you can customize To change the way spacemacs marks buffers as useless, you can customize
=spacemacs-useless-buffers-regexp= which marks buffers matching the =spacemacs-useless-buffers-regexp= which marks buffers matching the
regexp as useless. The variable =spacemacs-useful-buffers-regexp= marks regexp as useless. The variable =spacemacs-useful-buffers-regexp= marks
@ -143,7 +145,7 @@ Examples:
(push "\\*Messages\\*" spacemacs-useful-buffers-regexp) (push "\\*Messages\\*" spacemacs-useful-buffers-regexp)
#+end_src #+end_src
*** Enable navigation by visual lines? ** Enable navigation by visual lines?
Add the following snippet to your =dostpacemacs/config= function: Add the following snippet to your =dostpacemacs/config= function:
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -155,7 +157,7 @@ Add the following snippet to your =dostpacemacs/config= function:
(define-key evil-visual-state-map "k" 'evil-previous-visual-line) (define-key evil-visual-state-map "k" 'evil-previous-visual-line)
#+end_src #+end_src
*** Disable evilification of a mode? ** Disable evilification of a mode?
You can ensure a mode opens in emacs state by using =evil-set-initial-state=. You can ensure a mode opens in emacs state by using =evil-set-initial-state=.
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -179,7 +181,7 @@ binding in the mode's map, e.g. for =magit-status-mode=,
(kbd dotspacemacs-leader-key) evil-leader--default-map)) (kbd dotspacemacs-leader-key) evil-leader--default-map))
#+end_src #+end_src
*** Include underscores in word motions? ** Include underscores in word motions?
You can modify the syntax table of the mode in question. For example, for Python You can modify the syntax table of the mode in question. For example, for Python
mode: mode:
@ -188,7 +190,7 @@ mode:
(modify-syntax-entry ?_ "w" python-mode-syntax-table)) (modify-syntax-entry ?_ "w" python-mode-syntax-table))
#+end_src #+end_src
*** Setup =$PATH=? ** Setup =$PATH=?
Some layers require certain tools to be available on your =$PATH=. This means Some layers require certain tools to be available on your =$PATH=. This means
that your =$PATH= must contain the installation paths for those tools. For that your =$PATH= must contain the installation paths for those tools. For
example, if you have installed some tools to =~/.local/bin= and want them to be example, if you have installed some tools to =~/.local/bin= and want them to be
@ -206,7 +208,7 @@ Users of =fish= should add following line to their =config.fish= file (should be
in =$XDG_CONFIG_HOME= or its default value - =~/.config/fish=). Note that =-x= in =$XDG_CONFIG_HOME= or its default value - =~/.config/fish=). Note that =-x=
part is very important. part is very important.
#+BEGIN_SRC #+BEGIN_SRC fish
set -x PATH ~/.local/bin $PATH set -x PATH ~/.local/bin $PATH
#+END_SRC #+END_SRC
@ -236,17 +238,17 @@ In that case you have the option of updating the value of =exec-path= in the
(add-to-list 'exec-path "~/.local/bin/") (add-to-list 'exec-path "~/.local/bin/")
#+END_SRC #+END_SRC
** Windows * Windows
*** Why do the fonts look crappy on Windows? ** Why do the fonts look crappy on Windows?
You can install [[https://code.google.com/p/mactype/][MacType]] on Windows to get very nice looking fonts. It is You can install [[https://code.google.com/p/mactype/][MacType]] on Windows to get very nice looking fonts. It is
also recommended to disable smooth scrolling on Windows. also recommended to disable smooth scrolling on Windows.
*** Why is there no Spacemacs logo in the startup buffer? ** Why is there no Spacemacs logo in the startup buffer?
A GUI build of emacs supporting image display is required. A GUI build of emacs supporting image display is required.
You can follow the instructions [[http://stackoverflow.com/questions/2650041/emacs-under-windows-and-png-files][here]]. Alternatively you can download binaries You can follow the instructions [[http://stackoverflow.com/questions/2650041/emacs-under-windows-and-png-files][here]]. Alternatively you can download binaries
of emacs with image support included such as [[http://emacsbinw64.sourceforge.net/][this one]]. of emacs with image support included such as [[http://emacsbinw64.sourceforge.net/][this one]].
*** Why are all packages unavailable? ** Why are all packages unavailable?
Check if your Emacs has HTTPS capabilities by doing =M-:= and then: Check if your Emacs has HTTPS capabilities by doing =M-:= and then:
#+begin_src emacs-lisp #+begin_src emacs-lisp
@ -256,8 +258,8 @@ Check if your Emacs has HTTPS capabilities by doing =M-:= and then:
If this returns =nil=, you need to install the GnuTLS DDL file in the same If this returns =nil=, you need to install the GnuTLS DDL file in the same
directory as Emacs. See [[https://www.gnu.org/software/emacs/manual/html_mono/emacs-gnutls.html#Help-For-Users][here]] for instructions. directory as Emacs. See [[https://www.gnu.org/software/emacs/manual/html_mono/emacs-gnutls.html#Help-For-Users][here]] for instructions.
** OS X * OS X
*** Why are the powerline colors not correct on OS X? ** Why are the powerline colors not correct on OS X?
This is a [[https://github.com/milkypostman/powerline/issues/54][known issue]] as of Emacs 24.4 due to =ns-use-srgb-colorspace= This is a [[https://github.com/milkypostman/powerline/issues/54][known issue]] as of Emacs 24.4 due to =ns-use-srgb-colorspace=
defaulting to true. It is recommended to use the [[github.com/railwaycat/homebrew-emacsmacport][emacs-mac-port]] build. See the defaulting to true. It is recommended to use the [[http://github.com/railwaycat/homebrew-emacsmacport][emacs-mac-port]] build. See the
install section in the [[file:../README.md][README]] for more details. install section in the [[file:../README.md][README]] for more details.

56
doc/LAYERS.org
View File

@ -1,31 +1,31 @@
* Configuration Layers :TOC@4: * Configuration Layers :TOC_4_org:noexport:
- [[#introduction][Introduction]] - [[Introduction][Introduction]]
- [[#nomenclature][Nomenclature]] - [[Nomenclature][Nomenclature]]
- [[#the-emacs-loading-process][The Emacs loading process]] - [[The Emacs loading process][The Emacs loading process]]
- [[#emacs-lisp-files][Emacs Lisp files]] - [[Emacs Lisp files][Emacs Lisp files]]
- [[#loading-a-file][Loading a file]] - [[Loading a file][Loading a file]]
- [[#features][Features]] - [[Features][Features]]
- [[#the-load-path][The load path]] - [[The load path][The load path]]
- [[#auto-loading][Auto-loading]] - [[Auto-loading][Auto-loading]]
- [[#eval-after-load][Eval after load]] - [[Eval after load][Eval after load]]
- [[#use-package][Use-package]] - [[Use-package][Use-package]]
- [[#anatomy-of-a-layer][Anatomy of a layer]] - [[Anatomy of a layer][Anatomy of a layer]]
- [[#packagesel][packages.el]] - [[packages.el][packages.el]]
- [[#configel-funcsel-and-keybindingsel][config.el, funcs.el and keybindings.el]] - [[config.el, funcs.el and keybindings.el][config.el, funcs.el and keybindings.el]]
- [[#the-spacemacs-loading-process][The Spacemacs loading process]] - [[The Spacemacs loading process][The Spacemacs loading process]]
- [[#case-study-auto-completion][Case study: auto-completion]] - [[Case study: auto-completion][Case study: auto-completion]]
- [[#layer-tips-and-tricks][Layer tips and tricks]] - [[Layer tips and tricks][Layer tips and tricks]]
- [[#cross-dependencies][Cross-dependencies]] - [[Cross-dependencies][Cross-dependencies]]
- [[#use-package][Use-package]] - [[Use-package][Use-package]]
- [[#use-package-hooks][Use-package hooks]] - [[Use-package hooks][Use-package hooks]]
- [[#best-practices][Best practices]] - [[Best practices][Best practices]]
- [[#package-ownership][Package ownership]] - [[Package ownership][Package ownership]]
- [[#localize-your-configuration][Localize your configuration]] - [[Localize your configuration][Localize your configuration]]
- [[#load-ordering][Load ordering]] - [[Load ordering][Load ordering]]
- [[#no-require][No require]] - [[No require][No require]]
- [[#auto-load-everything][Auto-load everything]] - [[Auto-load everything][Auto-load everything]]
- [[#how-do-i--idiomatically][How do I ... idiomatically?]] - [[How do I ... idiomatically?][How do I ... idiomatically?]]
- [[#setup-auto-completion-for-a-major-mode][Setup auto-completion for a major mode]] - [[Setup auto-completion for a major mode][Setup auto-completion for a major mode]]
* Introduction * Introduction
This document is intended as a tutorial for users who are interested in writing This document is intended as a tutorial for users who are interested in writing

54
doc/QUICK_START.org
View File

@ -1,18 +1,18 @@
* Configuration :TOC@4: * Configuration :TOC_4_org:noexport:
- [[#configuration-layers][Configuration layers]] - [[Configuration layers][Configuration layers]]
- [[#dotfile-spacemacs][Dotfile (.spacemacs)]] - [[Dotfile (.spacemacs)][Dotfile (.spacemacs)]]
- [[#dotdirectory-spacemacsd][Dotdirectory (~/.spacemacs.d)]] - [[Dotdirectory (~/.spacemacs.d)][Dotdirectory (~/.spacemacs.d)]]
- [[#learning-spacemacs][Learning Spacemacs]] - [[Learning Spacemacs][Learning Spacemacs]]
- [[#editing-styles][Editing Styles]] - [[Editing Styles][Editing Styles]]
- [[#the-leader-keys][The leader keys]] - [[The leader keys][The leader keys]]
- [[#evil-tutor][Evil-tutor]] - [[Evil-tutor][Evil-tutor]]
- [[#universal-argument][Universal argument]] - [[Universal argument][Universal argument]]
- [[#configuration-layers-and-package-discovery][Configuration layers and Package discovery]] - [[Configuration layers and Package discovery][Configuration layers and Package discovery]]
- [[#key-bindings-discovery][Key bindings discovery]] - [[Key bindings discovery][Key bindings discovery]]
- [[#describe-functions][Describe functions]] - [[Describe functions][Describe functions]]
- [[#how-tos][How-To's]] - [[How-To's][How-To's]]
** Configuration layers * Configuration layers
Spacemacs divides its configuration into self-contained units called Spacemacs divides its configuration into self-contained units called
=configuration layers=. These layers are stacked on top of each other =configuration layers=. These layers are stacked on top of each other
to achieve a custom configuration. to achieve a custom configuration.
@ -29,9 +29,9 @@ own layer.
The following command creates a layer in the =private= directory: The following command creates a layer in the =private= directory:
#+BEGIN_SRC #+BEGIN_EXAMPLE
<SPC> : configuration-layer/create-layer RET <SPC> : configuration-layer/create-layer RET
#+END_SRC #+END_EXAMPLE
Any configuration layers you create must be explicitly loaded in =~/.spacemacs=. Any configuration layers you create must be explicitly loaded in =~/.spacemacs=.
@ -39,7 +39,7 @@ Note: For your privacy, the contents of the =private= directory are not
under source control. See the section on private configuration management in under source control. See the section on private configuration management in
the [[file:DOCUMENTATION.org][documentation]]. the [[file:DOCUMENTATION.org][documentation]].
** Dotfile (.spacemacs) * Dotfile (.spacemacs)
As mentioned =.spacemacs= controls which configuration layers to load and As mentioned =.spacemacs= controls which configuration layers to load and
is also a means to customizing Spacemacs. is also a means to customizing Spacemacs.
@ -82,18 +82,18 @@ The [[file:../core/templates/.spacemacs.template][dotfile template]] contain fur
Spacemacs. See the dotfile configuration section of the [[file:DOCUMENTATION.org][documentation]] for Spacemacs. See the dotfile configuration section of the [[file:DOCUMENTATION.org][documentation]] for
more details. more details.
** Dotdirectory (~/.spacemacs.d) * Dotdirectory (~/.spacemacs.d)
Like =Emacs=, Spacemacs initialization can also be contained in an =init.el= file Like =Emacs=, Spacemacs initialization can also be contained in an =init.el= file
in a special directory =~/.spacemacs.d=. The contents of the dotfile should be in a special directory =~/.spacemacs.d=. The contents of the dotfile should be
then copied in the =init.el= file. then copied in the =init.el= file.
** Learning Spacemacs * Learning Spacemacs
*** Editing Styles ** Editing Styles
Spacemacs can be used by Vim users or Emacs users by setting the Spacemacs can be used by Vim users or Emacs users by setting the
=dotspacemacs-editing-style= variable to =vim=, =emacs= or even =hybrid= =dotspacemacs-editing-style= variable to =vim=, =emacs= or even =hybrid=
in the dotfile =~/.spacemacs=. in the dotfile =~/.spacemacs=.
*** The leader keys ** The leader keys
Spacemacs key bindings use a leader key which is by default bound to Spacemacs key bindings use a leader key which is by default bound to
~SPC~ (space bar) in =vim= or =hybrid= editing styles and ~M-m~ in =emacs= ~SPC~ (space bar) in =vim= or =hybrid= editing styles and ~M-m~ in =emacs=
style. style.
@ -109,23 +109,23 @@ There is secondary leader key called the major-mode leader key which is
set to ~,~ by default. This key is a shortcut for ~SPC m~ set to ~,~ by default. This key is a shortcut for ~SPC m~
where all the major-mode specific commands are bound. where all the major-mode specific commands are bound.
*** Evil-tutor ** Evil-tutor
If you are willing to learn the Vim key bindings (highly recommended since If you are willing to learn the Vim key bindings (highly recommended since
you can benefit from them even in =emacs= style), press ~SPC h T~ you can benefit from them even in =emacs= style), press ~SPC h T~
to begin an Evil-adapted Vimtutor. to begin an Evil-adapted Vimtutor.
*** Universal argument ** Universal argument
In =vim= editing style the universal argument defaults to ~SPC u~ In =vim= editing style the universal argument defaults to ~SPC u~
instead of ~C-u~ because the latter is used to scroll up as in Vim. instead of ~C-u~ because the latter is used to scroll up as in Vim.
*** Configuration layers and Package discovery ** Configuration layers and Package discovery
By using =helm-spacemacs= with ~SPC f e h~ you can quickly search By using =helm-spacemacs= with ~SPC f e h~ you can quickly search
for a package and get the name of the layers using it. for a package and get the name of the layers using it.
You can also easily go to the =README.org= of a layer or go to the initialization You can also easily go to the =README.org= of a layer or go to the initialization
function of a package. function of a package.
*** Key bindings discovery ** Key bindings discovery
Thanks to [[https://github.com/justbur/emacs-which-key][which-key]], whenever a prefix command is pressed (like ~SPC~) Thanks to [[https://github.com/justbur/emacs-which-key][which-key]], whenever a prefix command is pressed (like ~SPC~)
a buffer appears after one second listing the possible keys for this prefix. a buffer appears after one second listing the possible keys for this prefix.
@ -144,7 +144,7 @@ type a pattern like this regular expression:
which would list all =buffer= related bindings. which would list all =buffer= related bindings.
*** Describe functions ** Describe functions
=Describe functions= are powerful Emacs introspection commands to get information =Describe functions= are powerful Emacs introspection commands to get information
about functions, variables, modes etc. These commands are bound thusly: about functions, variables, modes etc. These commands are bound thusly:
@ -155,5 +155,5 @@ about functions, variables, modes etc. These commands are bound thusly:
| ~SPC h d m~ | describe-mode | | ~SPC h d m~ | describe-mode |
| ~SPC h d v~ | describe-variable | | ~SPC h d v~ | describe-variable |
** How-To's * How-To's
Some quick =how-to's= are compiled in the [[file:HOWTOs.org][HOWTOs.org]] file. Some quick =how-to's= are compiled in the [[file:HOWTOs.org][HOWTOs.org]] file.

105
doc/VIMUSERS.org
View File

@ -1,37 +1,40 @@
* Migrating from vim :TOC@4: #+SETUPFILE: theme-readtheorg.setup
- [[#purpose-of-this-document][Purpose of this document]]
- [[#philosophy][Philosophy]] * Migrating from vim :TOC_4_org:noexport:
- [[#basic-orientation][Basic orientation]] - [[Purpose of this document][Purpose of this document]]
- [[#terms][Terms]] - [[Philosophy][Philosophy]]
- [[#modes-vs-states][Modes vs. States]] - [[Basic orientation][Basic orientation]]
- [[#layers][Layers]] - [[Terms][Terms]]
- [[#micro-states][Micro-states]] - [[Modes vs. States][Modes vs. States]]
- [[#keybinding-conventions][Keybinding conventions]] - [[Layers][Layers]]
- [[#running-commands][Running commands]] - [[Micro-states][Micro-states]]
- [[#buffer-and-window-management][Buffer and window management]] - [[Keybinding conventions][Keybinding conventions]]
- [[#buffers][Buffers]] - [[Running commands][Running commands]]
- [[#windows][Windows]] - [[Buffer and window management][Buffer and window management]]
- [[#files][Files]] - [[Buffers][Buffers]]
- [[#the-help-system][The Help System]] - [[Special buffers][Special buffers]]
- [[#exploring][Exploring]] - [[Windows][Windows]]
- [[#customization][Customization]] - [[Files][Files]]
- [[#the-spacemacs-file][The .spacemacs file]] - [[The Help System][The Help System]]
- [[#emacs-lisp][Emacs Lisp]] - [[Exploring][Exploring]]
- [[#variables][Variables]] - [[Customization][Customization]]
- [[#keybindings][Keybindings]] - [[The .spacemacs file][The .spacemacs file]]
- [[#functions][Functions]] - [[Emacs Lisp][Emacs Lisp]]
- [[#activating-a-layer][Activating a Layer]] - [[Variables][Variables]]
- [[#creating-a-layer][Creating a Layer]] - [[Keybindings][Keybindings]]
- [[#installing-a-single-package][Installing a single package]] - [[Functions][Functions]]
- [[#loading-packages][Loading packages]] - [[Activating a Layer][Activating a Layer]]
- [[#uninstalling-a-package][Uninstalling a package]] - [[Creating a Layer][Creating a Layer]]
- [[#common-tweaks][Common tweaks]] - [[Installing a single package][Installing a single package]]
- [[#changing-the-escape-key][Changing the escape key]] - [[Loading packages][Loading packages]]
- [[#changing-the-colorscheme][Changing the colorscheme]] - [[Uninstalling a package][Uninstalling a package]]
- [[#nohlsearch][Nohlsearch]] - [[Common tweaks][Common tweaks]]
- [[#sessions][Sessions]] - [[Changing the escape key][Changing the escape key]]
- [[#navigating-using-visual-lines][Navigating using visual lines]] - [[Changing the colorscheme][Changing the colorscheme]]
- [[#other-useful-links][Other useful links]] - [[Nohlsearch][Nohlsearch]]
- [[Sessions][Sessions]]
- [[Navigating using visual lines][Navigating using visual lines]]
- [[Other useful links][Other useful links]]
* Purpose of this document * Purpose of this document
This document is intended to supplement the Spacemacs documentation by bridging This document is intended to supplement the Spacemacs documentation by bridging
@ -51,11 +54,11 @@ read both files to fully understand Spacemacs.
vim and the nicer configuration language of Emacs. vim and the nicer configuration language of Emacs.
* Basic orientation * Basic orientation
*** Terms ** Terms
Spacemacs uses some different terminology than vim, which can cause confusion Spacemacs uses some different terminology than vim, which can cause confusion
for new users. This section attempts to clear up any confusion. for new users. This section attempts to clear up any confusion.
**** Modes vs. States *** Modes vs. States
In vim you have various editing modes like =insert mode= and =visual mode= to In vim you have various editing modes like =insert mode= and =visual mode= to
manipulate text. In Emacs, we have [[./DOCUMENTATION.org#states][states]]. These are equivalent to vim modes. manipulate text. In Emacs, we have [[./DOCUMENTATION.org#states][states]]. These are equivalent to vim modes.
For example, =evil-insert-state= is the same as =insert-mode= in vim. For example, =evil-insert-state= is the same as =insert-mode= in vim.
@ -69,7 +72,7 @@ generally a corresponding =major-mode= per filetype. An example of a =major-mode
=python-mode=, which provides python specific settings in python files. There is =python-mode=, which provides python specific settings in python files. There is
only one =major-mode= per buffer. only one =major-mode= per buffer.
**** Layers *** Layers
Spacemacs has the concept of layers. Layers are similar to vim plugins. They Spacemacs has the concept of layers. Layers are similar to vim plugins. They
provide new features to use in Spacemacs. However, layers are often comprised of provide new features to use in Spacemacs. However, layers are often comprised of
several packages that integrate well with each other. For example, the =python= several packages that integrate well with each other. For example, the =python=
@ -77,9 +80,9 @@ layer includes support for auto-completion, documentation look-up, tests, and
much more by using several different packages. This keeps you from thinking much more by using several different packages. This keeps you from thinking
about what packages to install, and instead worry about what features you want. about what packages to install, and instead worry about what features you want.
More information on layers can be found in the [[./VIMUSERS.org#customization][customization]] section and in the More information on layers can be found in the [[./VIMUSERS.org#customization][customization]] section and in the
[[./DOCUMENTATION.org#configuration-layers][documentation]]. There is also a more in-depth guide on writing layers [[LAYERS.org][here]]. [[./DOCUMENTATION.org#configuration-layers][documentation]]. There is also a more in-depth guide on writing layers [[file:LAYERS.org][here]].
**** Micro-states *** Micro-states
Spacemacs provides a special functionality called micro-states. Micro-states Spacemacs provides a special functionality called micro-states. Micro-states
allow similar commands to be run in succession without repeatedly pressing the allow similar commands to be run in succession without repeatedly pressing the
~<Leader>~ key. Micro-states are usually triggered by using a keybinding with the ~<Leader>~ key. Micro-states are usually triggered by using a keybinding with the
@ -91,7 +94,7 @@ bottom of your window. To exit a micro-state press ~q~.
[[file:img/spacemacs-scale-micro-state.png]] [[file:img/spacemacs-scale-micro-state.png]]
*** Keybinding conventions ** Keybinding conventions
Spacemacs uses ~SPC~ as its ~<Leader>~ key. This document will use ~SPC~ to refer to Spacemacs uses ~SPC~ as its ~<Leader>~ key. This document will use ~SPC~ to refer to
the ~<Leader>~ key. All keybindings are mnemonic and are organized under the the ~<Leader>~ key. All keybindings are mnemonic and are organized under the
~<Leader>~ key. For example, the keybindings for language-specific commands are ~<Leader>~ key. For example, the keybindings for language-specific commands are
@ -104,7 +107,7 @@ Spacemacs uses [[https://github.com/justbur/emacs-which-key][which-key]] to show
[[file:img/which-key.png]] [[file:img/which-key.png]]
*** Running commands ** Running commands
Emacs commands can be run using ~SPC :~. This will pop up a buffer using [[https://github.com/emacs-helm/helm][Helm]] Emacs commands can be run using ~SPC :~. This will pop up a buffer using [[https://github.com/emacs-helm/helm][Helm]]
which can be used to run any Emacs command. You can also run many ex commands which can be used to run any Emacs command. You can also run many ex commands
using ~:~, just like in vim. using ~:~, just like in vim.
@ -112,8 +115,8 @@ using ~:~, just like in vim.
Note: You can run Emacs interactive commands using ~:~, but you cannot run ex Note: You can run Emacs interactive commands using ~:~, but you cannot run ex
commands using ~SPC :~. commands using ~SPC :~.
*** Buffer and window management ** Buffer and window management
**** Buffers *** Buffers
Buffers in Emacs and vim are essentially the same. The keybindings for buffers Buffers in Emacs and vim are essentially the same. The keybindings for buffers
are located under the ~SPC b~ prefix. are located under the ~SPC b~ prefix.
@ -128,12 +131,12 @@ are located under the ~SPC b~ prefix.
| ~SPC b K~ | Kill all buffers except the current buffer. | | ~SPC b K~ | Kill all buffers except the current buffer. |
| ~SPC b .~ | Buffer micro-state. | | ~SPC b .~ | Buffer micro-state. |
***** Special buffers **** Special buffers
By default Emacs creates a lot of buffers that most people will never need, like By default Emacs creates a lot of buffers that most people will never need, like
=*Messages*=. Spacemacs automatically ignores these when using these =*Messages*=. Spacemacs automatically ignores these when using these
key bindings. More information can be found [[./DOCUMENTATION.org#special-buffers][here]]. key bindings. More information can be found [[./DOCUMENTATION.org#special-buffers][here]].
**** Windows *** Windows
Windows are like splits in vim. They are useful for editing multiple files at Windows are like splits in vim. They are useful for editing multiple files at
once. All window keybindings are under the ~SPC w~ prefix. once. All window keybindings are under the ~SPC w~ prefix.
@ -145,7 +148,7 @@ once. All window keybindings are under the ~SPC w~ prefix.
| ~SPC w H/J/K/L~ | Move the current window. | | ~SPC w H/J/K/L~ | Move the current window. |
| ~SPC w .~ | Window micro-state. | | ~SPC w .~ | Window micro-state. |
*** Files ** Files
All file commands in Spacemacs are available under the ~SPC f~ prefix. All file commands in Spacemacs are available under the ~SPC f~ prefix.
| Keybinding | Function | | Keybinding | Function |
@ -156,7 +159,7 @@ All file commands in Spacemacs are available under the ~SPC f~ prefix.
| ~:x~ | Save the current file and quit. | | ~:x~ | Save the current file and quit. |
| ~:e <file>~ | Open =<file>= | | ~:e <file>~ | Open =<file>= |
*** The Help System ** The Help System
Emacs has an extensive help system. All keybindings under the ~SPC h d~ prefix Emacs has an extensive help system. All keybindings under the ~SPC h d~ prefix
allow convenient access to the help system. The most important of these allow convenient access to the help system. The most important of these
keybindings are ~SPC h d f~ , ~SPC h d k~ , and ~SPC h d v~. There is also the keybindings are ~SPC h d f~ , ~SPC h d k~ , and ~SPC h d v~. There is also the
@ -172,7 +175,7 @@ keybindings are ~SPC h d f~ , ~SPC h d k~ , and ~SPC h d v~. There is also the
Whenever, you see weird behavior or want to know what something does, these Whenever, you see weird behavior or want to know what something does, these
functions are the first thing you should refer to. functions are the first thing you should refer to.
*** Exploring ** Exploring
There are a few ways to explore the functionality of Spacemacs. One is to read There are a few ways to explore the functionality of Spacemacs. One is to read
the [[https://github.com/syl20bnr/spacemacs][source code]] on Github. You can begin to feel your way around Emacs Lisp and the [[https://github.com/syl20bnr/spacemacs][source code]] on Github. You can begin to feel your way around Emacs Lisp and
how Spacemacs works this way. You can also use the following keybindings to how Spacemacs works this way. You can also use the following keybindings to
@ -360,7 +363,7 @@ to override the configuration of a package in another layer, use a
If a package is not available on MELPA, you must use a local package or a If a package is not available on MELPA, you must use a local package or a
package recipe. For more details see [[file:LAYERS.org#anatomy-of-a-layer][anatomy of a layer]]. package recipe. For more details see [[file:LAYERS.org#anatomy-of-a-layer][anatomy of a layer]].
Make sure you [[#activating-a-layer][add]] your layer to your =.spacemacs= file and restart to Make sure you [[Activating a Layer][add]] your layer to your =.spacemacs= file and restart to
activate it. activate it.
A detailed description of the loading process and how layers work can be found in A detailed description of the loading process and how layers work can be found in
@ -372,7 +375,7 @@ and don't want to maintain a whole layer. Spacemacs provides a variable in the
=dotspacemacs/layers= function in =.spacemacs= called =dotspacemacs/layers= function in =.spacemacs= called
=dotspacemacs-additional-packages=. Just add a package name to the list and it =dotspacemacs-additional-packages=. Just add a package name to the list and it
will be installed when you restart. Loading the package is covered in the next will be installed when you restart. Loading the package is covered in the next
[[#loading-packages][section]]. [[Loading packages][section]].
** Loading packages ** Loading packages
Ever wonder how Spacemacs can load over a 100 packages in just a few seconds? Ever wonder how Spacemacs can load over a 100 packages in just a few seconds?
@ -455,7 +458,7 @@ when you are not navigating between them. You can use ~SPC s c~ or ~:nohlsearch~
to disable search result highlighting. to disable search result highlighting.
To disable the result highlighting when it is not needed anymore automatically, To disable the result highlighting when it is not needed anymore automatically,
you can [[#uninstalling-a-package][uninstall]] the =evil-search-highlight-persist= package. you can [[Uninstalling a package][uninstall]] the =evil-search-highlight-persist= package.
*** Sessions *** Sessions
Spacemacs does not automatically restore your windows and buffers when you Spacemacs does not automatically restore your windows and buffers when you

9
doc/theme-readtheorg.setup Normal file
View File

@ -0,0 +1,9 @@
# -*- mode: org; -*-
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/readtheorg/css/htmlize.css"/>
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/readtheorg/css/readtheorg.css"/>
#+HTML_HEAD: <script src="https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js"></script>
#+HTML_HEAD: <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.js"></script>
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/readtheorg/js/readtheorg.js"></script>

16
layers/+config-files/ansible/README.org
View File

@ -2,17 +2,15 @@
[[file:img/ansible.png]] [[file:img/ansible.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer adds support for Ansible-flavored YAML buffers. This layer adds support for Ansible-flavored YAML buffers.
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -21,6 +19,6 @@ To use this contribution add it to your =~/.spacemacs=
* Key bindings * Key bindings
| Key Binding | Description | | Key Binding | Description |
|---------------+------------------------------------------| |-------------+------------------------------------------|
| ~SPC m a ?~ | looks up documentation using [[https://github.com/lunaryorn/ansible-doc.el][ansible-doc]] | | ~SPC m a ?~ | looks up documentation using [[https://github.com/lunaryorn/ansible-doc.el][ansible-doc]] |

16
layers/+config-files/dockerfile/README.org
View File

@ -2,17 +2,15 @@
[[file:img/docker.png]] [[file:img/docker.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer provides syntax highlighting and build functionality for Docker files. This layer provides syntax highlighting and build functionality for Docker files.
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -21,6 +19,6 @@ To use this contribution add it to your =~/.spacemacs=
* Key bindings * Key bindings
| Key Binding | Description | | Key Binding | Description |
|---------------+----------------------------------------------------| |-------------+----------------------------------------------------|
| ~SPC m c b~ | build current buffer via =dockerfile-build-buffer= | | ~SPC m c b~ | build current buffer via =dockerfile-build-buffer= |

13
layers/+config-files/puppet/README.org
View File

@ -2,21 +2,19 @@
[[file:img/puppet.png]] [[file:img/puppet.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Features][Features]]
- [[#key-bindings][Key bindings]] - [[Install][Install]]
- [[Key bindings][Key bindings]]
* Description * Description
This layer aims at providing support for the Puppet DSL using [[https://github.com/lunaryorn/puppet-mode][puppet-mode]]. This layer aims at providing support for the Puppet DSL using [[https://github.com/lunaryorn/puppet-mode][puppet-mode]].
* Features * Features
Puppetfile support via [[http://melpa.org/#/puppetfile-mode][puppetfile-mode]] Puppetfile support via [[http://melpa.org/#/puppetfile-mode][puppetfile-mode]]
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -24,7 +22,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key bindings * Key bindings
The following key bindings are available in Puppet Mode: The following key bindings are available in Puppet Mode:
| Key Binding | Description | | Key Binding | Description |

13
layers/+config-files/salt/README.org
View File

@ -2,9 +2,10 @@
[[file:img/saltstack.png]] [[file:img/saltstack.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[Key bindings][Key bindings]]
* Description * Description
This layer provides syntax highlighting for Saltstack files. This layer provides syntax highlighting for Saltstack files.
@ -18,6 +19,6 @@ To use this contribution add it to your =~/.spacemacs=
* Key bindings * Key bindings
| Key Binding | Description | | Key Binding | Description |
|---------------+----------------------------------------------| |-------------+----------------------------------------------|
| ~SPC m p b~ | mmm-mode parse buffer via =mmm-parse-buffer= | | ~SPC m p b~ | mmm-mode parse buffer via =mmm-parse-buffer= |

8
layers/+config-files/terraform/README.org
View File

@ -3,17 +3,15 @@
[[file:img/terraform.png]] [[file:img/terraform.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
* Description * Description
This layer provides syntax support for Terraform `.tf` files using This layer provides syntax support for Terraform `.tf` files using
[terraform-mode](https://github.com/syohex/emacs-terraform-mode). [terraform-mode](https://github.com/syohex/emacs-terraform-mode).
* Install * Install
To use this layer add it to your `~/.spacemacs` To use this layer add it to your `~/.spacemacs`
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp

44
layers/+email/gnus/README.org
View File

@ -2,13 +2,13 @@
[[file:img/gnus.gif]] [[file:img/gnus.gif]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#install][Install]] - [[Install][Install]]
- [[#basic-concepts][Basic Concepts]] - [[Basic Concepts][Basic Concepts]]
- [[#adding-news-sources][Adding news sources]] - [[Adding news sources][Adding news sources]]
- [[#configuring-gmail][Configuring gmail]] - [[Configuring gmail][Configuring gmail]]
- [[#org-mime-in-org-layer][Org MIME in Org layer]] - [[Org MIME in Org layer][Org MIME in Org layer]]
- [[#keybindings][Keybindings]] - [[Keybindings][Keybindings]]
* Install * Install
@ -44,7 +44,7 @@ following:
)) ))
#+END_SRC #+END_SRC
For adding RSS Feeds please see the [[#Keybindings][keybindings section]]. For adding RSS Feeds please see the [[Keybindings][keybindings section]].
* Configuring gmail * Configuring gmail
@ -85,10 +85,10 @@ To configure Gnus with gmail support you can add the following to your
Authentication for your gmail account is best stored in an =authinfo= or Authentication for your gmail account is best stored in an =authinfo= or
=authinfo.pgp= file. It must be of the form: =authinfo.pgp= file. It must be of the form:
#+BEGIN_SRC #+BEGIN_EXAMPLE
machine smtp.gmail.com login name@gmail.com password SUPER_SECRET_PASS machine smtp.gmail.com login name@gmail.com password SUPER_SECRET_PASS
machine imap.gmail.com login name@gmail.com port 993 password SUPER_SECRET_PASS machine imap.gmail.com login name@gmail.com port 993 password SUPER_SECRET_PASS
#+END_SRC #+END_EXAMPLE
If you use two-step verification the password has to be an [[https://support.google.com/accounts/answer/185833?hl=en][application specific If you use two-step verification the password has to be an [[https://support.google.com/accounts/answer/185833?hl=en][application specific
password]]. password]].
@ -108,15 +108,15 @@ Please see the [[http://www.gnus.org/manual.html][manual]] for a complete list.
Basic and Spacemacs specific keybindings can be found in the following table. Basic and Spacemacs specific keybindings can be found in the following table.
| Key Binding | Gnus mode - Description | | Key Binding | Gnus mode - Description |
|-------------+----------------------------------------------------------| |-------------+-----------------------------------------------------|
| ~SPC a g~ | Starts Gnus | | ~SPC a g~ | Starts Gnus |
| ~m~ | New Message | | ~m~ | New Message |
| ~G R~ | Group Buffer - Add RSS feed | | ~G R~ | Group Buffer - Add RSS feed |
| ~^~ | Open Server Buffer. Browse Newsgroups. | | ~^~ | Open Server Buffer. Browse Newsgroups. |
| ~T n~ | Group Buffer - new Topic | | ~T n~ | Group Buffer - new Topic |
| ~T m~ | Group Buffer - Move Group to Topic | | ~T m~ | Group Buffer - Move Group to Topic |
| ~K~ | Article Buffer - Previous article | | ~K~ | Article Buffer - Previous article |
| ~J~ | Article Buffer - Next article | | ~J~ | Article Buffer - Next article |
| ~RET~ | Summary Buffer(RSS) - Open article Link in browser | | ~RET~ | Summary Buffer(RSS) - Open article Link in browser |
| ~TAB~ | Summary Buffer(RSS) - Open article and switch to it | | ~TAB~ | Summary Buffer(RSS) - Open article and switch to it |

23
layers/+frameworks/django/README.org
View File

@ -1,23 +1,21 @@
#+TITLE: Python contribution layer for Spacemacs #+TITLE: Python contribution layer for Spacemacs
[[file:img/django.png]] [[file:img/django.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#fabric][Fabric]] - [[Fabric][Fabric]]
- [[#files][Files]] - [[Files][Files]]
- [[#interactive][Interactive]] - [[Interactive][Interactive]]
- [[#server][Server]] - [[Server][Server]]
- [[#southsyncdb][South/Syncdb]] - [[South/Syncdb][South/Syncdb]]
- [[#test][Test]] - [[Test][Test]]
* Description * Description
This layer adds support for the Python [[https://www.djangoproject.com/][Django]] framework via [[https://github.com/davidmiller/pony-mode][pony-mode]]. This layer adds support for the Python [[https://www.djangoproject.com/][Django]] framework via [[https://github.com/davidmiller/pony-mode][pony-mode]].
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -25,7 +23,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key Bindings * Key Bindings
Django related key bindings uses [[https://github.com/davidmiller/pony-mode][pony-mode]] and are behind the prefix ~SPC m j~. Django related key bindings uses [[https://github.com/davidmiller/pony-mode][pony-mode]] and are behind the prefix ~SPC m j~.
Configuration options for pony-mode are documented at Configuration options for pony-mode are documented at

41
layers/+frameworks/react/README.org
View File

@ -1,30 +1,27 @@
* React contribution layer for Spacemacs #+TITLE: React contribution layer for Spacemacs
#+CAPTION: logo [[file:img/react.png]]
[[img/react.png]] * Table of Contents :TOC_4_org:noexport:
- [[Description][Description]]
- [[Features][Features]]
- [[Install][Install]]
- [[Optional Configuration][Optional Configuration]]
- [[Key Bindings][Key Bindings]]
- [[js2-mode][js2-mode]]
- [[Folding (js2-mode)][Folding (js2-mode)]]
- [[Refactoring (js2-refactor)][Refactoring (js2-refactor)]]
- [[Formatting (web-beautify)][Formatting (web-beautify)]]
- [[Documentation (js-doc)][Documentation (js-doc)]]
- [[Auto-complete and documentation (tern)][Auto-complete and documentation (tern)]]
- [[JSON][JSON]]
** Table of Contents :TOC@4: * Description
- [[#react-contribution-layer-for-spacemacs][React contribution layer for Spacemacs]]
- [[#description][Description]]
- [[#features][Features]]
- [[#install][Install]]
- [[#optional-configuration][Optional Configuration]]
- [[#key-bindings][Key Bindings]]
- [[#js2-mode][js2-mode]]
- [[#folding-js2-mode][Folding (js2-mode)]]
- [[#refactoring-js2-refactor][Refactoring (js2-refactor)]]
- [[#formatting-web-beautify][Formatting (web-beautify)]]
- [[#documentation-js-doc][Documentation (js-doc)]]
- [[#auto-complete-and-documentation-tern][Auto-complete and documentation (tern)]]
- [[#json][JSON]]
** Description
ES6 and JSX ready configuration layer for React ES6 and JSX ready configuration layer for React
It will automatically recognize =.jsx= and =.react.js= files It will automatically recognize =.jsx= and =.react.js= files
*** Features ** Features
- on-the-fly syntax checking - on-the-fly syntax checking
- proper syntax highlight and indentation with jsx - proper syntax highlight and indentation with jsx
- ternjs turbocharged autocompletion as in js2-mode - ternjs turbocharged autocompletion as in js2-mode
@ -32,7 +29,7 @@ It will automatically recognize =.jsx= and =.react.js= files
- js2-refactor - js2-refactor
- js-doc - js-doc
** TODO Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
@ -86,7 +83,7 @@ Be sure to have the ~e4x~ option set to ~true~ on your ~.jsbeautifyrc~ here it i
} }
#+END_SRC #+END_SRC
** Optional Configuration * Optional Configuration
You may refer to the =web-mode= configuration for fine tuning the indenting behaviour. You may refer to the =web-mode= configuration for fine tuning the indenting behaviour.

19
layers/+frameworks/ruby-on-rails/README.org
View File

@ -2,21 +2,19 @@
[[file:img/ror.png]] [[file:img/ror.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#code-navigation][Code Navigation]] - [[Code Navigation][Code Navigation]]
- [[#refactoring][Refactoring]] - [[Refactoring][Refactoring]]
- [[#run-commands][RUN commands]] - [[RUN commands][RUN commands]]
- [[#ex-commands][Ex-commands]] - [[Ex-commands][Ex-commands]]
* Description * Description
This layer aims at providing support for the Ruby on Rails framework. This layer aims at providing support for the Ruby on Rails framework.
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -24,7 +22,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key bindings * Key bindings
** Code Navigation ** Code Navigation
| Key binding | Description | | Key binding | Description |

14
layers/+fun/emoji/README.org
View File

@ -2,15 +2,14 @@
#+HTML: :blue_heart::green_heart::heart::gift_heart::heartbeat::heartpulse::purple_heart::sparkling_heart::yellow_heart: #+HTML: :blue_heart::green_heart::heart::gift_heart::heartbeat::heartpulse::purple_heart::sparkling_heart::yellow_heart:
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#emoji-dedicated-buffer][Emoji dedicated buffer]] - [[Emoji dedicated buffer][Emoji dedicated buffer]]
* Description * Description
This layer adds support for Emoji emoticons from [[http://www.emoji-cheat-sheet.com/][emoji-cheat-sheet.com]]. This layer adds support for Emoji emoticons from [[http://www.emoji-cheat-sheet.com/][emoji-cheat-sheet.com]].
** Features: ** Features:
@ -20,7 +19,6 @@ 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]] - Completion of Emojis using [[https://github.com/dunn/company-emoji][company-emoji]]
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp

30
layers/+fun/games/README.org
View File

@ -2,15 +2,15 @@
[[file:img/games.png]] [[file:img/games.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#2048][2048]] - [[2048][2048]]
- [[#tetris][Tetris]] - [[Pacmacs][Pacmacs]]
- [[Tetris][Tetris]]
* Description * Description
This layer allows you to play evilified games in spacemacs. This layer allows you to play evilified games in spacemacs.
The games available now are: The games available now are:
@ -19,7 +19,6 @@ The games available now are:
- Tetris - Tetris
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -27,7 +26,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key bindings * Key bindings
To run a game: To run a game:
| Key Binding | Description | | Key Binding | Description |
@ -50,13 +48,13 @@ Possible helm actions:
** Pacmacs ** Pacmacs
| Key Binding | Description | | Key Binding | Description |
|-------------+-------------------| |-------------+-------------|
| ~h~ | Move left | | ~h~ | Move left |
| ~j~ | Move down | | ~j~ | Move down |
| ~k~ | Move up | | ~k~ | Move up |
| ~l~ | Move right | | ~l~ | Move right |
| | | | | |
** Tetris ** Tetris
| Key Binding | Description | | Key Binding | Description |

16
layers/+fun/xkcd/README.org
View File

@ -2,15 +2,14 @@
[[file:img/xkcd.png]] [[file:img/xkcd.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#tell-me-how-to-spawn-the-xkcd-greatness][Tell me how to spawn the xkcd greatness!!]] - [[Tell me how to spawn the xkcd greatness!!][Tell me how to spawn the xkcd greatness!!]]
- [[#okay-what-now][Okay, what now]] - [[Okay, what now][Okay, what now]]
* Description * Description
This layer adds a [[http://xkcd.com/][xkcd]] navigation mode using [[https://github.com/vibhavp/emacs-xkcd][emacs-xkcd]]. This layer adds a [[http://xkcd.com/][xkcd]] navigation mode using [[https://github.com/vibhavp/emacs-xkcd][emacs-xkcd]].
Features: Features:
@ -20,7 +19,6 @@ Features:
- Cache the comics in =.cache/xkcd= - Cache the comics in =.cache/xkcd=
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -28,7 +26,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key Bindings * Key Bindings
** Tell me how to spawn the xkcd greatness!! ** Tell me how to spawn the xkcd greatness!!
| Key Binding | Description | | Key Binding | Description |
@ -36,7 +33,6 @@ To use this contribution add it to your =~/.spacemacs=
| ~SPC a x~ | Open xkcd mode | | ~SPC a x~ | Open xkcd mode |
** Okay, what now ** Okay, what now
You can now move through the comics with these You can now move through the comics with these
| Key Binding | Description | | Key Binding | Description |

48
layers/+irc/erc/README.org
View File

@ -1,20 +1,18 @@
#+TITLE: ERC contribution layer for Spacemacs #+TITLE: ERC contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#os-x][OS X]] - [[OS X][OS X]]
- [[#social-graph][Social graph]] - [[Social graph][Social graph]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
Layer for [[http://www.emacswiki.org/emacs/ERC][ERC IRC chat]]. Layer for [[http://www.emacswiki.org/emacs/ERC][ERC IRC chat]].
* Features * Features
- Highlight nicks (using [[https://github.com/leathekd/erc-hl-nicks][erc-hl-nicks]]) - Highlight nicks (using [[https://github.com/leathekd/erc-hl-nicks][erc-hl-nicks]])
- Image inline support (using [[https://github.com/kidd/erc-image.el][erc-image]]) - Image inline support (using [[https://github.com/kidd/erc-image.el][erc-image]])
- Logging to ~/.emacs.d/.cache/erc-logs and ViewLogMode for viewing logs - Logging to ~/.emacs.d/.cache/erc-logs and ViewLogMode for viewing logs
@ -32,9 +30,7 @@ Layer for [[http://www.emacswiki.org/emacs/ERC][ERC IRC chat]].
using the =emoji= layer or having a proper font) :clap: using the =emoji= layer or having a proper font) :clap:
* Install * Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -42,29 +38,27 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
** OS X ** OS X
It's recommended to install the [[https://github.com/alloy/terminal-notifier][terminal-notifier gem]] so that you get It's recommended to install the [[https://github.com/alloy/terminal-notifier][terminal-notifier gem]] so that you get
notifications via the OS X Notification Center. notifications via the OS X Notification Center.
** Social graph ** Social graph
[[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] needs graphviz to be installed on your system. [[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] needs graphviz to be installed on your system.
* Key bindings * Key bindings
| Key Binding | Description | | Key Binding | Description |
|---------------+-------------------------------------------------------| |-------------+-------------------------------------------------------|
| ~SPC a i e~ | Starts ERC | | ~SPC a i e~ | Starts ERC |
| ~SPC a i E~ | Starts ERC via TLS/SSL | | ~SPC a i E~ | Starts ERC via TLS/SSL |
| ~SPC a i i~ | Switch to next active ERC buffer | | ~SPC a i i~ | Switch to next active ERC buffer |
| ~SPC m b~ | Switch between ERC buffers | | ~SPC m b~ | Switch between ERC buffers |
| ~SPC m d~ | Interactively input a user action and send it to IRC. | | ~SPC m d~ | Interactively input a user action and send it to IRC. |
| ~SPC m D~ | Draw Social Graph using [[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] | | ~SPC m D~ | Draw Social Graph using [[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] |
| ~SPC m j~ | Join a channel, executes the /join command | | ~SPC m j~ | Join a channel, executes the /join command |
| ~SPC m n~ | Run "/names #channel" in the current channel. | | ~SPC m n~ | Run "/names #channel" in the current channel. |
| ~SPC m l~ | Run the /list command | | ~SPC m l~ | Run the /list command |
| ~SPC m p~ | Part from the channel | | ~SPC m p~ | Part from the channel |
| ~SPC m q~ | Quit server | | ~SPC m q~ | Quit server |
*Note:* If you want to connect securely to an IRC server, you must run =erc-tls= *Note:* If you want to connect securely to an IRC server, you must run =erc-tls=
command on ~SPC a i E~ instead of the =erc= command. command on ~SPC a i E~ instead of the =erc= command.

55
layers/+irc/rcirc/README.org
View File

@ -2,30 +2,28 @@
[[file:img/irc.png]] [[file:img/irc.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#storing-the-credentials-in-your-dotfile][Storing the credentials in your dotfile]] - [[Storing the credentials in your dotfile][Storing the credentials in your dotfile]]
- [[#example][Example:]] - [[Example:][Example:]]
- [[#storing-the-credentials-in-your-dropbox][Storing the credentials in your Dropbox]] - [[Storing the credentials in your Dropbox][Storing the credentials in your Dropbox]]
- [[#example][Example:]] - [[Example:][Example:]]
- [[#storing-the-credentials-in-authinfo][Storing the credentials in authinfo]] - [[Storing the credentials in authinfo][Storing the credentials in authinfo]]
- [[#connecting-behind-a-znc-bouncer-and-storing-the-credentials-in-authinfo][Connecting behind a ZNC bouncer and storing the credentials in authinfo]] - [[Connecting behind a ZNC bouncer and storing the credentials in authinfo][Connecting behind a ZNC bouncer and storing the credentials in authinfo]]
- [[#disclaimer][Disclaimer]] - [[Disclaimer][Disclaimer]]
- [[#note][Note]] - [[Note][Note]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#rcirc-documentation][Rcirc documentation]] - [[Rcirc documentation][Rcirc documentation]]
* Description * Description
This layer provide support for [[http://www.gnu.org/software/emacs/manual/html_mono/rcirc.html][rcirc]] with optional support for authinfo This layer provide support for [[http://www.gnu.org/software/emacs/manual/html_mono/rcirc.html][rcirc]] with optional support for authinfo
and ZNC. and ZNC.
* Features * Features
- Store channel logs into =~/.emacs.d/.cache/rcirc-logs/<channel>= - Store channel logs into =~/.emacs.d/.cache/rcirc-logs/<channel>=
- Support for credentials stored in =~/.authinfo.gpg= (need to have gnutls) - Support for credentials stored in =~/.authinfo.gpg= (need to have gnutls)
- Support ZNC support (with optional =~/.authinfo.gpg=) - Support ZNC support (with optional =~/.authinfo.gpg=)
@ -35,9 +33,7 @@ and ZNC.
using the =emoji= layer or having a proper font) :clap: using the =emoji= layer or having a proper font) :clap:
* Install * Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -45,7 +41,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
** Configuration ** Configuration
There are several ways to configure rcirc supported by the layer: There are several ways to configure rcirc supported by the layer:
- By storing your credentials in =rcirc-server-alist= in your dotfile (not - By storing your credentials in =rcirc-server-alist= in your dotfile (not
secured) secured)
@ -55,7 +50,6 @@ There are several ways to configure rcirc supported by the layer:
- By using a ZNC bouncer _and_ storing your credentials (secured) - By using a ZNC bouncer _and_ storing your credentials (secured)
*** Storing the credentials in your dotfile *** Storing the credentials in your dotfile
You can store your servers configuration along with your credentials in the You can store your servers configuration along with your credentials in the
=dotspacemacs/user-config= of your dotfile. =dotspacemacs/user-config= of your dotfile.
@ -64,7 +58,6 @@ your dotfile is often stored in a public repository and is not crypted. This
is convenient but not recommended. is convenient but not recommended.
**** Example: **** Example:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq rcirc-server-alist (setq rcirc-server-alist
'(("irc.freenode.net" '(("irc.freenode.net"
@ -75,7 +68,6 @@ is convenient but not recommended.
#+END_SRC #+END_SRC
*** Storing the credentials in your Dropbox *** Storing the credentials in your Dropbox
You can store your servers configuration along with your credentials in You can store your servers configuration along with your credentials in
your dropbox in the file =~/Dropbox/emacs/pinit-rcirc.el=. your dropbox in the file =~/Dropbox/emacs/pinit-rcirc.el=.
@ -86,7 +78,6 @@ of the file containing your credentials. This is convenient but not
recommended. recommended.
**** Example: **** Example:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq rcirc-server-alist (setq rcirc-server-alist
'(("irc.freenode.net" '(("irc.freenode.net"
@ -97,7 +88,6 @@ recommended.
#+END_SRC #+END_SRC
*** Storing the credentials in authinfo *** Storing the credentials in authinfo
This method is considered secured and is the recommended way to configure This method is considered secured and is the recommended way to configure
rcirc. rcirc.
@ -110,9 +100,10 @@ rcirc.
#+END_SRC #+END_SRC
2) In your =~/.authinfo.gpg= file store your credentials like this: 2) In your =~/.authinfo.gpg= file store your credentials like this:
#+BEGIN_SRC
#+BEGIN_EXAMPLE
machine irc.freenode.net port nickserv user <user> password <passwd> machine irc.freenode.net port nickserv user <user> password <passwd>
#+END_SRC #+END_EXAMPLE
3) At last you need to provide your servers configuration in the 3) At last you need to provide your servers configuration in the
=dotspacemacs/user-config= function of your dotfile: =dotspacemacs/user-config= function of your dotfile:
@ -126,7 +117,6 @@ rcirc.
#+END_SRC #+END_SRC
*** Connecting behind a ZNC bouncer and storing the credentials in authinfo *** Connecting behind a ZNC bouncer and storing the credentials in authinfo
This methods is also secured since it uses authinfo _but_ you must secure your This methods is also secured since it uses authinfo _but_ you must secure your
ZNC server configuration as well! ZNC server configuration as well!
@ -152,11 +142,11 @@ For now authinfo is mandatory to use the ZNC configuration.
#+END_SRC #+END_SRC
2) In your =~/.authinfo.gpg= file store your credentials like this: 2) In your =~/.authinfo.gpg= file store your credentials like this:
#+BEGIN_SRC #+BEGIN_EXAMPLE
machine freenode.spacemacsserver.me port irc user spacemacs_user/freenode password ZNC_PASSWORD machine freenode.spacemacsserver.me port irc user spacemacs_user/freenode password ZNC_PASSWORD
machine geekshed.spacemacsserver.me port irc user spacemacs_user/geekshed password ZNC_PASSWORD machine geekshed.spacemacsserver.me port irc user spacemacs_user/geekshed password ZNC_PASSWORD
#+END_SRC #+END_EXAMPLE
*Important* =port= must be set to =irc=. This is a convention of the layer to *Important* =port= must be set to =irc=. This is a convention of the layer to
retrieve the credentials for the ZNC configuration. retrieve the credentials for the ZNC configuration.
@ -195,5 +185,4 @@ In normal state:
| ~C-k~ | previous item in history | | ~C-k~ | previous item in history |
* Rcirc documentation * Rcirc documentation
The rcirc documentation can be found [[http://www.gnu.org/software/emacs/manual/html_mono/rcirc.html][here]]. The rcirc documentation can be found [[http://www.gnu.org/software/emacs/manual/html_mono/rcirc.html][here]].

77
layers/+keyboard-layouts/bepo/README.org
View File

@ -1,31 +1,30 @@
* bepo contribution layer for Spacemacs #+TITLE: bepo contribution layer for Spacemacs
#+CAPTION: logo #+CAPTION: logo
[[file:img/bepo.png]] [[file:img/bepo.png]]
** Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#bepo-contribution-layer-for-spacemacs][bepo contribution layer for Spacemacs]] - [[Description][Description]]
- [[#description][Description]] - [[Mapping][Mapping]]
- [[#mapping][Mapping]] - [[Supported modes/packages/layer][Supported modes/packages/layer]]
- [[#supported-modespackageslayer][Supported modes/packages/layer]] - [[Install][Install]]
- [[#install][Install]] - [[Key bindings][Key bindings]]
- [[#key-bindings][Key bindings]] - [[company][company]]
- [[#company][company]] - [[evil][evil]]
- [[#evil][evil]] - [[evil-escape][evil-escape]]
- [[#evil-escape][evil-escape]] - [[evil-surround][evil-surround]]
- [[#evil-surround][evil-surround]] - [[evil-window][evil-window]]
- [[#evil-window][evil-window]] - [[helm][helm]]
- [[#helm][helm]] - [[magit][magit]]
- [[#magit][magit]] - [[neotree][neotree]]
- [[#neotree][neotree]] - [[org][org]]
- [[#org][org]] - [[ranger][ranger]]
- [[#ranger][ranger]] - [[spacemacs-specific][spacemacs-specific]]
- [[#spacemacs-specific][spacemacs-specific]] - [[Contributors][Contributors]]
- [[#contributors][Contributors]] - [[Sources][Sources]]
- [[#sources][Sources]]
** Description * Description
This layer change the key bindings in spacemacs to be compatible with the [[http://bepo.fr/][bepo]] This layer change the key bindings in spacemacs to be compatible with the [[http://bepo.fr/][bepo]]
keyboard layout. =bepo= is a keyboard layout optimized for the French language. keyboard layout. =bepo= is a keyboard layout optimized for the French language.
This package first switch traditional ~hjkl~ movement keys with ~ctsr~, and then This package first switch traditional ~hjkl~ movement keys with ~ctsr~, and then
@ -33,7 +32,7 @@ try to correct the bugs induced by these changes in other modes/packages.
[[file:img/keymap.png]] [[file:img/keymap.png]]
** Mapping * Mapping
The mapping correction is the one proposed for vim on the bepo's official [[http://bepo.fr/wiki/Vim#Principe][wiki]]. The mapping correction is the one proposed for vim on the bepo's official [[http://bepo.fr/wiki/Vim#Principe][wiki]].
This layer tries to do the following changes when the following characters are This layer tries to do the following changes when the following characters are
used for *doing a movement*: used for *doing a movement*:
@ -95,7 +94,7 @@ Note: One difference exists with the wiki version: the ~w~ is *not* remapped to
~C-w~ to avoid having to change its meaning in other modes. Spacemacs provides ~C-w~ to avoid having to change its meaning in other modes. Spacemacs provides
already a ~SPC w~ key binding for working with windows. already a ~SPC w~ key binding for working with windows.
** Supported modes/packages/layer * Supported modes/packages/layer
- avy - avy
- company - company
- evil - evil
@ -109,18 +108,18 @@ already a ~SPC w~ key binding for working with windows.
- ranger - ranger
- spacemacs - spacemacs
** Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+begin_src emacs-lisp #+begin_src emacs-lisp
(setq-default dotspacemacs-configuration-layers '(bepo)) (setq-default dotspacemacs-configuration-layers '(bepo))
#+end_src #+end_src
** Key bindings * Key bindings
Thanks to `wich-keys`, you shouldn't probably have to go through this list, the Thanks to `wich-keys`, you shouldn't probably have to go through this list, the
keys being shown after a small delay following a keypress. keys being shown after a small delay following a keypress.
*** company ** company
|-------------+----------------------------+--------------------| |-------------+----------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+----------------------------+--------------------| |-------------+----------------------------+--------------------|
@ -129,7 +128,7 @@ keys being shown after a small delay following a keypress.
| ~C-r~ | Company complete selection | ~C-l~ | | ~C-r~ | Company complete selection | ~C-l~ |
|-------------+----------------------------+--------------------| |-------------+----------------------------+--------------------|
*** evil ** evil
|-------------+----------------------------+--------------------| |-------------+----------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+----------------------------+--------------------| |-------------+----------------------------+--------------------|
@ -160,21 +159,21 @@ keys being shown after a small delay following a keypress.
| ~«~ | Unindent | ~<~ | | ~«~ | Unindent | ~<~ |
|-------------+----------------------------+--------------------| |-------------+----------------------------+--------------------|
*** evil-escape ** evil-escape
|-------------+-------------+--------------------| |-------------+-------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+-------------+--------------------| |-------------+-------------+--------------------|
| ~gq~ | Escape | ~fd~ | | ~gq~ | Escape | ~fd~ |
|-------------+-------------+--------------------| |-------------+-------------+--------------------|
*** evil-surround ** evil-surround
|-------------+-------------------------------+--------------------| |-------------+-------------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+-------------------------------+--------------------| |-------------+-------------------------------+--------------------|
| ~k~ | Evil-surround functionnalites | ~s~ | | ~k~ | Evil-surround functionnalites | ~s~ |
|-------------+-------------------------------+--------------------| |-------------+-------------------------------+--------------------|
*** evil-window ** evil-window
|-------------+------------------------------+--------------------| |-------------+------------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+------------------------------+--------------------| |-------------+------------------------------+--------------------|
@ -200,7 +199,7 @@ keys being shown after a small delay following a keypress.
| ~SPC é~ | Alias for ~SPC w~ | ~SPC w~ | | ~SPC é~ | Alias for ~SPC w~ | ~SPC w~ |
|-------------+------------------------------+--------------------| |-------------+------------------------------+--------------------|
*** helm ** helm
|-------------+---------------------------------------+--------------------| |-------------+---------------------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+---------------------------------------+--------------------| |-------------+---------------------------------------+--------------------|
@ -211,7 +210,7 @@ keys being shown after a small delay following a keypress.
| ~C-k~ | Helm find files run grep | ~C-s~ | | ~C-k~ | Helm find files run grep | ~C-s~ |
|-------------+---------------------------------------+--------------------| |-------------+---------------------------------------+--------------------|
*** magit ** magit
|-------------+----------------+--------------------| |-------------+----------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+----------------+--------------------| |-------------+----------------+--------------------|
@ -223,7 +222,7 @@ keys being shown after a small delay following a keypress.
| ~h~ | Discard change | ~k~ | | ~h~ | Discard change | ~k~ |
|-------------+----------------+--------------------| |-------------+----------------+--------------------|
*** neotree ** neotree
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
@ -243,7 +242,7 @@ keys being shown after a small delay following a keypress.
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
| ~H~ | Neotree change root | ~R~ | | ~H~ | Neotree change root | ~R~ |
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
*** org ** org
|---------------+--------------------------------------| |---------------+--------------------------------------|
| Key Binding | Description | | Key Binding | Description |
|---------------+--------------------------------------| |---------------+--------------------------------------|
@ -310,7 +309,7 @@ keys being shown after a small delay following a keypress.
| ~SPC »~ | Org metaright | | ~SPC »~ | Org metaright |
|---------------+--------------------------------------| |---------------+--------------------------------------|
*** ranger ** ranger
|-------------+---------------------+--------------------| |-------------+---------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+---------------------+--------------------| |-------------+---------------------+--------------------|
@ -328,7 +327,7 @@ keys being shown after a small delay following a keypress.
| ~K~ | Eshell | ~S~ | | ~K~ | Eshell | ~S~ |
|-------------+---------------------+--------------------| |-------------+---------------------+--------------------|
*** spacemacs-specific ** spacemacs-specific
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
| Key Binding | Description | Replace/equivalent | | Key Binding | Description | Replace/equivalent |
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
@ -348,9 +347,9 @@ keys being shown after a small delay following a keypress.
| ~SPC i Yw~ | Auto yasnippet persist snippet | ~SPC i Sw~ | | ~SPC i Yw~ | Auto yasnippet persist snippet | ~SPC i Sw~ |
|-------------+--------------------------------------+--------------------| |-------------+--------------------------------------+--------------------|
** Contributors * Contributors
- Fabien Dubosson - Fabien Dubosson
** Sources * Sources
The bepo logo and the keymap image come from the [[http://bepo.fr/][bepo]] official website. They are The bepo logo and the keymap image come from the [[http://bepo.fr/][bepo]] official website. They are
licensed under the [[http://creativecommons.org/licenses/by-sa/3.0/deed.en][CC-BY-SA]]. licensed under the [[http://creativecommons.org/licenses/by-sa/3.0/deed.en][CC-BY-SA]].

14
layers/+lang/agda/README.org
View File

@ -1,12 +1,12 @@
#+TITLE: Agda contribution layer for Spacemacs #+TITLE: Agda contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#some-features][Some features:]] - [[Some features:][Some features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#agda][Agda]] - [[Agda][Agda]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php][Agda]] programming language. This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php][Agda]] programming language.

15
layers/+lang/asciidoc/README.org
View File

@ -1,12 +1,12 @@
#+TITLE: Asciidoc contribution layer for Spacemacs #+TITLE: Asciidoc contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#feature][Feature]] - [[Feature][Feature]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#element-insertion][Element insertion]] - [[Element insertion][Element insertion]]
- [[#promotion-demotion][Promotion, Demotion]] - [[Promotion, Demotion][Promotion, Demotion]]
* Description * Description
This layer adds [[https://asciidoctor.org][AsciiDoc]] markup language support to Spacemacs. This layer adds [[https://asciidoctor.org][AsciiDoc]] markup language support to Spacemacs.
@ -23,7 +23,6 @@ To use this contribution add it to your `~/.spacemacs`
#+END_SRC #+END_SRC
* Key bindings * Key bindings
** Element insertion ** Element insertion
| Key Binding | Description | | Key Binding | Description |

10
layers/+lang/autohotkey/README.org
View File

@ -2,11 +2,11 @@
[[file:img/ahk.png]] [[file:img/ahk.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description

28
layers/+lang/c-c++/README.org
View File

@ -3,24 +3,22 @@
[[file:img/ccpp.jpg]] [[file:img/ccpp.jpg]]
[[file:img/cmake.png]] [[file:img/cmake.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#default-mode-for-header-files][Default mode for header files]] - [[Default mode for header files][Default mode for header files]]
- [[#enable-clang-support][Enable Clang support]] - [[Enable Clang support][Enable Clang support]]
- [[#clang-format][clang-format]] - [[clang-format][clang-format]]
- [[#company-clang-and-flycheck][Company-clang and flycheck]] - [[Company-clang and flycheck][Company-clang and flycheck]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description
This layer adds configuration for C/C++ language as well support for [[http://www.cmake.org/][CMake]] This layer adds configuration for C/C++ language as well support for [[http://www.cmake.org/][CMake]]
scripts. scripts.
* Features * Features
- Support syntax checking via flycheck with Clang. - Support syntax checking via flycheck with Clang.
- Support for disassembly of code with [[https://github.com/jart/disaster][disaster]]. - Support for disassembly of code with [[https://github.com/jart/disaster][disaster]].
- Support code reformatting with [[http://clang.llvm.org/docs/ClangFormat.html][clang-format]]. - Support code reformatting with [[http://clang.llvm.org/docs/ClangFormat.html][clang-format]].
@ -31,9 +29,7 @@ scripts.
demonstration of refactoring features. (when =semantic= layer is included) demonstration of refactoring features. (when =semantic= layer is included)
* Install * Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -43,7 +39,6 @@ To use this contribution add it to your =~/.spacemacs=
*Note:* [[https://github.com/tuhdo/semantic-refactor][semantic-refactor]] is only available for Emacs 24.4+ *Note:* [[https://github.com/tuhdo/semantic-refactor][semantic-refactor]] is only available for Emacs 24.4+
** Default mode for header files ** Default mode for header files
By default header files are opened in =c-mode=, you can open them in =c++-mode= By default header files are opened in =c-mode=, you can open them in =c++-mode=
by setting the variable =c-c++-default-mode-for-headers= to =c++-mode=. by setting the variable =c-c++-default-mode-for-headers= to =c++-mode=.
@ -58,7 +53,6 @@ variable at the root of your project. More info on directory local variables
can be found in the [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Directory-Local-Variables.html][dir-locals]]. can be found in the [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Directory-Local-Variables.html][dir-locals]].
** Enable Clang support ** Enable Clang support
To enable Clang support set the layer variable =c-c++-enable-clang-support= To enable Clang support set the layer variable =c-c++-enable-clang-support=
to =t= in the dotfile: to =t= in the dotfile:
@ -68,7 +62,6 @@ to =t= in the dotfile:
#+END_SRC #+END_SRC
*** clang-format *** clang-format
[[http://clang.llvm.org/docs/ClangFormat.html][clang-format]] allows reformatting either a selected region of code [[http://clang.llvm.org/docs/ClangFormat.html][clang-format]] allows reformatting either a selected region of code
(=clang-format-region=) or a whole buffer (=clang-format-buffer=) to make it (=clang-format-region=) or a whole buffer (=clang-format-buffer=) to make it
conform to a style defined in a =.clang-format= file. This file is either conform to a style defined in a =.clang-format= file. This file is either
@ -89,7 +82,6 @@ particular mode or all modes in your =dotspacemacs/user-config= (within your
#+END_SRC #+END_SRC
*** Company-clang and flycheck *** Company-clang and flycheck
This layer adds some fancy improvements to =company-clang=. This layer adds some fancy improvements to =company-clang=.
It includes a hook to load a projects =.clang_complete= file, which is It includes a hook to load a projects =.clang_complete= file, which is
just a text file with one clang flag per line, a format also used by just a text file with one clang flag per line, a format also used by

52
layers/+lang/clojure/README.org
View File

@ -2,32 +2,32 @@
[[file:img/clojure.png]] [[file:img/cider.png]] [[file:img/clojure.png]] [[file:img/cider.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#pretty-symbols][Pretty Symbols]] - [[Pretty Symbols][Pretty Symbols]]
- [[#cider-and-clj-refactor][CIDER and clj-refactor]] - [[CIDER and clj-refactor][CIDER and clj-refactor]]
- [[#quick-start-with-boot][Quick Start with boot]] - [[Quick Start with boot][Quick Start with boot]]
- [[#quick-start-with-lein][Quick Start with lein]] - [[Quick Start with lein][Quick Start with lein]]
- [[#more-details][More details]] - [[More details][More details]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#working-with-clojure-files-barfage-slurpage--more][Working with clojure files (barfage, slurpage & more)]] - [[Working with clojure files (barfage, slurpage & more)][Working with clojure files (barfage, slurpage & more)]]
- [[#leader][Leader]] - [[Leader][Leader]]
- [[#documentation][Documentation]] - [[Documentation][Documentation]]
- [[#evaluation][Evaluation]] - [[Evaluation][Evaluation]]
- [[#goto][Goto]] - [[Goto][Goto]]
- [[#repl][REPL]] - [[REPL][REPL]]
- [[#tests][Tests]] - [[Tests][Tests]]
- [[#toggles][Toggles]] - [[Toggles][Toggles]]
- [[#debugging][Debugging]] - [[Debugging][Debugging]]
- [[#refactoring][Refactoring]] - [[Refactoring][Refactoring]]
- [[#reformatting][Reformatting]] - [[Reformatting][Reformatting]]
- [[#cider-buffers][CIDER Buffers]] - [[CIDER Buffers][CIDER Buffers]]
- [[#stacktrace-mode][stacktrace-mode]] - [[stacktrace-mode][stacktrace-mode]]
- [[#inspector-mode][inspector-mode]] - [[inspector-mode][inspector-mode]]
- [[#test-report-mode][test-report-mode]] - [[test-report-mode][test-report-mode]]
* Description * Description

24
layers/+lang/common-lisp/README.org
View File

@ -2,18 +2,18 @@
[[file:img/slime.png]] [[file:img/slime.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#working-with-lisp-files-barfage-slurpage--more][Working with lisp files (barfage, slurpage & more)]] - [[Working with lisp files (barfage, slurpage & more)][Working with lisp files (barfage, slurpage & more)]]
- [[#leader][Leader]] - [[Leader][Leader]]
- [[#help][Help]] - [[Help][Help]]
- [[#evaluation][Evaluation]] - [[Evaluation][Evaluation]]
- [[#repl][REPL]] - [[REPL][REPL]]
- [[#compile][Compile]] - [[Compile][Compile]]
- [[#navigation][Navigation]] - [[Navigation][Navigation]]
- [[#macroexpansion][Macroexpansion]] - [[Macroexpansion][Macroexpansion]]
* Description * Description
A Spacemacs contribution layer providing Common Lisp support via [[https://github.com/slime/slime][SLIME]]. A Spacemacs contribution layer providing Common Lisp support via [[https://github.com/slime/slime][SLIME]].

36
layers/+lang/csharp/README.org
View File

@ -2,24 +2,24 @@
[[file:img/csharp.png]] [[file:img/dotnet.png]] [[file:img/csharp.png]] [[file:img/dotnet.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#packages-included][Packages Included]] - [[Packages Included][Packages Included]]
- [[#install][Install]] - [[Install][Install]]
- [[#prerequisites][Prerequisites]] - [[Prerequisites][Prerequisites]]
- [[#aspnet-5][ASP.NET 5]] - [[ASP.NET 5][ASP.NET 5]]
- [[#curl][curl]] - [[curl][curl]]
- [[#omnisharp-server][Omnisharp server]] - [[Omnisharp server][Omnisharp server]]
- [[#caveats][Caveats]] - [[Caveats][Caveats]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#compilation][Compilation]] - [[Compilation][Compilation]]
- [[#filesolutionproject-manipulation][File/Solution/Project manipulation]] - [[File/Solution/Project manipulation][File/Solution/Project manipulation]]
- [[#navigation][Navigation]] - [[Navigation][Navigation]]
- [[#helpers-documentation-info][Helpers (documentation, info)]] - [[Helpers (documentation, info)][Helpers (documentation, info)]]
- [[#refactoring][Refactoring]] - [[Refactoring][Refactoring]]
- [[#omnisharp-server-interaction][OmniSharp server interaction]] - [[OmniSharp server interaction][OmniSharp server interaction]]
- [[#tests][Tests]] - [[Tests][Tests]]
- [[#code-manipulation][Code manipulation]] - [[Code manipulation][Code manipulation]]
* Description * Description

13
layers/+lang/d/README.org
View File

@ -2,24 +2,17 @@
[[file:img/dlogo.png]] [[file:img/dlogo.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]]
* Description * Description
This simple layer adds support for the [[http://dlang.org/][D language]]. 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=. It adds =d-mode= as well as integrating it with =auto-completion= and =syntax-checking=.
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(d)) (setq-default dotspacemacs-configuration-layers '(d))
#+END_SRC #+END_SRC
* Key Bindings
None for now.

28
layers/+lang/elixir/README.org
View File

@ -2,20 +2,20 @@
[[file:img/elixir.png]] with [[file:img/alchemist.png]] [[file:img/elixir.png]] with [[file:img/alchemist.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#refcard][Refcard]] - [[Refcard][Refcard]]
- [[#help][Help]] - [[Help][Help]]
- [[#mix][Mix]] - [[Mix][Mix]]
- [[#project][Project]] - [[Project][Project]]
- [[#evaluation-in-place][Evaluation in place]] - [[Evaluation in place][Evaluation in place]]
- [[#repl-interactions][REPL interactions]] - [[REPL interactions][REPL interactions]]
- [[#tests][Tests]] - [[Tests][Tests]]
- [[#compile][Compile]] - [[Compile][Compile]]
- [[#execute][Execute]] - [[Execute][Execute]]
- [[#code-definition-jump][Code Definition Jump]] - [[Code Definition Jump][Code Definition Jump]]
* Description * Description

38
layers/+lang/elm/README.org
View File

@ -2,25 +2,25 @@
[[file:img/elm.png]] [[file:img/elm.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#elm-platform][Elm Platform]] - [[Elm Platform][Elm Platform]]
- [[#os-x-and-windows-installers][OS X and Windows installers]] - [[OS X and Windows installers][OS X and Windows installers]]
- [[#universal-installer-using-npm][Universal installer using npm]] - [[Universal installer using npm][Universal installer using npm]]
- [[#source-code][Source code]] - [[Source code][Source code]]
- [[#elm-mode][elm-mode]] - [[elm-mode][elm-mode]]
- [[#elm-oracle][elm-oracle]] - [[elm-oracle][elm-oracle]]
- [[#basic-usage-tips][Basic usage tips]] - [[Basic usage tips][Basic usage tips]]
- [[#compilation][Compilation]] - [[Compilation][Compilation]]
- [[#reactor][Reactor]] - [[Reactor][Reactor]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#elm-make][elm-make]] - [[elm-make][elm-make]]
- [[#elm-repl][elm-repl]] - [[elm-repl][elm-repl]]
- [[#elm-reactor][elm-reactor]] - [[elm-reactor][elm-reactor]]
- [[#elm-package][elm-package]] - [[elm-package][elm-package]]
- [[#package-list-buffer][package list buffer]] - [[package list buffer][package list buffer]]
- [[#elm-oracle][elm-oracle]] - [[elm-oracle][elm-oracle]]
* Description * Description
This layer adds support for [[http://elm-lang.org][Elm]]. This layer adds support for [[http://elm-lang.org][Elm]].

16
layers/+lang/emacs-lisp/README.org
View File

@ -2,14 +2,14 @@
[[file:img/emacs-lisp.png]] [[file:img/emacs-lisp.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#auto-compile][Auto-compile]] - [[Auto-compile][Auto-compile]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#working-with-lisp-files-barfage-slurpage--more][Working with lisp files (barfage, slurpage & more)]] - [[Working with lisp files (barfage, slurpage & more)][Working with lisp files (barfage, slurpage & more)]]
- [[#leader][Leader]] - [[Leader][Leader]]
- [[#srefactor][srefactor]] - [[srefactor][srefactor]]
* Description * Description
This layer gathers all the configuration related to emacs-lisp. This should This layer gathers all the configuration related to emacs-lisp. This should

6
layers/+lang/erlang/README.org
View File

@ -2,9 +2,9 @@
[[file:img/erlang.png]] [[file:img/erlang.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
* Description * Description

12
layers/+lang/ess/README.org
View File

@ -2,12 +2,12 @@
[[file:img/r.jpg]] [[file:img/r.jpg]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#inferior-repl-process][Inferior REPL process]] - [[Inferior REPL process][Inferior REPL process]]
- [[#helpers][Helpers]] - [[Helpers][Helpers]]
- [[#options][Options]] - [[Options][Options]]
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=

12
layers/+lang/fsharp/README.org
View File

@ -2,12 +2,12 @@
[[file:img/fsharp.png]] [[file:img/fsharp.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#packages-included][Packages Included]] - [[Packages Included][Packages Included]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#repl][REPL]] - [[REPL][REPL]]
* Description * Description

38
layers/+lang/go/README.org
View File

@ -2,17 +2,17 @@
[[file:img/go.png]] [[file:img/go.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#pre-requisites][Pre-requisites]] - [[Pre-requisites][Pre-requisites]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#formatting][Formatting]] - [[Formatting][Formatting]]
- [[#working-with-go][Working with Go]] - [[Working with Go][Working with Go]]
- [[#go-commands-start-with-m][Go commands (start with =m=):]] - [[Go commands (start with =m=):][Go commands (start with =m=):]]
- [[#go-oracle][Go Oracle]] - [[Go Oracle][Go Oracle]]
* Description * Description
This layer adds extensive support for go. This layer adds extensive support for go.
@ -23,7 +23,6 @@ This layer adds extensive support for go.
- Source analysis using [[http://golang.org/s/oracle-user-manual][go-oracle]] - Source analysis using [[http://golang.org/s/oracle-user-manual][go-oracle]]
* Install * Install
** Pre-requisites ** Pre-requisites
You will need =gocode= and =godef=: You will need =gocode= and =godef=:
@ -48,22 +47,27 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Configuration * Configuration
** Formatting ** Formatting
By default, go buffers are run through =gofmt= on save. To use a different By default, go buffers are run through =gofmt= on save. To use a different
formatter, set the value of =gofmt-command=, e.g. formatter, set the value of =gofmt-command=, e.g.
#+begin_src emacs-lisp #+begin_src emacs-lisp
(setq gofmt-command "goimports") (setq gofmt-command "goimports")
or #+end_src
or
#+begin_src emacs-lisp
(go :variables gofmt-command "goimports") (go :variables gofmt-command "goimports")
#+end_src #+end_src
#
If you're using =gocheck= in your project you can use the =go-use-gocheck-for-testing= variable to enable suite testing and to get single function testing to work. If you're using =gocheck= in your project you can use the
=go-use-gocheck-for-testing= variable to enable suite testing and to get single
function testing to work.
* Working with Go * Working with Go
** Go commands (start with =m=): ** Go commands (start with =m=):
| Key Binding | Description | | Key Binding | Description |
|-------------+---------------------------------------------------------------------------------------| |-------------+---------------------------------------------------------------------------------------|
| ~SPC m h h~ | godoc at point | | ~SPC m h h~ | godoc at point |

52
layers/+lang/haskell/README.org
View File

@ -2,32 +2,32 @@
[[file:img/haskell.png]] [[file:img/haskell.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#dependencies][Dependencies]] - [[Dependencies][Dependencies]]
- [[#setup-path][Setup PATH]] - [[Setup PATH][Setup PATH]]
- [[#ghc-mod-support][ghc-mod support]] - [[ghc-mod support][ghc-mod support]]
- [[#stack-users][Stack users]] - [[Stack users][Stack users]]
- [[#optional-extras][Optional extras]] - [[Optional extras][Optional extras]]
- [[#ghci-ng-support][GHCi-ng support]] - [[GHCi-ng support][GHCi-ng support]]
- [[#stack-users][Stack users]] - [[Stack users][Stack users]]
- [[#ghc-mod-users][ghc-mod users]] - [[ghc-mod users][ghc-mod users]]
- [[#structured-haskell-mode][structured-haskell-mode]] - [[structured-haskell-mode][structured-haskell-mode]]
- [[#hindent][hindent]] - [[hindent][hindent]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#documentation][Documentation]] - [[Documentation][Documentation]]
- [[#debug][Debug]] - [[Debug][Debug]]
- [[#repl][REPL]] - [[REPL][REPL]]
- [[#cabal-commands][Cabal commands]] - [[Cabal commands][Cabal commands]]
- [[#cabal-files][Cabal files]] - [[Cabal files][Cabal files]]
- [[#faq][FAQ]] - [[FAQ][FAQ]]
- [[#repl-doesnt-work][REPL doesn't work]] - [[REPL doesn't work][REPL doesn't work]]
- [[#repl-is-stuck][REPL is stuck]] - [[REPL is stuck][REPL is stuck]]
- [[#i-am-using-stack-and-ghc-mod-but-ghc-mod-doesnt-work][I am using =stack= and =ghc-mod=, but =ghc-mod= doesn't work]] - [[I am using =stack= and =ghc-mod=, but =ghc-mod= doesn't work][I am using =stack= and =ghc-mod=, but =ghc-mod= doesn't work]]
- [[#indentation-doesnt-reset-when-pressing-return-after-empty-line][Indentation doesn't reset when pressing return after empty line]] - [[Indentation doesn't reset when pressing return after empty line][Indentation doesn't reset when pressing return after empty line]]
* Description * Description
This layer adds support for the [[https://www.haskell.org/][Haskell]] language. This layer adds support for the [[https://www.haskell.org/][Haskell]] language.

15
layers/+lang/html/README.org
View File

@ -2,13 +2,13 @@
[[file:img/html.png]] [[file:img/html.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#web-mode][Web mode]] - [[Web mode][Web mode]]
- [[#cssscss][CSS/SCSS]] - [[CSS/SCSS][CSS/SCSS]]
* Description * Description
This layer adds support for editing HTML and CSS. This layer adds support for editing HTML and CSS.
@ -27,7 +27,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key Bindings * Key Bindings
** Web mode ** Web mode
| Key Binding | Description | | Key Binding | Description |

24
layers/+lang/idris/README.org
View File

@ -2,18 +2,18 @@
[[file:img/idris.png]] [[file:img/idris.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#idris][Idris]] - [[Idris][Idris]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#shorthands][Shorthands]] - [[Shorthands][Shorthands]]
- [[#interactive-editing][Interactive editing]] - [[Interactive editing][Interactive editing]]
- [[#documentation][Documentation]] - [[Documentation][Documentation]]
- [[#repl][REPL]] - [[REPL][REPL]]
- [[#active-term-manipulations][Active term manipulations]] - [[Active term manipulations][Active term manipulations]]
- [[#build-system][Build system]] - [[Build system][Build system]]
* Description * Description
This layer adds support for the [[http://www.idris-lang.org/][Idris]] language. This layer adds support for the [[http://www.idris-lang.org/][Idris]] language.

44
layers/+lang/ipython-notebook/README.org
View File

@ -1,27 +1,27 @@
#+TITLE: IPython Notebook contribution layer for Spacemacs (WIP) #+TITLE: IPython Notebook contribution layer for Spacemacs (WIP)
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#list-of-todos][List of TODOS]] - [[List of TODOS][List of TODOS]]
- [[#maybe-itd-be-better-if-there-was-a-state-for-this][Maybe it'd be better if there was a state for this]] - [[Maybe it'd be better if there was a state for this][Maybe it'd be better if there was a state for this]]
- [[#make-more-keybinding-to-connect-to-a-python-buffer][Make more keybinding to =connect= to a python buffer.]] - [[Make more keybinding to =connect= to a python buffer.][Make more keybinding to =connect= to a python buffer.]]
- [[#deleting-visual-regions-dont-work-find-out-why][Deleting visual regions don't work, find out why.]] - [[Deleting visual regions don't work, find out why.][Deleting visual regions don't work, find out why.]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#dependencies][Dependencies]] - [[Dependencies][Dependencies]]
- [[#what-needs-to-be-run][What needs to be run]] - [[What needs to be run][What needs to be run]]
- [[#using-the-ipython-notebook][Using the IPython notebook]] - [[Using the IPython notebook][Using the IPython notebook]]
- [[#open-notebook-list][Open Notebook List]] - [[Open Notebook List][Open Notebook List]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#micro-state-ipython-notebook][Micro-state: =ipython-notebook=]] - [[Micro-state: =ipython-notebook=][Micro-state: =ipython-notebook=]]
- [[#normal-mode][Normal mode]] - [[Normal mode][Normal mode]]
- [[#insert-mode][Insert mode]] - [[Insert mode][Insert mode]]
- [[#traceback-mode][Traceback mode]] - [[Traceback mode][Traceback mode]]
- [[#screenshots][Screenshots]] - [[Screenshots][Screenshots]]
- [[#light][Light]] - [[Light][Light]]
- [[#dark][Dark]] - [[Dark][Dark]]
- [[#bonus][Bonus]] - [[Bonus][Bonus]]
* Description * Description
This layer adds support for the package =emacs-ipython-notebook=. This layer adds support for the package =emacs-ipython-notebook=.

36
layers/+lang/java/README.org
View File

@ -2,24 +2,24 @@
[[file:img/java.png]] [[file:img/java.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#layer-installation][Layer Installation]] - [[Layer Installation][Layer Installation]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#eclim][Eclim]] - [[Eclim][Eclim]]
- [[#installation][Installation]] - [[Installation][Installation]]
- [[#usage][Usage]] - [[Usage][Usage]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#java-mode][Java-mode]] - [[Java-mode][Java-mode]]
- [[#project-management][Project management]] - [[Project management][Project management]]
- [[#maven][Maven]] - [[Maven][Maven]]
- [[#goto][Goto]] - [[Goto][Goto]]
- [[#refactoring][Refactoring]] - [[Refactoring][Refactoring]]
- [[#documentation-find][Documentation, Find]] - [[Documentation, Find][Documentation, Find]]
- [[#problems][Problems]] - [[Problems][Problems]]
- [[#tests][Tests]] - [[Tests][Tests]]
- [[#problems-buffer][Problems buffer]] - [[Problems buffer][Problems buffer]]
- [[#projects-buffer][Projects buffer]] - [[Projects buffer][Projects buffer]]
* Description * Description
This layer adds support for the Java language using the [[http://eclim.org][Eclim]] client/server. This layer adds support for the Java language using the [[http://eclim.org][Eclim]] client/server.

26
layers/+lang/javascript/README.org
View File

@ -2,19 +2,19 @@
[[file:img/javascript.png]] [[file:img/coffee.png]] [[file:img/javascript.png]] [[file:img/coffee.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#js2-mode][js2-mode]] - [[js2-mode][js2-mode]]
- [[#folding-js2-mode][Folding (js2-mode)]] - [[Folding (js2-mode)][Folding (js2-mode)]]
- [[#refactoring-js2-refactor][Refactoring (js2-refactor)]] - [[Refactoring (js2-refactor)][Refactoring (js2-refactor)]]
- [[#formatting-web-beautify][Formatting (web-beautify)]] - [[Formatting (web-beautify)][Formatting (web-beautify)]]
- [[#documentation-js-doc][Documentation (js-doc)]] - [[Documentation (js-doc)][Documentation (js-doc)]]
- [[#auto-complete-and-documentation-tern][Auto-complete and documentation (tern)]] - [[Auto-complete and documentation (tern)][Auto-complete and documentation (tern)]]
- [[#json][JSON]] - [[JSON][JSON]]
* Description * Description

26
layers/+lang/latex/README.org
View File

@ -2,18 +2,18 @@
[[file:img/latex.png]] [[file:img/latex.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#auto-completion][Auto-completion]] - [[Auto-completion][Auto-completion]]
- [[#previewing][Previewing]] - [[Previewing][Previewing]]
- [[#build-command][Build command]] - [[Build command][Build command]]
- [[#auto-fill][Auto-fill]] - [[Auto-fill][Auto-fill]]
- [[#keybindings][Keybindings]] - [[Keybindings][Keybindings]]
- [[#reftex][RefTeX]] - [[RefTeX][RefTeX]]
- [[#maintainer][Maintainer]] - [[Maintainer][Maintainer]]
* Description * Description
@ -79,7 +79,7 @@ The variable =latex-nofill-env= provide the list of environment names where
* Keybindings * Keybindings
| Key Binding | Description | | Key Binding | Description |
|-------------+---------------------------------------------------------+ |-------------+---------------------------------------------------------|
| ~SPC m *~ | TeX documentation, can be very slow | | ~SPC m *~ | TeX documentation, can be very slow |
| ~SPC m b~ | build | | ~SPC m b~ | build |
| ~SPC m c~ | close LaTeX environment | | ~SPC m c~ | close LaTeX environment |

12
layers/+lang/lua/README.org
View File

@ -2,12 +2,12 @@
[[file:img/lua.gif]] [[file:img/lua.gif]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#commands][Commands]] - [[Commands][Commands]]
* Description * Description

32
layers/+lang/markdown/README.org
View File

@ -2,22 +2,22 @@
[[file:img/markdown.png]] [[file:img/markdown.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#usage][Usage]] - [[Usage][Usage]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#element-insertion][Element insertion]] - [[Element insertion][Element insertion]]
- [[#element-removal][Element removal]] - [[Element removal][Element removal]]
- [[#completion-and-cycling][Completion, and Cycling]] - [[Completion, and Cycling][Completion, and Cycling]]
- [[#following-and-jumping][Following and Jumping]] - [[Following and Jumping][Following and Jumping]]
- [[#indentation][Indentation]] - [[Indentation][Indentation]]
- [[#header-navigation][Header navigation]] - [[Header navigation][Header navigation]]
- [[#buffer-wide-commands][Buffer-wide commands]] - [[Buffer-wide commands][Buffer-wide commands]]
- [[#list-editing][List editing]] - [[List editing][List editing]]
- [[#movement][Movement]] - [[Movement][Movement]]
- [[#promotion-demotion][Promotion, Demotion]] - [[Promotion, Demotion][Promotion, Demotion]]
* Description * Description

18
layers/+lang/nim/README.org
View File

@ -2,12 +2,12 @@
[[file:img/logo.png]] [[file:img/logo.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#working-with-nim][Working with Nim]] - [[Working with Nim][Working with Nim]]
- [[#nim-commands-start-with-m][Nim commands (start with =m=):]] - [[Nim commands (start with =m=):][Nim commands (start with =m=):]]
* Description * Description
@ -26,6 +26,6 @@ To use this contribution add it to your =~/.spacemacs=
* Working with Nim * Working with Nim
** Nim commands (start with =m=): ** Nim commands (start with =m=):
| Key Binding | Description | | Key Binding | Description |
|-------------+-----------------------------------------------------------| |-------------+----------------------------|
| ~SPC m c r~ | nim compile --run main.nim | ~SPC m c r~ | nim compile --run main.nim |

24
layers/+lang/ocaml/README.org
View File

@ -2,18 +2,18 @@
[[file:img/ocaml.png]] [[file:img/ocaml.png]]
* Table of Content :TOC@4: * Table of Content :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#opam-packages][OPAM packages]] - [[OPAM packages][OPAM packages]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#repl-utop][REPL (utop)]] - [[REPL (utop)][REPL (utop)]]
- [[#todos][TODOS]] - [[TODOS][TODOS]]
- [[#add-more-proper-spacemacs-key-bindings-for-basic-merlin-tasks][Add more proper spacemacs key-bindings for basic merlin tasks]] - [[Add more proper spacemacs key-bindings for basic merlin tasks][Add more proper spacemacs key-bindings for basic merlin tasks]]
- [[#add-proper-keybindings-for-ocamldebug][Add proper keybindings for ocamldebug]] - [[Add proper keybindings for ocamldebug][Add proper keybindings for ocamldebug]]
- [[#add-more-keybindings-for-tuareg-mode][Add more keybindings for tuareg-mode]] - [[Add more keybindings for tuareg-mode][Add more keybindings for tuareg-mode]]
* Description * Description
This is a very basic layer for editing ocaml files. This is a very basic layer for editing ocaml files.

10
layers/+lang/php/README.org
View File

@ -2,11 +2,11 @@
[[file:img/php.png]] [[file:img/php.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

14
layers/+lang/purescript/README.org
View File

@ -2,13 +2,13 @@
[[file:img/purescript-logo.png]] [[file:img/purescript-logo.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#purescript][Purescript]] - [[Purescript][Purescript]]
- [[#imports][Imports]] - [[Imports][Imports]]
- [[#repl][REPL]] - [[REPL][REPL]]
* Description * Description

43
layers/+lang/python/README.org
View File

@ -2,24 +2,24 @@
[[file:img/python.png]] [[file:img/python.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#test-runner][Test runner]] - [[Test runner][Test runner]]
- [[#anaconda-dependencies][Anaconda dependencies]] - [[Anaconda dependencies][Anaconda dependencies]]
- [[#automatic-buffer-formatting-on-save][Automatic buffer formatting on save]] - [[Automatic buffer formatting on save][Automatic buffer formatting on save]]
- [[#autoflake][autoflake]] - [[autoflake][autoflake]]
- [[#pylookup][pylookup]] - [[pylookup][pylookup]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#inferior-repl-process][Inferior REPL process]] - [[Inferior REPL process][Inferior REPL process]]
- [[#running-python-script-in-shell][Running Python Script in shell]] - [[Running Python Script in shell][Running Python Script in shell]]
- [[#testing][Testing]] - [[Testing][Testing]]
- [[#refactoring][Refactoring]] - [[Refactoring][Refactoring]]
- [[#other-python-commands][Other Python commands]] - [[Other Python commands][Other Python commands]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#fill-column][Fill column]] - [[Fill column][Fill column]]
* Description * Description
This layer adds support for the Python language. This layer adds support for the Python language.
@ -34,8 +34,8 @@ This layer adds support for the Python language.
- PEP8 compliant formatting via [[https://github.com/google/yapf][YAPF]] - PEP8 compliant formatting via [[https://github.com/google/yapf][YAPF]]
- Suppression of unused import with [[https://github.com/myint/autoflake][autoflake]] - Suppression of unused import with [[https://github.com/myint/autoflake][autoflake]]
- Use the ~%~ key to jump between blocks with [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] - Use the ~%~ key to jump between blocks with [[https://github.com/redguardtoo/evil-matchit][evil-matchit]]
* Install
* Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
@ -59,9 +59,10 @@ The root of the project is detected with a =.git= directory or a =setup.cfg= fil
=anaconda-mode= tries to install the dependencies itself but sometimes =anaconda-mode= tries to install the dependencies itself but sometimes
it does not work and you may encounter the following message when it does not work and you may encounter the following message when
opening a python buffer: opening a python buffer:
#+begin_src
#+begin_example
Blocking call to accept-process-output with quit inhibited!! Blocking call to accept-process-output with quit inhibited!!
#+end_src #+end_example
To fix this, install the =anaconda-mode= [[https://github.com/proofit404/anaconda-mode/blob/master/requirements.txt][anaconda-deps]] by hand: To fix this, install the =anaconda-mode= [[https://github.com/proofit404/anaconda-mode/blob/master/requirements.txt][anaconda-deps]] by hand:

18
layers/+lang/racket/README.org
View File

@ -2,15 +2,15 @@
[[file:img/racket.png]] [[file:img/racket.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#navigation][Navigation]] - [[Navigation][Navigation]]
- [[#documentation][Documentation]] - [[Documentation][Documentation]]
- [[#tests][Tests]] - [[Tests][Tests]]
- [[#repl][REPL]] - [[REPL][REPL]]
- [[#other-key-bindings][Other key bindings]] - [[Other key bindings][Other key bindings]]
* Description * Description

22
layers/+lang/ruby/README.org
View File

@ -2,22 +2,20 @@
[[file:img/ruby.png]] [[file:img/ruby.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#prerequisites][Prerequisites]] - [[Prerequisites][Prerequisites]]
- [[#ruby-version-management][Ruby version management]] - [[Ruby version management][Ruby version management]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#ruby-enh-ruby-mode-robe-inf-ruby-ruby-tools][Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)]] - [[Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)][Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)]]
- [[#ruby-test-mode][ruby-test-mode]] - [[ruby-test-mode][ruby-test-mode]]
* Description * Description
This layer provides support for the Ruby language with [[https://github.com/zenspider/enhanced-ruby-mode][enh-ruby-mode]] and [[https://github.com/dgutov/robe][robe-mode]]. This layer provides support for the Ruby language with [[https://github.com/zenspider/enhanced-ruby-mode][enh-ruby-mode]] and [[https://github.com/dgutov/robe][robe-mode]].
Optionally Enh Ruby Mode can be replaced with the built-in Emacs Ruby Mode. Optionally Enh Ruby Mode can be replaced with the built-in Emacs Ruby Mode.
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -34,7 +32,6 @@ This layer supports two different Ruby modes: Emacs' built-in Ruby Mode and
#+END_SRC #+END_SRC
** Prerequisites ** Prerequisites
Some of the advanced features supported by this layer depend on external gems Some of the advanced features supported by this layer depend on external gems
that need to be installed in the context of your project (see below for guidance that need to be installed in the context of your project (see below for guidance
based on your version manager): based on your version manager):
@ -57,7 +54,6 @@ specific documentation for details and caveats):
#+END_SRC #+END_SRC
** Ruby version management ** Ruby version management
This layer supports the use of [[https://rvm.io/][RVM]] and [[https://github.com/sstephenson/rbenv][Rbenv]]. This layer supports the use of [[https://rvm.io/][RVM]] and [[https://github.com/sstephenson/rbenv][Rbenv]].
To enable it, set the =ruby-version-manager= var in your =~/.spacemacs=: To enable it, set the =ruby-version-manager= var in your =~/.spacemacs=:
@ -70,7 +66,6 @@ To enable it, set the =ruby-version-manager= var in your =~/.spacemacs=:
Possible values are =rbenv= and =rvm=. Possible values are =rbenv= and =rvm=.
* Key bindings * Key bindings
** Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools) ** Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)
| Key binding | Description | | Key binding | Description |
@ -91,7 +86,6 @@ Possible values are =rbenv= and =rvm=.
| ~%~ | [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] jumps between blocks | | ~%~ | [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] jumps between blocks |
** ruby-test-mode ** ruby-test-mode
ruby-test-mode comes bundled with spacemacs, but this contribution adds ruby-test-mode comes bundled with spacemacs, but this contribution adds
a couple of useful keybindings: a couple of useful keybindings:

13
layers/+lang/rust/README.org
View File

@ -2,12 +2,12 @@
[[file:img/rust.png]] [[file:img/rust.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#cargo][Cargo]] - [[Cargo][Cargo]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer aims to support [[http://www.rust-lang.org/][Rust]] development in Spacemacs. This layer aims to support [[http://www.rust-lang.org/][Rust]] development in Spacemacs.
@ -16,7 +16,6 @@ It supports [[http://doc.crates.io/index.html][Cargo]], and has some basic auto-
though Racer needs some additional configurations as described on their page. though Racer needs some additional configurations as described on their page.
* Install * Install
** Layer ** Layer
To use this layer, add it to your =~/.spacemacs= To use this layer, add it to your =~/.spacemacs=

40
layers/+lang/scala/README.org
View File

@ -2,26 +2,26 @@
[[file:img/scala.png]] with [[file:img/ensime.png]] [[file:img/scala.png]] with [[file:img/ensime.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#layer-installation][Layer Installation]] - [[Layer Installation][Layer Installation]]
- [[#ensime][Ensime]] - [[Ensime][Ensime]]
- [[#installation][Installation]] - [[Installation][Installation]]
- [[#usage][Usage]] - [[Usage][Usage]]
- [[#scalastyle][Scalastyle]] - [[Scalastyle][Scalastyle]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#ensime-key-bindings][Ensime key bindings]] - [[Ensime key bindings][Ensime key bindings]]
- [[#search][Search]] - [[Search][Search]]
- [[#sbt][sbt]] - [[sbt][sbt]]
- [[#typecheck][Typecheck]] - [[Typecheck][Typecheck]]
- [[#debug][Debug]] - [[Debug][Debug]]
- [[#errors][Errors]] - [[Errors][Errors]]
- [[#goto][Goto]] - [[Goto][Goto]]
- [[#documentation-inspect][Documentation, Inspect]] - [[Documentation, Inspect][Documentation, Inspect]]
- [[#server][Server]] - [[Server][Server]]
- [[#refactoring][Refactoring]] - [[Refactoring][Refactoring]]
- [[#tests][Tests]] - [[Tests][Tests]]
- [[#repl][REPL]] - [[REPL][REPL]]
* Description * Description

20
layers/+lang/scheme/README.org
View File

@ -1,15 +1,15 @@
#+TITLE: Scheme contribution layer for Spacemacs #+TITLE: Scheme contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#compiling-][Compiling ]] - [[Compiling ][Compiling ]]
- [[#navigation][Navigation]] - [[Navigation][Navigation]]
- [[#documentation][Documentation]] - [[Documentation][Documentation]]
- [[#insertion][Insertion]] - [[Insertion][Insertion]]
- [[#macroexpansion][Macroexpansion]] - [[Macroexpansion][Macroexpansion]]
- [[#repl][REPL]] - [[REPL][REPL]]
* Description * Description

8
layers/+lang/shell-scripts/README.org
View File

@ -2,10 +2,10 @@
[[file:img/fish.png]] [[file:img/fish.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description

12
layers/+lang/sml/README.org
View File

@ -2,12 +2,12 @@
[[file:img/sml.png]] [[file:img/sml.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#form-completion][Form Completion]] - [[Form Completion][Form Completion]]
- [[#repl][REPL]] - [[REPL][REPL]]
* Description * Description

16
layers/+lang/sql/README.org
View File

@ -2,14 +2,14 @@
[[file:img/sql.png]] [[file:img/sql.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#highlighting][Highlighting]] - [[Highlighting][Highlighting]]
- [[#inferior-process-interactions-sqli][Inferior Process Interactions (SQLi)]] - [[Inferior Process Interactions (SQLi)][Inferior Process Interactions (SQLi)]]
- [[#send-sql-queries-to-sqli][Send SQL queries to SQLi:]] - [[Send SQL queries to SQLi:][Send SQL queries to SQLi:]]
- [[#sqli-buffer][SQLi buffer]] - [[SQLi buffer][SQLi buffer]]
* Description * Description

12
layers/+lang/typescript/README.org
View File

@ -2,12 +2,12 @@
[[file:img/TypeScript.png]] [[file:img/TypeScript.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#prerequisites][Prerequisites]] - [[Prerequisites][Prerequisites]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

6
layers/+lang/vimscript/README.org
View File

@ -1,8 +1,8 @@
#+TITLE: Vimscript language contribution layer for Spacemacs #+TITLE: Vimscript language contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
* Description * Description

16
layers/+lang/windows-scripts/README.org
View File

@ -2,15 +2,14 @@
[[file:img/ps.png]] [[file:img/ps.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#powershell][Powershell]] - [[Powershell][Powershell]]
- [[#batch-dosel][Batch (dos.el)]] - [[Batch (dos.el)][Batch (dos.el)]]
* Description * Description
This simple layer adds support for the Powershell scripting language as well This simple layer adds support for the Powershell scripting language as well
as support for batch files. as support for batch files.
@ -19,7 +18,6 @@ Incuded packages for extensions:
- =.bat=: [[http://www.emacswiki.org/emacs/dos.el][dos.el]] - =.bat=: [[http://www.emacswiki.org/emacs/dos.el][dos.el]]
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -27,9 +25,7 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Key Bindings * Key Bindings
** Powershell ** Powershell
No useful bindings. No useful bindings.
** Batch (dos.el) ** Batch (dos.el)

8
layers/+lang/yaml/README.org
View File

@ -1,15 +1,13 @@
#+TITLE: YAML contribution layer for Spacemacs #+TITLE: YAML contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
* Description * Description
This layer provides syntax highlighting for YAML files. This layer provides syntax highlighting for YAML files.
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp

120
layers/+source-control/git/README.org
View File

@ -2,25 +2,25 @@
[[file:img/git.png]] [[file:img/git.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#recommended-settings][Recommended Settings]] - [[Recommended Settings][Recommended Settings]]
- [[#magit-status-fullscreen][Magit status fullscreen]] - [[Magit status fullscreen][Magit status fullscreen]]
- [[#magit-auto-complete][Magit auto-complete]] - [[Magit auto-complete][Magit auto-complete]]
- [[#magit-svn-plugin][Magit SVN plugin]] - [[Magit SVN plugin][Magit SVN plugin]]
- [[#git][Git]] - [[Git][Git]]
- [[#git-flow][Git-Flow]] - [[Git-Flow][Git-Flow]]
- [[#working-with-git][Working with Git]] - [[Working with Git][Working with Git]]
- [[#magit][Magit]] - [[Magit][Magit]]
- [[#staging-lines][Staging lines]] - [[Staging lines][Staging lines]]
- [[#commit-message-editing-buffer][Commit message editing buffer]] - [[Commit message editing buffer][Commit message editing buffer]]
- [[#interactive-rebase-buffer][Interactive rebase buffer]] - [[Interactive rebase buffer][Interactive rebase buffer]]
- [[#quick-guide-for-recurring-use-cases-in-magit][Quick guide for recurring use cases in Magit]] - [[Quick guide for recurring use cases in Magit][Quick guide for recurring use cases in Magit]]
- [[#git-flow][Git-Flow]] - [[Git-Flow][Git-Flow]]
- [[#git-time-machine][Git time machine]] - [[Git time machine][Git time machine]]
* Description * Description
This layers adds extensive support for [[http://git-scm.com/][git]]. This layers adds extensive support for [[http://git-scm.com/][git]].
@ -140,34 +140,34 @@ Here are the often used bindings inside a =status buffer=:
| Key Binding | Description | | Key Binding | Description |
|-------------+-----------------------------------------------------| |-------------+-----------------------------------------------------|
| ~/~ | evil-search | | ~/~ | evil-search |
| ~$~ | open =command output buffer= | | ~$~ | open =command output buffer= |
| ~c c~ | open a =commit message buffer= | | ~c c~ | open a =commit message buffer= |
| ~b b~ | checkout a branch | | ~b b~ | checkout a branch |
| ~b c~ | create a branch | | ~b c~ | create a branch |
| ~f f~ | fetch changes | | ~f f~ | fetch changes |
| ~F -r F~ | pull and rebase | | ~F -r F~ | pull and rebase |
| ~gr~ | refresh | | ~gr~ | refresh |
| ~j~ | goto next magit section | | ~j~ | goto next magit section |
| ~C-j~ | next visual line | | ~C-j~ | next visual line |
| ~k~ | goto previous magit section | | ~k~ | goto previous magit section |
| ~C-k~ | previous visual line | | ~C-k~ | previous visual line |
| ~l l~ | open =log buffer= | | ~l l~ | open =log buffer= |
| ~n~ | next search occurrence | | ~n~ | next search occurrence |
| ~N~ | previous search occurrence | | ~N~ | previous search occurrence |
| ~o~ | revert item at point | | ~o~ | revert item at point |
| ~P P~ | push | | ~P P~ | push |
| ~q~ | quit | | ~q~ | quit |
| ~s~ | on a file or hunk in a diff: stage the file or hunk | | ~s~ | on a file or hunk in a diff: stage the file or hunk |
| ~x~ | discard changes | | ~x~ | discard changes |
| ~+~ | on a hunk: increase hunk size | | ~+~ | on a hunk: increase hunk size |
| ~-~ | on a hunk: decrease hunk size | | ~-~ | on a hunk: decrease hunk size |
| ~S~ | stage all | | ~S~ | stage all |
| ~TAB~ | on a file: expand/collapse diff | | ~TAB~ | on a file: expand/collapse diff |
| ~u~ | on a staged file: unstage | | ~u~ | on a staged file: unstage |
| ~U~ | unstage all staged files | | ~U~ | unstage all staged files |
| ~v or V~ | select multiple lines | | ~v or V~ | select multiple lines |
| ~z z~ | stash changes | | ~z z~ | stash changes |
** Staging lines ** Staging lines
Magit allows you to stage specific lines by selecting them in a diff and hitting Magit allows you to stage specific lines by selecting them in a diff and hitting
@ -192,19 +192,19 @@ will discard the commit message.
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------| |-------------+----------------|
| ~c~ or ~p~ | pick | | ~c~ or ~p~ | pick |
| ~e~ | edit | | ~e~ | edit |
| ~f~ | fixup | | ~f~ | fixup |
| ~j~ | go down | | ~j~ | go down |
| ~gj~ | move line down | | ~gj~ | move line down |
| ~k~ | go up | | ~k~ | go up |
| ~gk~ | move line up | | ~gk~ | move line up |
| ~d~ or ~x~ | kill line | | ~d~ or ~x~ | kill line |
| ~r~ | reword | | ~r~ | reword |
| ~s~ | squash | | ~s~ | squash |
| ~u~ | undo | | ~u~ | undo |
| ~y~ | insert | | ~y~ | insert |
| ~!~ | execute | | ~!~ | execute |
** Quick guide for recurring use cases in Magit ** Quick guide for recurring use cases in Magit

18
layers/+source-control/github/README.org
View File

@ -2,15 +2,15 @@
[[file:img/github.png]] [[file:img/github.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#magit-gh-pulls][magit-gh-pulls]] - [[magit-gh-pulls][magit-gh-pulls]]
- [[#gistel][gist.el]] - [[gist.el][gist.el]]
- [[#browse-files][Browse files]] - [[Browse files][Browse files]]
* Description * Description

8
layers/+source-control/perforce/README.org
View File

@ -2,10 +2,10 @@
[[file:img/p4.png]] [[file:img/p4.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

20
layers/+source-control/version-control/README.org
View File

@ -1,11 +1,11 @@
#+TITLE: Version-Control contribution layer for Spacemacs #+TITLE: Version-Control contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description
@ -29,7 +29,7 @@ To use this contribution add it to your =~/.spacemacs=
| Key Binding | Description | | Key Binding | Description |
|-------------+---------------| |-------------+---------------|
| ~SPC g h g~ | Go to hunk | | ~SPC g h g~ | Go to hunk |
| ~SPC g h N~ | Previous hunk | | ~SPC g h N~ | Previous hunk |
| ~SPC g h n~ | Next hunk | | ~SPC g h n~ | Next hunk |
| ~SPC g h r~ | Revert hunk | | ~SPC g h r~ | Revert hunk |

22
layers/+tools/dash/README.org
View File

@ -3,17 +3,17 @@
[[file:img/zeal.png]] [[file:img/zeal.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#dash-os-x][Dash (OS X)]] - [[Dash (OS X)][Dash (OS X)]]
- [[#zeal-linux--windows][Zeal (Linux & Windows)]] - [[Zeal (Linux & Windows)][Zeal (Linux & Windows)]]
- [[#check-documentation-for-x-at-point][Check Documentation for x-at-point]] - [[Check Documentation for x-at-point][Check Documentation for x-at-point]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#helm-dash][helm-dash]] - [[helm-dash][helm-dash]]
- [[#todos][TODOs]] - [[TODOs][TODOs]]
- [[#done-check-zeal][DONE Check zeal]] - [[Check zeal][Check zeal]]
- [[#todo-make-helm-dash-use-zeal-or-dash-docsets-by-default][TODO Make helm-dash use zeal or dash docsets by default.]] - [[Make helm-dash use zeal or dash docsets by default.][Make helm-dash use zeal or dash docsets by default.]]
* Description * Description
+*This layer works only on OS X for the moment*+ +*This layer works only on OS X for the moment*+

14
layers/+tools/evernote/README.org
View File

@ -2,13 +2,13 @@
[[file:img/evernote.png]] with [[file:img/geeknote.png]] [[file:img/evernote.png]] with [[file:img/geeknote.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#geeknote][geeknote]] - [[geeknote][geeknote]]
- [[#geeknoteel][geeknote.el]] - [[geeknote.el][geeknote.el]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description
This layer groups together packages to work with [[https://evernote.com/][Evernote]]. This layer groups together packages to work with [[https://evernote.com/][Evernote]].

12
layers/+tools/fasd/README.org
View File

@ -1,11 +1,11 @@
#+TITLE: fasd contribution layer for Spacemacs #+TITLE: fasd contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#fasd][fasd]] - [[fasd][fasd]]
- [[#keybindings][Keybindings]] - [[Keybindings][Keybindings]]
* Description * Description

14
layers/+tools/pandoc/README.org
View File

@ -1,12 +1,12 @@
#+TITLE: Pandoc contribution layer for Spacemacs #+TITLE: Pandoc contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#pandoc][Pandoc]] - [[Pandoc][Pandoc]]
- [[#usage][Usage]] - [[Usage][Usage]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description

62
layers/+tools/ranger/README.org
View File

@ -1,13 +1,13 @@
#+TITLE: Ranger contribution layer for Spacemacs #+TITLE: Ranger contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#customizing][Customizing]] - [[Customizing][Customizing]]
- [[#parent-options][Parent options]] - [[Parent options][Parent options]]
- [[#preview-options][Preview options]] - [[Preview options][Preview options]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description
@ -111,27 +111,27 @@ To set the max files size (in MB), set the following parameter:
| Key Binding | Description | | Key Binding | Description |
|-------------+------------------------------------------------------| |-------------+------------------------------------------------------|
| ~SPC a r~ | launch ranger | | ~SPC a r~ | launch ranger |
| SPC a d | deer (minimal ranger window in current directory) | | SPC a d | deer (minimal ranger window in current directory) |
| ~C-p~ | (ranger) toggle ranger in dired buffer | | ~C-p~ | (ranger) toggle ranger in dired buffer |
| ~j~ | (ranger) navigate down | | ~j~ | (ranger) navigate down |
| ~k~ | (ranger) navigate up | | ~k~ | (ranger) navigate up |
| ~C-j~ | (ranger) scroll preview window down | | ~C-j~ | (ranger) scroll preview window down |
| ~C-k~ | (ranger) scroll preview window up | | ~C-k~ | (ranger) scroll preview window up |
| ~f~ | (ranger) search for file names | | ~f~ | (ranger) search for file names |
| ~i~ | (ranger) show preview of current file | | ~i~ | (ranger) show preview of current file |
| ~zi~ | (ranger) toggle showing literal / full-text previews | | ~zi~ | (ranger) toggle showing literal / full-text previews |
| ~zh~ | (ranger) toggle showing dotfiles | | ~zh~ | (ranger) toggle showing dotfiles |
| ~o~ | (ranger) sort options | | ~o~ | (ranger) sort options |
| ~H~ | (ranger) search through history | | ~H~ | (ranger) search through history |
| ~h~ | (ranger) go up directory | | ~h~ | (ranger) go up directory |
| ~l~ | (ranger) find file / enter directory | | ~l~ | (ranger) find file / enter directory |
| ~RET~ | (ranger) find file / enter directory | | ~RET~ | (ranger) find file / enter directory |
| ~q~ | (ranger) quit | | ~q~ | (ranger) quit |
| ~r~ | (ranger) revert buffer | | ~r~ | (ranger) revert buffer |
| ~z-~ | (ranger) reduce number of parents | | ~z-~ | (ranger) reduce number of parents |
| ~z+~ | (ranger) increment number of parents | | ~z+~ | (ranger) increment number of parents |
| ~v~ | (ranger) toggle all marks | | ~v~ | (ranger) toggle all marks |
| ~V~ | (ranger) visually select lines | | ~V~ | (ranger) visually select lines |
| ~S~ | (ranger) enter shell | | ~S~ | (ranger) enter shell |
| ~C-SPC~ | (ranger) mark current file | | ~C-SPC~ | (ranger) mark current file |

5
layers/+tools/tmux/README.org
View File

@ -1,10 +1,9 @@
#+TITLE: Tmux contribution layer for Spacemacs #+TITLE: Tmux contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#what-is-this][What is this]] - [[What is this][What is this]]
* What is this * What is this
This is an extension to support [[https://github.com/Keithbsmiley/evil-tmux-navigator][evil-tmux-navigator]]. It requires a little This is an extension to support [[https://github.com/Keithbsmiley/evil-tmux-navigator][evil-tmux-navigator]]. It requires a little
configuration for tmux, so check the upstream documentation. configuration for tmux, so check the upstream documentation.

16
layers/+tools/vagrant/README.org
View File

@ -2,14 +2,14 @@
[[file:img/vagrant.png]] [[file:img/vagrant.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#vagrant][Vagrant]] - [[Vagrant][Vagrant]]
- [[#testing][Testing]] - [[Testing][Testing]]
- [[#keybindings][Keybindings]] - [[Keybindings][Keybindings]]
* Description * Description

14
layers/+tools/wakatime/README.org
View File

@ -2,13 +2,13 @@
[[file:img/wakatime.png]] [[file:img/wakatime.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#wakatime-program][Wakatime Program]] - [[Wakatime Program][Wakatime Program]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#api-keys][API Keys]] - [[API Keys][API Keys]]
- [[#note-to-venv-workon-users][Note to =venv-workon= users:]] - [[Note to =venv-workon= users:][Note to =venv-workon= users:]]
* Description * Description
This layer adds support for Wakatime. This layer adds support for Wakatime.

16
layers/+tools/ycmd/README.org
View File

@ -1,13 +1,13 @@
#+TITLE: YCMD contribution layer for Spacemacs #+TITLE: YCMD contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#ycmd][YCMD]] - [[YCMD][YCMD]]
- [[#other-requirements][Other Requirements]] - [[Other Requirements][Other Requirements]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description

8
layers/+vim/evil-commentary/README.org
View File

@ -1,9 +1,9 @@
#+TITLE: Evil-commentary contribution layer for Spacemacs #+TITLE: Evil-commentary contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer replaces [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] with [[https://github.com/linktohack/evil-commentary][evil-commentary]] for those This layer replaces [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] with [[https://github.com/linktohack/evil-commentary][evil-commentary]] for those

18
layers/+vim/evil-snipe/README.org
View File

@ -2,15 +2,15 @@
[[file:img/Cat_With_Rifle.jpg]] [[file:img/Cat_With_Rifle.jpg]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#improved-f-and-t-search-behavior][Improved f and t search behavior]] - [[Improved f and t search behavior][Improved f and t search behavior]]
- [[#two-character-search-with-s][Two-character search with s]] - [[Two-character search with s][Two-character search with s]]
- [[#more-scopes][More scopes]] - [[More scopes][More scopes]]
- [[#symbol-groups][Symbol groups]] - [[Symbol groups][Symbol groups]]
- [[#todo-key-bindings][TODO Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
The package [[https://github.com/hlissner/evil-snipe][evil-snipe]] The package [[https://github.com/hlissner/evil-snipe][evil-snipe]]

6
layers/+vim/unimpaired/README.org
View File

@ -1,8 +1,8 @@
#+TITLE: Unimpaired port contribution layer for Spacemacs #+TITLE: Unimpaired port contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

6
layers/+vim/vim-empty-lines/README.org
View File

@ -1,8 +1,8 @@
#+TITLE: Vim-empty-lines contribution layer for Spacemacs #+TITLE: Vim-empty-lines contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
* Description * Description

6
layers/+vim/vim-powerline/README.org
View File

@ -1,8 +1,8 @@
#+TITLE: vim-powerline contribution layer for Spacemacs #+TITLE: vim-powerline contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
* Description * Description
A powerline theme modeled after the vim powerline theme. A powerline theme modeled after the vim powerline theme.

10
layers/+vim/vinegar/README.org
View File

@ -1,10 +1,10 @@
#+TITLE: Vinegar contribution layer for Spacemacs #+TITLE: Vinegar contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#mouse-bindings][Mouse bindings]] - [[Mouse bindings][Mouse bindings]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

16
layers/+window-management/eyebrowse/README.org
View File

@ -2,15 +2,14 @@
[[file:img/eyebrowse.gif]] [[file:img/i3wm.png]] [[file:img/eyebrowse.gif]] [[file:img/i3wm.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#removing-additional-help][Removing additional help]] - [[Removing additional help][Removing additional help]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer adds [[https://i3wm.org/][i3wm]] like workspaces thanks to the [[https://github.com/wasamasa/eyebrowse][eyebrowse]] package. This layer adds [[https://i3wm.org/][i3wm]] like workspaces thanks to the [[https://github.com/wasamasa/eyebrowse][eyebrowse]] package.
Once the layer is activated a new number is added to the right side of the Once the layer is activated a new number is added to the right side of the
@ -31,9 +30,7 @@ It is also possible to give a label to a the current workspace by pressing
~r~ in the micro-state. ~r~ in the micro-state.
* Install * Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -41,7 +38,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
** Removing additional help ** Removing additional help
Once you know the key bindings to navigate between the workspaces you Once you know the key bindings to navigate between the workspaces you
may want to disable the exhaustive help in the workspace micro-state. may want to disable the exhaustive help in the workspace micro-state.
Set the variable =eyebrowse-display-help= to =nil= Set the variable =eyebrowse-display-help= to =nil=

31
layers/+window-management/perspectives/README.org
View File

@ -1,26 +1,23 @@
#+TITLE: Perspectives contribution layer for Spacemacs #+TITLE: Perspectives contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#custom-perspective-macro][Custom Perspective Macro]] - [[Custom Perspective Macro][Custom Perspective Macro]]
- [[#predefined-custom-perspectives][Predefined custom perspectives]] - [[Predefined custom perspectives][Predefined custom perspectives]]
- [[#per-project-custom-perpsective][Per project custom perpsective]] - [[Per project custom perpsective][Per project custom perpsective]]
- [[#org-agenda-custom-perspective][Org-agenda custom perspective]] - [[Org-agenda custom perspective][Org-agenda custom perspective]]
- [[#rcirc-custom-perspective][RCIRC custom perspective]] - [[RCIRC custom perspective][RCIRC custom perspective]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#custom-perspectives-key-bindings][Custom Perspectives Key Bindings]] - [[Custom Perspectives Key Bindings][Custom Perspectives Key Bindings]]
* Description * Description
This contrib layer sets up perspective-mode. And also defines custom This contrib layer sets up perspective-mode. And also defines custom
perspectives with a macro so that you don't have to do more steps. perspectives with a macro so that you don't have to do more steps.
* Install * Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -28,7 +25,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
** Custom Perspective Macro ** Custom Perspective Macro
If you want to add a new custom-persp (for example if you want to have If you want to add a new custom-persp (for example if you want to have
IRC on its own perspective or maybe calendar or gnus) you have to use IRC on its own perspective or maybe calendar or gnus) you have to use
the macro =custom-persp= as follows: the macro =custom-persp= as follows:
@ -64,9 +60,7 @@ Then you just need to add a keybinding to your custom persp, we use
#+END_SRC #+END_SRC
* Predefined custom perspectives * Predefined custom perspectives
*** Per project custom perpsective *** Per project custom perpsective
As the name suggests, this persp-projectile mode creates a new perspective As the name suggests, this persp-projectile mode creates a new perspective
once you switch to a new project with ~SPC p p~. It must be said that in the once you switch to a new project with ~SPC p p~. It must be said that in the
current implementation in order for this to work you must first open a current implementation in order for this to work you must first open a
@ -79,7 +73,6 @@ custom-perspective like ~SPC L o e~ to go to the init.el in the spacemacs.
#+END_SRC #+END_SRC
*** Org-agenda custom perspective *** Org-agenda custom perspective
Here we define a custom perspective that adds items to your org-agenda. If you Here we define a custom perspective that adds items to your org-agenda. If you
do not know what that is check the [[https://www.gnu.org/software/emacs/manual/html_node/org/Agenda-commands.html][docs]]. do not know what that is check the [[https://www.gnu.org/software/emacs/manual/html_node/org/Agenda-commands.html][docs]].
@ -88,7 +81,6 @@ with one simple command you can gather all the todos from all the agenda files
you have and show them in a single buffer. (in evil the command starts with ~;a~) you have and show them in a single buffer. (in evil the command starts with ~;a~)
*** RCIRC custom perspective *** RCIRC custom perspective
Now you can also open rcirc in a new layer to keep all the chat buffers in one Now you can also open rcirc in a new layer to keep all the chat buffers in one
perspective isolated from your work buffers. perspective isolated from your work buffers.
@ -100,7 +92,6 @@ You will have to use the perspective layer as well as the rcirc layer:
#+END_SRC #+END_SRC
* Key Bindings * Key Bindings
Prefix command for perspective commands is ~SPC L~ (for Layout). Prefix command for perspective commands is ~SPC L~ (for Layout).
| Key Binding | Description | | Key Binding | Description |

51
layers/auto-completion/README.org
View File

@ -1,26 +1,25 @@
#+TITLE: Auto-Completion configuration layer for Spacemacs #+TITLE: Auto-completion layer
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#tooltips][Tooltips]] - [[Tooltips][Tooltips]]
- [[#sort-results-by-usage][Sort results by usage]] - [[Sort results by usage][Sort results by usage]]
- [[#show-snippets-in-auto-completion-popup][Show snippets in auto-completion popup]] - [[Show snippets in auto-completion popup][Show snippets in auto-completion popup]]
- [[#enable-company-or-auto-complete-globally][Enable company or auto-complete globally]] - [[Enable company or auto-complete globally][Enable company or auto-complete globally]]
- [[#replacing-company-by-auto-complete][Replacing company by auto-complete]] - [[Replacing company by auto-complete][Replacing company by auto-complete]]
- [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]] - [[Add auto-completion in a layer][Add auto-completion in a layer]]
- [[#in-configel][In =config.el=]] - [[In =config.el=][In =config.el=]]
- [[#in-packagesel][In =packages.el=]] - [[In =packages.el=][In =packages.el=]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#company][Company]] - [[Company][Company]]
- [[#auto-complete][Auto-complete]] - [[Auto-complete][Auto-complete]]
- [[#yasnippet][Yasnippet]] - [[Yasnippet][Yasnippet]]
- [[#auto-yasnippet][Auto-yasnippet]] - [[Auto-yasnippet][Auto-yasnippet]]
* Description * Description
This layer provides auto-completion to Spacemacs. This layer provides auto-completion to Spacemacs.
The following completion engines are supported: The following completion engines are supported:
@ -32,7 +31,6 @@ Snippets are supported via [[https://github.com/capitaomorte/yasnippet][yasnippe
This layer also configures =hippie-expand=. This layer also configures =hippie-expand=.
* Install * Install
To use this configuration layer add it to your =~/.spacemacs= To use this configuration layer add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -40,9 +38,7 @@ To use this configuration layer add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Configuration * Configuration
** Key bindings ** Key bindings
You can customize the user experience of auto-completion with the following You can customize the user experience of auto-completion with the following
layer variables: layer variables:
@ -81,7 +77,6 @@ The default configuration of the layer is:
you don't use it already. you don't use it already.
** Tooltips ** Tooltips
To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t= To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -91,7 +86,6 @@ To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t=
#+END_SRC #+END_SRC
** Sort results by usage ** Sort results by usage
To enable sorting auto-completion results by their usage frequency set To enable sorting auto-completion results by their usage frequency set
=auto-completion-enable-sort-by-usage= to =t=. =auto-completion-enable-sort-by-usage= to =t=.
This feature is provided by the [[https://github.com/company-mode/company-statistics][company-statistics]] package when =company= This feature is provided by the [[https://github.com/company-mode/company-statistics][company-statistics]] package when =company=
@ -105,7 +99,6 @@ The variable has no effect when =auto-complete= is used.
#+END_SRC #+END_SRC
** Show snippets in auto-completion popup ** Show snippets in auto-completion popup
By default, snippets are not shown in the auto-completion popup. To show them in By default, snippets are not shown in the auto-completion popup. To show them in
the popup, set the variable =auto-completion-enable-snippets-in-popup= to =t=. the popup, set the variable =auto-completion-enable-snippets-in-popup= to =t=.
@ -116,7 +109,6 @@ the popup, set the variable =auto-completion-enable-snippets-in-popup= to =t=.
#+END_SRC #+END_SRC
** Enable company or auto-complete globally ** Enable company or auto-complete globally
By default Spacemacs enables auto-completion explicitly for each supported By default Spacemacs enables auto-completion explicitly for each supported
major-mode, it means that =company= and =auto-complete= are not enabled major-mode, it means that =company= and =auto-complete= are not enabled
globally, it allows more flexibility to choose an auto-completion engine globally, it allows more flexibility to choose an auto-completion engine
@ -131,23 +123,19 @@ Note that if you want to enable =auto-complete= globally you will have to
disable =company= first, see the next section to do so. disable =company= first, see the next section to do so.
** Replacing company by auto-complete ** Replacing company by auto-complete
You can disable =company= by adding it to the =dotspacemacs-excluded-packages= You can disable =company= by adding it to the =dotspacemacs-excluded-packages=
variable, then you are free to enable =auto-complete= globally. variable, then you are free to enable =auto-complete= globally.
** Add auto-completion in a layer ** Add auto-completion in a layer
Here is an example to add =company= auto-completion to python buffer: Here is an example to add =company= auto-completion to python buffer:
*** In =config.el= *** In =config.el=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
;; Define the buffer local company backend variable ;; Define the buffer local company backend variable
(spacemacs|defvar-company-backends python-mode) (spacemacs|defvar-company-backends python-mode)
#+END_SRC #+END_SRC
*** In =packages.el= *** In =packages.el=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
;; Add the relevant packages to the layer ;; Add the relevant packages to the layer
(setq python-packages (setq python-packages
@ -172,7 +160,6 @@ Here is an example to add =company= auto-completion to python buffer:
#+END_SRC #+END_SRC
* Key Bindings * Key Bindings
** Company ** Company
| Key Binding | Description | | Key Binding | Description |

25
layers/better-defaults/README.org
View File

@ -1,17 +1,16 @@
#+TITLE: Better Defaults contribution layer for Spacemacs #+TITLE: Better Defaults layer
[[file:img/emacs.png]] [[file:img/emacs.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#functions][Functions]] - [[Functions][Functions]]
- [[#spacemacssmart-move-beginning-of-line][spacemacs/smart-move-beginning-of-line]] - [[=spacemacs/smart-move-beginning-of-line=][=spacemacs/smart-move-beginning-of-line=]]
- [[#spacemacsbackward-kill-word-or-region][spacemacs/backward-kill-word-or-region]] - [[=spacemacs/backward-kill-word-or-region=][=spacemacs/backward-kill-word-or-region=]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer enhances the default commands of Emacs and is primarily intended to 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 be used with the =emacs= editing style as it does not change anything in the Vim
key bindings. key bindings.
@ -23,7 +22,6 @@ style.
The commands defined in this layer are taken from various sources like [[https://github.com/bbatsov/prelude][Prelude]]. The commands defined in this layer are taken from various sources like [[https://github.com/bbatsov/prelude][Prelude]].
* Install * Install
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
@ -31,14 +29,11 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC #+END_SRC
* Functions * Functions
** =spacemacs/smart-move-beginning-of-line=
** spacemacs/smart-move-beginning-of-line
Pressed one time, go to the first non-whitespace character of the line, pressed Pressed one time, go to the first non-whitespace character of the line, pressed
again, go to the beginning of the line. again, go to the beginning of the line.
** spacemacs/backward-kill-word-or-region ** =spacemacs/backward-kill-word-or-region=
A combination of =kill-region= and =backward-kill-word=, depending on whether A combination of =kill-region= and =backward-kill-word=, depending on whether
there is an active region. If there's an active region kill that. If not kill there is an active region. If there's an active region kill that. If not kill
the preceding word. the preceding word.

24
layers/chinese/README.org
View File

@ -2,18 +2,18 @@
[[file:img/China.png]] [[file:img/Chinese.png]] [[file:img/China.png]] [[file:img/Chinese.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#configure-the-default-input-method配置默认中文输入法][Configure the Default Input Method(配置默认中文输入法)]] - [[Configure the Default Input Method(配置默认中文输入法)][Configure the Default Input Method(配置默认中文输入法)]]
- [[#configure-the-chinese-pyim-input-method配置中文拼音输入法][Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)]] - [[Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)][Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)]]
- [[#enable-youdao有道-dictionary激活有道字典][Enable YouDao(有道) Dictionary(激活有道字典)]] - [[Enable YouDao(有道) Dictionary(激活有道字典)][Enable YouDao(有道) Dictionary(激活有道字典)]]
- [[#set-monospaced-font-size设置等宽字体）][Set monospaced font size(设置等宽字体）]] - [[Set monospaced font size(设置等宽字体）][Set monospaced font size(设置等宽字体）]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#youdao-dictionary][Youdao Dictionary]] - [[Youdao Dictionary][Youdao Dictionary]]
- [[#find-by-pinyin-dired][Find-by-pinyin-dired]] - [[Find-by-pinyin-dired][Find-by-pinyin-dired]]
* Description * Description
This Layer adds Chinese related packages: This Layer adds Chinese related packages:

14
layers/chrome/README.org
View File

@ -2,13 +2,13 @@
[[file:img/chrome.png]] [[file:img/chrome.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#feature][Feature:]] - [[Feature:][Feature:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#chrome-extension][Chrome extension]] - [[Chrome extension][Chrome extension]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
* Description * Description

18
layers/colors/README.org
View File

@ -2,15 +2,15 @@
[[file:img/rainbow_dash.png]] [[file:img/rainbow_dash.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#enable-rainbow-identifiers][Enable rainbow-identifiers]] - [[Enable rainbow-identifiers][Enable rainbow-identifiers]]
- [[#enable-nyan-cat][Enable Nyan cat]] - [[Enable Nyan cat][Enable Nyan cat]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#rainbow-identifiers][Rainbow Identifiers]] - [[Rainbow Identifiers][Rainbow Identifiers]]
- [[#rainbow-mode][Rainbow Mode]] - [[Rainbow Mode][Rainbow Mode]]
- [[#nyan-mode][Nyan Mode]] - [[Nyan Mode][Nyan Mode]]
* Description * Description

17
layers/cscope/README.org
View File

@ -2,14 +2,14 @@
[[file:img/cscope.png]] [[file:img/cscope.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#cscope][Cscope]] - [[Cscope][Cscope]]
- [[#pycscope][PyCscope]] - [[PyCscope][PyCscope]]
- [[#usage][Usage]] - [[Usage][Usage]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description
This layer provides bindings for using [[http://cscope.sourceforge.net][Cscope]] and [[https://github.com/portante/pycscope][PyCscope]] in Spacemacs. This layer provides bindings for using [[http://cscope.sourceforge.net][Cscope]] and [[https://github.com/portante/pycscope][PyCscope]] in Spacemacs.
@ -54,7 +54,6 @@ pip install pycscope
#+END_SRC #+END_SRC
* Usage * Usage
Before using any helm-cscope commands, remember to create a Cscope index file. Before using any helm-cscope commands, remember to create a Cscope index file.
Do it by running the command =cscope-index-files= for C and C++ projects, or the Do it by running the command =cscope-index-files= for C and C++ projects, or the
command =cscope/run-pycscope= for Python projects, bound to ~SPC m g i~. command =cscope/run-pycscope= for Python projects, bound to ~SPC m g i~.

14
layers/deft/README.org
View File

@ -1,12 +1,12 @@
#+TITLE: Deft configuration layer for Spacemacs #+TITLE: Deft configuration layer for Spacemacs
* Table of Content :TOC@4: * Table of Content :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#differences-from-default][Differences from default]] - [[Differences from default][Differences from default]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description

16
layers/finance/README.org
View File

@ -1,13 +1,13 @@
#+TITLE: Finance contribution layer for Spacemacs #+TITLE: Finance contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#ledger][Ledger]] - [[Ledger][Ledger]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#ledger][Ledger]] - [[Ledger][Ledger]]
* Description * Description

13
layers/floobits/README.org
View File

@ -2,20 +2,17 @@
[[file:img/floobits.png]] [[file:img/floobits.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
* Description * Description
This layer adds support for peer programming tool [[https://github.com/Floobits/floobits-emacs][floobits]]. This layer adds support for peer programming tool [[https://github.com/Floobits/floobits-emacs][floobits]].
* Install * Install
** Layer ** Layer
To use this contribution add it to your =~/.spacemacs= To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp

22
layers/geolocation/README.org
View File

@ -1,16 +1,16 @@
#+TITLE: Geolocation contribution layer for Spacemacs #+TITLE: Geolocation contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#supported-packages-in-this-layer][Supported packages in this layer]] - [[Supported packages in this layer][Supported packages in this layer]]
- [[#install][Install]] - [[Install][Install]]
- [[#configuration][Configuration]] - [[Configuration][Configuration]]
- [[#location][Location]] - [[Location][Location]]
- [[#theme-changer][theme-changer]] - [[theme-changer][theme-changer]]
- [[#sunshine-weather-forecast][sunshine (weather forecast)]] - [[sunshine (weather forecast)][sunshine (weather forecast)]]
- [[#osx-location][osx-location]] - [[osx-location][osx-location]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#weather][Weather]] - [[Weather][Weather]]
* Description * Description
This layer offers few location sensitive adjustment to Emacs, such as This layer offers few location sensitive adjustment to Emacs, such as

16
layers/gtags/README.org
View File

@ -1,13 +1,13 @@
#+TITLE: Helm Gtags contribution layer for Spacemacs #+TITLE: Helm Gtags contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features]] - [[Features][Features]]
- [[#install][Install]] - [[Install][Install]]
- [[#gnu-global][GNU Global]] - [[GNU Global][GNU Global]]
- [[#usage][Usage]] - [[Usage][Usage]]
- [[#eldoc-integration][Eldoc integration]] - [[Eldoc integration][Eldoc integration]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

12
layers/ibuffer/README.org
View File

@ -1,11 +1,11 @@
#+TITLE: ibuffer contribution layer for Spacemacs #+TITLE: ibuffer contribution layer for Spacemacs
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#grouping-buffers][Grouping buffers]] - [[Grouping buffers][Grouping buffers]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
* Description * Description

16
layers/jabber/README.org
View File

@ -2,14 +2,14 @@
[[file:img/jabber-logo.gif]] [[file:img/jabber-logo.gif]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#install][Install]] - [[Install][Install]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#jabber-roster][Jabber Roster]] - [[Jabber Roster][Jabber Roster]]
- [[#hipchat][HipChat]] - [[HipChat][HipChat]]
- [[#authentication][Authentication]] - [[Authentication][Authentication]]
- [[#joining-rooms][Joining rooms]] - [[Joining rooms][Joining rooms]]
* Description * Description
This layer adds keybindings for jabber.el. jabber.el is a Jabber (XMPP) client for Emacs This layer adds keybindings for jabber.el. jabber.el is a Jabber (XMPP) client for Emacs

14
layers/nixos/README.org
View File

@ -2,13 +2,13 @@
[[file:img/nixos.jpg]] [[file:img/nixos.jpg]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#key-bindings][Key Bindings]] - [[Key Bindings][Key Bindings]]
- [[#nixos-options][NixOS Options]] - [[NixOS Options][NixOS Options]]
* Description * Description

56
layers/org/README.org
View File

@ -2,31 +2,30 @@
[[file:img/org.png]] [[file:img/org.png]]
* Table of Contents :TOC@4: * Table of Contents :TOC_4_org:noexport:
- [[#description][Description]] - [[Description][Description]]
- [[#features][Features:]] - [[Features:][Features:]]
- [[#note][Note]] - [[Note][Note]]
- [[#install][Install]] - [[Install][Install]]
- [[#layer][Layer]] - [[Layer][Layer]]
- [[#github-support][Github support]] - [[Github support][Github support]]
- [[#gnuplot-support][Gnuplot support]] - [[Gnuplot support][Gnuplot support]]
- [[#different-bullets][Different bullets]] - [[Different bullets][Different bullets]]
- [[#key-bindings][Key bindings]] - [[Key bindings][Key bindings]]
- [[#org][Org]] - [[Org][Org]]
- [[#org-with-evil-org-mode][Org with evil-org-mode]] - [[Org with evil-org-mode][Org with evil-org-mode]]
- [[#tables][Tables]] - [[Tables][Tables]]
- [[#tree-][Tree ]] - [[Tree ][Tree ]]
- [[#element-insertion][Element insertion]] - [[Element insertion][Element insertion]]
- [[#links][Links]] - [[Links][Links]]
- [[#emphasis][Emphasis]] - [[Emphasis][Emphasis]]
- [[#tagging][Tagging]] - [[Tagging][Tagging]]
- [[#pomodoro][Pomodoro]] - [[Pomodoro][Pomodoro]]
- [[#presentation][Presentation]] - [[Presentation][Presentation]]
- [[#org-repo-todo][Org-repo-todo]] - [[Org-repo-todo][Org-repo-todo]]
- [[#org-mime][Org-MIME]] - [[Org-MIME][Org-MIME]]
* Description * Description
This layer enables [[http://orgmode.org/][org mode]] for Spacemacs. This layer enables [[http://orgmode.org/][org mode]] for Spacemacs.
** Features: ** Features:
@ -78,6 +77,7 @@ You can tweak the bullets displayed in the org buffer in the function
* Key bindings * Key bindings
** Org ** Org
| Key Binding | Description | | Key Binding | Description |
|-------------+--------------------------------| |-------------+--------------------------------|
| ~SPC a o #~ | org agenda list stuck projects | | ~SPC a o #~ | org agenda list stuck projects |
@ -96,6 +96,7 @@ You can tweak the bullets displayed in the org buffer in the function
| ~SPC C T~ | ort/capture-checkitem | | ~SPC C T~ | ort/capture-checkitem |
** Org with evil-org-mode ** Org with evil-org-mode
| Key Binding | Description | | Key Binding | Description |
|----------------------------------------------+----------------------------------------------| |----------------------------------------------+----------------------------------------------|
| ~SPC m '~ | org-edit-special | | ~SPC m '~ | org-edit-special |
@ -129,6 +130,7 @@ You can tweak the bullets displayed in the org buffer in the function
| ~SPC s l~ | spacemacs/jump-in-buffer (jump to a heading) | | ~SPC s l~ | spacemacs/jump-in-buffer (jump to a heading) |
*** Tables *** Tables
| Key Binding | Description | | Key Binding | Description |
|---------------+----------------------------------------------------------------------------| |---------------+----------------------------------------------------------------------------|
| ~SPC m t a~ | Align the table at point by aligning all vertical bars | | ~SPC m t a~ | Align the table at point by aligning all vertical bars |
@ -160,6 +162,7 @@ You can tweak the bullets displayed in the org buffer in the function
| ~SPC m t w~ | Wrap several fields in a column like a paragraph | | ~SPC m t w~ | Wrap several fields in a column like a paragraph |
*** Tree *** Tree
| Key Binding | Description | | Key Binding | Description |
|-------------+-----------------------| |-------------+-----------------------|
| ~SPC m S l~ | org-demote-subtree | | ~SPC m S l~ | org-demote-subtree |
@ -199,6 +202,7 @@ You can tweak the bullets displayed in the org buffer in the function
| ~M-t~ | org-insert-todo-heading nil+ org-metaright | | ~M-t~ | org-insert-todo-heading nil+ org-metaright |
*** Element insertion *** Element insertion
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------------------------| |-------------+----------------------------------|
| ~SPC m h i~ | org-insert-heading-after-current | | ~SPC m h i~ | org-insert-heading-after-current |
@ -207,11 +211,13 @@ You can tweak the bullets displayed in the org buffer in the function
| ~SPC m i l~ | org-insert-link | | ~SPC m i l~ | org-insert-link |
*** Links *** Links
| Key Binding | Description | | Key Binding | Description |
|-------------+-------------------| |-------------+-------------------|
| ~RET~ | org-open-at-point | | ~RET~ | org-open-at-point |
*** Emphasis *** Emphasis
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------------------| |-------------+----------------------------|
| ~SPC m x b~ | make region bold | | ~SPC m x b~ | make region bold |
@ -223,11 +229,13 @@ You can tweak the bullets displayed in the org buffer in the function
| ~SPC m x v~ | make region verbose | | ~SPC m x v~ | make region verbose |
*** Tagging *** Tagging
| Key Binding | Description | | Key Binding | Description |
|-------------+--------------| |-------------+--------------|
| ~SPC m :~ | org-set-tags | | ~SPC m :~ | org-set-tags |
** Pomodoro ** Pomodoro
| Key Binding | Description | | Key Binding | Description |
|-------------+-------------------| |-------------+-------------------|
| ~SPC m p~ | starts a pomodoro | | ~SPC m p~ | starts a pomodoro |
@ -242,11 +250,13 @@ org-present must be activated explicitly by typing: ~SPC : org-present~
| ~q~ | quit | | ~q~ | quit |
** Org-repo-todo ** Org-repo-todo
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------| |-------------+----------------|
| ~SPC m g t~ | ort/goto-todos | | ~SPC m g t~ | ort/goto-todos |
** Org-MIME ** Org-MIME
| Key Binding | Description | | Key Binding | Description |
|-------------+---------------------------------------------------| |-------------+---------------------------------------------------|
| ~SPC m M~ | in =message-mode= buffers convert into html email | | ~SPC m M~ | in =message-mode= buffers convert into html email |

Some files were not shown because too many files have changed in this diff Show More