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

Format documenation files with doc-fmt tool

This commit is contained in:
syl20bnr 2016-04-12 23:31:38 -04:00
parent bdbe05e615
commit 07852abad5
54 changed files with 145 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/CONVENTIONS.org
View File

@ -321,6 +321,7 @@ implement an auto-save of the buffer before executing the tests of
buffer.
*** Language specific
| Key | Description |
|---------+--------------------------------------------------|
| ~m t m~ | execute the tests of the current module |

43
doc/DOCUMENTATION.org
View File

@ -789,18 +789,18 @@ your =~/.spacemacs=):
* Evil plugins
Spacemacs ships with the following evil plugins:
| Mode | Description |
|-------------------------------+----------------------------------------------------------|
| [[https://github.com/wcsmith/evil-args][evil-args]] | motions and text objects for arguments |
| [[https://github.com/Dewdrops/evil-exchange][evil-exchange]] | port of [[https://github.com/tommcdo/vim-exchange][vim-exchange]] |
| [[https://github.com/cofi/evil-indent-textobject][evil-indent-textobject]] | add text object based on indentation level |
| [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] | port of [[http://www.vim.org/scripts/script.php?script_id=39][matchit.vim]] |
| [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] | port of [[https://github.com/scrooloose/nerdcommenter][nerdcommenter]] |
| [[https://github.com/cofi/evil-numbers][evil-numbers]] | like ~C-a~ and ~C-x~ in vim |
| [[https://github.com/juanjux/evil-search-highlight-persist][evil-search-highlight-persist]] | emulation of hlsearch behavior |
| [[https://github.com/timcharper/evil-surround][evil-surround]] | port of [[https://github.com/tpope/vim-surround][vim-surround]] |
| [[https://github.com/bling/evil-visualstar][evil-visualstar]] | search for current selection with ~*~ |
| [[https://github.com/jaypei/emacs-neotree][NeoTree]] | mimic [[https://github.com/scrooloose/nerdtree][NERD Tree]] |
| Mode | Description |
|-------------------------------+--------------------------------------------|
| [[https://github.com/wcsmith/evil-args][evil-args]] | motions and text objects for arguments |
| [[https://github.com/Dewdrops/evil-exchange][evil-exchange]] | port of [[https://github.com/tommcdo/vim-exchange][vim-exchange]] |
| [[https://github.com/cofi/evil-indent-textobject][evil-indent-textobject]] | add text object based on indentation level |
| [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] | port of [[http://www.vim.org/scripts/script.php?script_id=39][matchit.vim]] |
| [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] | port of [[https://github.com/scrooloose/nerdcommenter][nerdcommenter]] |
| [[https://github.com/cofi/evil-numbers][evil-numbers]] | like ~C-a~ and ~C-x~ in vim |
| [[https://github.com/juanjux/evil-search-highlight-persist][evil-search-highlight-persist]] | emulation of hlsearch behavior |
| [[https://github.com/timcharper/evil-surround][evil-surround]] | port of [[https://github.com/tpope/vim-surround][vim-surround]] |
| [[https://github.com/bling/evil-visualstar][evil-visualstar]] | search for current selection with ~*~ |
| [[https://github.com/jaypei/emacs-neotree][NeoTree]] | mimic [[https://github.com/scrooloose/nerdtree][NERD Tree]] |
* Binding keys
Key sequences are bound to commands in Emacs in various keymaps. The most basic
@ -1383,6 +1383,7 @@ sequences are not optimal for Spacemacs. Indeed it is very easy in =visual
state= to press quickly ~jj~ and inadvertently escape to =normal state=.
*** Executing Vim and Emacs ex/M-x commands
| Command | Key Binding |
|------------------+-------------|
| Vim (ex-command) | ~:~ |
@ -1709,7 +1710,6 @@ The ~SPC j~ prefix is for jumping, joining and splitting.
| ~SPC j v~ | jump to the definition/declaration of the variable around point |
| ~SPC j w~ | jump to a word in the current buffer (works as an evil motion) |
**** Joining and splitting
| Key Binding | Description |
@ -2027,6 +2027,7 @@ open the file in a split window with ~|~ and ~-~:
| ~-~ | open file in an horizontally split window |
**** Other NeoTree key bindings
| Key Binding | Description |
|-------------+---------------------------------|
| ~TAB~ | toggle stretching of the buffer |
@ -2211,6 +2212,7 @@ file with =ag=.
called =pt=.
**** Useful key bindings
| Key Binding | Description |
|------------------------+--------------------------------------------------------------------------|
| ~F3~ | in a =helm= buffer, convert a =helm= search buffer into a regular buffer |
@ -2220,6 +2222,7 @@ called =pt=.
| Prefix argument | will ask for file extensions |
**** Searching in current file
| Key Binding | Description |
|-------------+-----------------------------------------------------|
| ~SPC s s~ | search with the first found tool |
@ -2230,6 +2233,7 @@ called =pt=.
| ~SPC s g G~ | =grep= with default input |
**** Searching in all open buffers visiting files
| Key Binding | Description |
|-------------+-----------------------------------------------------|
| ~SPC s b~ | search with the first found tool |
@ -2244,6 +2248,7 @@ called =pt=.
| ~SPC s t B~ | =pt= with default text |
**** Searching in files in an arbitrary directory
| Key Binding | Description |
|-------------+-----------------------------------------------------|
| ~SPC s f~ | search with the first found tool |
@ -2258,6 +2263,7 @@ called =pt=.
| ~SPC s t F~ | =pt= with default text |
**** Searching in a project
| Key Binding | Description |
|-----------------------+-----------------------------------------------------|
| ~SPC /~ or ~SPC s p~ | search with the first found tool |
@ -2275,6 +2281,7 @@ file beforehand. To do so use ~SPC p p~ and then ~C-s~ on a given project to
directly search into it like with ~SPC s p~.
**** Searching the web
| Key Binding | Description |
|-------------+----------------------------------------------------------------------|
| ~SPC s w g~ | Get Google suggestions in emacs. Opens Google results in Browser. |
@ -2585,6 +2592,7 @@ editing of the currently selected text by pressing ~e~.
**** iedit states key bindings
***** State transitions
| Key Binding | From | To |
|-------------+------------------+--------|
| ~SPC s e~ | normal or visual | iedit |
@ -2635,6 +2643,7 @@ specific to =iedit state=.
an ~occurrence~.
***** In iedit-insert state
| Key Binding | Description |
|-------------+---------------------------|
| ~ESC~ | go back to =iedit state= |
@ -2767,6 +2776,7 @@ These commands automatically switch to =lisp state=.
| ~SPC k y~ | copy expression |
***** Emacs lisp specific key bindings
| Key Binding | Function |
|-------------+--------------------------------------------|
| ~SPC m e $~ | go to end of line and evaluate last sexp |
@ -2777,7 +2787,6 @@ These commands automatically switch to =lisp state=.
| ~SPC m e l~ | go to end of line and evaluate last sexp |
| ~SPC m e r~ | evaluate region |
| Key Binding | Function |
|-------------+----------------------------------------------------|
| ~SPC m g g~ | go to definition |
@ -2970,6 +2979,7 @@ with ~SPC SPC spacemacs/recompile-elpa~.
* Achievements
** Issues
| Achievements | Account |
|---------------------------+--------------|
| [[https://github.com/syl20bnr/spacemacs/pull/100][100th issue (PR)]] | [[https://github.com/danielwuz][danielwuz]] |
@ -2987,6 +2997,7 @@ with ~SPC SPC spacemacs/recompile-elpa~.
| [[https://github.com/syl20bnr/spacemacs/pull/4000][4000th issue (issue)]] | [[https://github.com/icymist][icymist]] |
** Merged Pull Requests
| Achievements | Account |
|---------------------+----------------|
| [[https://github.com/syl20bnr/spacemacs/pull/228][100th pull request]] | [[https://github.com/bru][bru]] |
@ -2999,6 +3010,7 @@ with ~SPC SPC spacemacs/recompile-elpa~.
| [[https://github.com/syl20bnr/spacemacs/pull/4089][2000th pull request]] | [[https://github.com/channingwalton][channingwalton]] |
** Stars, forks and watchers
| Achievements | Account |
|-------------------+-----------------|
| 100th watcher | [[https://github.com/adouzzy][adouzzy]] |
@ -3020,12 +3032,14 @@ with ~SPC SPC spacemacs/recompile-elpa~.
| 6000th star!!!!!! | [[https://github.com/NJBS][NJBS]] |
** Gitter chat
| Achievements | Account |
|---------------------------------+-------------|
| First joiner on the Gitter Chat | [[https://github.com/trishume][trishume]] |
| 1000th joiner | [[https://github.com/gabrielpoca][gabrielpoca]] |
** First times
| Achievements | Account |
|---------------------------------+--------------|
| [[https://github.com/syl20bnr/spacemacs/pull/19][First contribution]] | [[https://github.com/trishume][trishume]] |
@ -3034,6 +3048,7 @@ with ~SPC SPC spacemacs/recompile-elpa~.
| [[https://github.com/syl20bnr/spacemacs/commit/7b44a56263049482ed540ed6815a295633ffe9d1][First contributed banner]] | [[https://github.com/chrisbarrett][chrisbarrett]] |
** Specials
| Achievements | Account |
|-------------------------------------------------+--------------|
| The Gunner (18 PRs in a row) | [[https://github.com/ralesi][ralesi]] |

4
doc/FAQ.org
View File

@ -44,7 +44,7 @@
- [[#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?]]
- [[#the-powerline-isnt-shown-correctly-when-spacemacs-is-used-within-putty][The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.]]
- [[#the-powerline-isnt-shown-correctly-when-spacemacs-is-used-within-putty][The powerline isn't shown correctly when Spacemacs is used within =PuTTY=]]
- [[#os-x][OS X]]
- [[#why-are-the-powerline-colors-not-correct-on-os-x][Why are the powerline colors not correct on OS X?]]
@ -504,7 +504,7 @@ Check if your Emacs has HTTPS capabilities by doing =M-:= and then:
If this returns =nil=, you need to install the GnuTLS DLL 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.
** The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.
** The powerline isn't shown correctly when Spacemacs is used within =PuTTY=
You can follow [[http://mschulte.nl/posts/using-powerline-in-PuTTY.html][this explanation]] explaining how to correct this.
* OS X

1
doc/LAYERS.org
View File

@ -326,6 +326,7 @@ information about recipes.
Packages may be /excluded/ by setting the =:excluded= property to true. This
will prevent the package from being installed even if it is used by another
layer.
** packages-config.el
For each included package, you may define one or more of the following
functions, which are called in order by Spacemacs to initialize the package.

5
doc/VIMUSERS.org
View File

@ -129,7 +129,7 @@ are located under the ~SPC b~ prefix.
| ~SPC b d~ or ~:bdelete~ | Kill current buffer. |
| ~SPC b k~ | Search for a buffer to kill. |
| ~SPC b K~ | Kill all buffers except the current buffer. |
| ~SPC b .~ | Buffer transient-state. |
| ~SPC b .~ | Buffer transient-state. |
**** Special buffers
By default Emacs creates a lot of buffers that most people will never need, like
@ -146,7 +146,7 @@ once. All window keybindings are under the ~SPC w~ prefix.
| ~SPC w s~ or ~:split~ | Opens a horizontal split below. |
| ~SPC w h/j/k/l~ | Navigate among windows. |
| ~SPC w H/J/K/L~ | Move the current window. |
| ~SPC w .~ | Window transient-state. |
| ~SPC w .~ | Window transient-state. |
** Files
All file commands in Spacemacs are available under the ~SPC f~ prefix.
@ -449,7 +449,6 @@ that is loaded at startup. Here is an example:
gotham)))
#+end_src
All installed themes can be listed and chosen using the ~SPC T h~ keybinding.
*** Nohlsearch

5
layers/+chat/jabber/README.org
View File

@ -24,7 +24,6 @@ file.
| Key Binding | Description |
| ~SPC a j~ | Connect all accounts |
** Jabber Roster
| Key Binding | Description |
| ~SPC m a~ | Jabber send presence |
@ -42,7 +41,7 @@ file.
* HipChat
** Authentication
To find YOUR_JABBER_ID visit "XMPP/Jabber info" section on your profile page at hipchat.com
To find YOUR_JABBER_ID visit "XMPP/Jabber info" section on your profile page at hipchat.com
#+begin_src emacs-lisp
(setq ssl-program-name "gnutls-cli"
@ -62,7 +61,7 @@ To simplify joining rooms, you can use something like this:
(defvar hipchat-room-list '(
("HIPCHAT NAME" . "XMPP/JABBER NAME")
))
(defvar hipchat-number "")
(defvar hipchat-nickname "YOU_NICKNAME")
(defun hipchat-join ()

10
layers/+chat/rcirc/README.org
View File

@ -26,13 +26,13 @@ and ZNC.
* Features
- Store channel logs into =~/.emacs.d/.cache/rcirc-logs/<channel>=
- Support for credentials stored in =~/.authinfo.gpg= (need to have gnutls)
- Support for credentials stored in =~/.authinfo.gpg= (need to have gnutls)
- Support ZNC support (with optional =~/.authinfo.gpg=)
- Colored nicknames
- WIP: Real time change when people use =/s/foo/bar= in the chats
- Completion of Emojis using [[https://github.com/dunn/company-emoji][company-emoji]] (still needs a way of showing, either
using the =emoji= layer or having a proper font) :clap:
* Install
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@ -47,7 +47,7 @@ There are several ways to configure rcirc supported by the layer:
but still not secured)
- By storing your credentials in authinfo (secured)
- By using a ZNC bouncer _and_ storing your credentials (secured)
*** Storing the credentials in your dotfile
You can store your servers configuration along with your credentials in the
=dotspacemacs/user-config= of your dotfile.
@ -92,7 +92,7 @@ rcirc.
1) If you want to use =authinfo.gpg= you have to enable the support for it by
setting =rcirc-enable-authinfo-support= to =t= in your dotfile:
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
(rcirc :variables rcirc-enable-authinfo-support t)))
@ -184,7 +184,7 @@ In normal state:
| ~C-k~ | previous item in history |
* 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]].
* Spacemacs Layout Support

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

@ -2,7 +2,6 @@
[[file:img/terraform.png]]
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#install][Install]]

4
layers/+emacs/org/README.org
View File

@ -15,7 +15,7 @@
- [[#org][Org]]
- [[#org-with-evil-org-mode][Org with evil-org-mode]]
- [[#tables][Tables]]
- [[#tree-][Tree ]]
- [[#tree][Tree]]
- [[#element-insertion][Element insertion]]
- [[#links][Links]]
- [[#emphasis][Emphasis]]
@ -184,7 +184,7 @@ You can tweak the bullets displayed in the org buffer in the function
| ~SPC m t t o~ | Toggle the display of Row/Column numbers in tables |
| ~SPC m t w~ | Wrap several fields in a column like a paragraph |
*** Tree
*** Tree
| Key Binding | Description |
|-------------+-----------------------|

7
layers/+emacs/semantic/README.org
View File

@ -1,5 +1,12 @@
#+TITLE: Semantic layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#features][Features]]
- [[#install][Install]]
- [[#key-bindings][Key Bindings]]
* Description
CEDET is a *C*ollection of *E*macs *D*evelopment *E*nvironment *T*ools written

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

@ -23,7 +23,7 @@ new users so the basics are listed here:
- Group :: A Newsgroup but can also be a RSS Feed or a mail directory
- Topic :: Newsgroups can be assigned to topics which will be used to structure
the Group Buffer if Topic Mode is enabled(default).
* Adding news sources
Adding news sources can be done in your =.spacemacs= file by adding the
@ -46,7 +46,7 @@ For adding RSS Feeds please see the [[Keybindings][keybindings section]].
* Configuring gmail
To configure Gnus with gmail support you can add the following to your
=.spacemacs= file.
=.spacemacs= file.
#+BEGIN_SRC emacs-lisp
;; Get email, and store in nnml

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

@ -108,7 +108,6 @@ And if you want to have 2 space indent also for element's attributes, concatenat
(add-to-list 'web-mode-indentation-params '("lineup-calls" . nil)))
#+end_src
* Key Bindings
** js2-mode

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

@ -17,7 +17,7 @@ This layer adds support for Emoji emoticons from [[http://www.emoji-cheat-sheet.
- Display Emoji images in buffer
- Insert one or several Emoji with an helm front-end
- Completion of Emojis using [[https://github.com/dunn/company-emoji][company-emoji]]
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =emoji= to the existing =dotspacemacs-configuration-layers= list in this

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

@ -20,7 +20,7 @@ The games available now are:
- Pacmacs (Pacman for Emacs)
- Tetris
- Typit
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =games= to the existing =dotspacemacs-configuration-layers= list in this
@ -37,7 +37,7 @@ Possible helm actions:
- run (default)
- quit
- reset
** 2048
| Key Binding | Description |

6
layers/+intl/chinese/README.org
View File

@ -37,7 +37,7 @@ file.
** Configuration
*** Configure the Default Input Method(配置默认中文输入法)
The default Chinese input method is =Chinese-pyim=, if you are a Wubi(五笔) user,
The default Chinese input method is =Chinese-pyim=, if you are a Wubi(五笔) user,
you could set the variable =chinese-default-input-method= to =wubi=:
#+begin_src emacs-lisp
(setq-default dotspacemacs-configuration-layers '(
@ -50,6 +50,7 @@ file. You could call =pyim-dicts-manager= to open up the settings buffer and
press =i e= to install the default lexicon. The lexicon is about 20M, so you
should be patient when downloading starts. After the lexicon file is downloaded,
just press =s= to save and =R= to restart configuration.
*** Enable fcitx
#+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers '((chinese :variables
@ -61,6 +62,7 @@ with the following configuration.
#+BEGIN_SRC emacs-lisp
(fcitx-aggressive-setup)
#+END_SRC
**** Requirement
***** Linux
You need use this with =fcitx= and make sure =fcitx-remote= is in your search path.
@ -106,7 +108,7 @@ your own Chinese font name in =dotspacemacs/user-config= function.
Example configuration:
#+BEGIN_SRC emacs-lisp
;; Note: The Hiragino Sans GB is bundled with MacOS X.
;; Note: The Hiragino Sans GB is bundled with MacOS X.
;; If you are not using MacOS X, you should change it to another Chinese font name.
(spacemacs//set-monospaced-font "Source Code Pro" "Hiragino Sans GB" 14 16)
#+END_SRC

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

@ -80,7 +80,7 @@ lower/upper-case consistent.
Some bepo keys are not used in traditional mapping, mainly because they are not
on the =en-us= keyboard layout. They are used as aliases for other shortcuts:
- Map unused ~é~ key as an alias of ~w~, more useful in vim mode:
- ~é → w~
- ~É → W~

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

@ -36,10 +36,10 @@ This layer adds support for [[http://clojure.org][Clojure]] language using [[htt
* Features
- REPL via [[https://github.com/clojure-emacs/cider][CIDER]]
- Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]]
- Code formatting via [[https://github.com/clojure-emacs/cider][CIDER]] using [[https://github.com/weavejester/cljfmt][Cljfmt]]
- Refactoring via [[https://github.com/clojure-emacs/clj-refactor.el][clj-refactor]]
- Aligning of code forms via [[https://github.com/clojure-emacs/clojure-mode][clojure-mode]]
* Install
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@ -84,7 +84,7 @@ Or set this variable when loading the configuration layer:
*** Quick Start with lein
- Install =lein= version 2.5.2 or newer (see http://leiningen.org/#install)
- Create a file =~/.lein/profiles.clj= with the following content:
#+BEGIN_SRC clojure
{:repl {:plugins [[cider/cider-nrepl "0.10.0-SNAPSHOT"]
[refactor-nrepl "2.0.0-SNAPSHOT"]]
@ -100,7 +100,7 @@ Or set this variable when loading the configuration layer:
More info regarding installation of nREPL middleware can be found here:
- CIDER: [[https://github.com/clojure-emacs/cider#installation][cider_install]]
- clj-refactor: [[https://github.com/clojure-emacs/refactor-nrepl][refactor-nrepl]]
* Key Bindings
** Working with clojure files (barfage, slurpage & more)
Spacemacs comes with a special ~lisp-state~ for working with lisp code that
@ -232,6 +232,7 @@ As this state works the same for all files, the documentation is in global
| ~SPC m r u w~ | unwind |
*** Reformatting
| Key Binding | Description |
|-------------+-------------------------|
| ~SPC m f l~ | realign current form |

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

@ -94,7 +94,6 @@ As this state works the same for all files, the documentation is in global
*** Navigation
| Key Binding | Description |
|---------------------------+--------------------|
| ~SPC m g g~ | Inspect definition |

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

@ -26,7 +26,7 @@ This layer adds experimental support for C# language using [[https://github.com/
* Packages Included
- [[https://github.com/OmniSharp/omnisharp-emacs][OmniSharp-emacs]]
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =csharp= to the existing =dotspacemacs-configuration-layers= list in this
@ -70,7 +70,7 @@ OmniSharp should now automatically load and start a server when you open a
solutions.
- Debugging is possible using [[https://github.com/mono/sdb][SDB]].
* Key Bindings
** Compilation

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

@ -112,7 +112,6 @@ You find and overview of all the key-bindings on the [[file:alchemist-refcard.pd
| ~SPC m c b~ | Compile the current buffer with elixirc. =elixirc= |
| ~SPC m c f~ | Compile the given filename with =elixirc= |
** Execute
| Key Binding | Description |

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

@ -44,7 +44,7 @@ file.
** Elm Platform
The ~elm-platform~ is a bundle of tools, including the ~elm-compiler~, ~elm-make~,
~elm-reactor~, ~elm-repl~ and ~elm-package~.
~elm-reactor~, ~elm-repl~ and ~elm-package~.
Depending on the method of installation, the ~elm-mode~ package would need to be
able to access commands such as ~elm-reactor~ or ~elm-make~.
@ -63,7 +63,7 @@ Also, note that you might need to set the ~ELM_HOME~ environment variables to
the corresponding directory created by the installer.
OS X Users facing problems with ~elm-reactor~ failing to properly install or
run, see this issue [[https://github.com/kevva/elm-bin/issues/28][https://github.com/kevva/elm-bin/issues/28]].
run, see this issue [[https://github.com/kevva/elm-bin/issues/28][https://github.com/kevva/elm-bin/issues/28]].
*** Source code
To build from source, see instructions here:
@ -75,7 +75,7 @@ cursor and provide support for auto-completion, but it is not part of the standa
elm-platform.
Both the "company" and "auto-complete" backends are supported, but this layer
is configured with company.
is configured with company.
To install ~elm-oracle~, install ~node.js~ and ~npm~, then
run this command:

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

@ -60,7 +60,7 @@ As this state works the same for all files, the documentation is in global
| ~SPC m ​,​~ | toggle =lisp state= |
| ~SPC m t b~ | run tests of current buffer |
| ~SPC m t q~ | run =ert= |
| ~SPC m d m~ | open [[https://github.com/joddie/macrostep][macrostep]] transient-state |
| ~SPC m d m~ | open [[https://github.com/joddie/macrostep][macrostep]] transient-state |
** srefactor
The [[file:../../semantic/README.org][semantic]] layer should be installed for these key bindings to become active.

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

@ -43,6 +43,7 @@ Send code to inferior process with these commands:
** Helpers
Helpers for inspecting objects at point are available in R buffers only.
| Key Binding | Description |
|-------------+---------------------------------------------------------------------|
| ~SPC m h d~ | view data under point using [ess-R-data-view][ess-R-data-view] |

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

@ -16,7 +16,7 @@ This layer adds support for F# language using [[https://github.com/fsharp/fsharp
* Packages Included
- [[https://github.com/fsharp/fsharpbinding][fsharp-mode]]
* Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =fsharp= to the existing =dotspacemacs-configuration-layers= list in this
@ -24,7 +24,6 @@ file.
* Key Bindings
| Key Binding | Description |
|-------------+----------------------------|
| ~SPC m c c~ | Build the project |

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

@ -96,7 +96,6 @@ function testing to work.
| ~SPC m t t~ | run "go test" for the function you're currently in (while you're in a _.test.go file) |
| ~SPC m t s~ | run "go test" for the suite you're currently in (requires gocheck) |
** Go Oracle
| Key Binding | Description |

1
layers/+lang/graphviz/README.org
View File

@ -25,6 +25,7 @@ try to adjust the value of =graphviz-dot-revert-delay= higher to give the
compiler more time to finish generating the file before reverting the buffer.
* Key bindings
| Key Binding | Description |
|-------------+--------------------------------------|
| ~SPC m ,~ | Preview file |

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

@ -60,7 +60,7 @@ A transient-state is also defined, start it with ~SPC m .~ or ~, .~
| ~K~ / ~gk~ | previous sibling element |
| ~l~ | first child element |
| ~p~ | show xpath of current element |
| ~q~ | leave the transient-state |
| ~q~ | leave the transient-state |
| ~r~ | rename current element |
| ~w~ | wrap current element |

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

@ -74,6 +74,7 @@ are reproduced under the local leader.
| ~SPC m h t~ | Get the type for the identifier under point. |
** REPL
| Key Binding | Description |
|-------------+----------------------------------------------------------------------------------------|
| ~SPC m s b~ | Load the current buffer into Idris. |

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

@ -5,8 +5,8 @@
- [[#features][Features]]
- [[#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]]
- [[#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.]]
- [[#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]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#dependencies][Dependencies]]
@ -35,20 +35,23 @@ lots of informative stuff.
* List of TODOS
This is a WIP, feel free to collaborate.
** TODO Maybe it'd be better if there was a state for this
** TODO Make more keybinding to =connect= to a python buffer.
** TODO Deleting visual regions don't work, find out why.
** TODO Make more keybinding to =connect= to a python buffer
** TODO Deleting visual regions don't work, find out why
* Install
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =ipython-notebook= to the existing =dotspacemacs-configuration-layers= list
in this file.
** Dependencies
Install IPython > 3
#+begin_src sh
pip install ipython
#+end_src
** What needs to be run
Have an IPython notebook running
#+begin_src sh
@ -59,6 +62,7 @@ Have an IPython notebook running
** Open Notebook List
This layer is lazy loaded so the transient-state will only work after you summon the
command =ein:notebooklist-open= which is bound to ~SPC a i n~
** Key Bindings
The key bindings can be used through a transient state or the usual evil-leader.
@ -141,6 +145,7 @@ In traceback mode the following key bindings are defined:
* Screenshots
** Light
[[file:img/light.png]]
** Dark
[[file:img/dark.png]]

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

@ -53,6 +53,7 @@ option in =emacs-eclim= itself.
* Key bindings
** Java-mode
*** Project management
| Key Binding | Description |
|-------------+--------------------------------|
| ~SPC m p b~ | Build project |
@ -67,6 +68,7 @@ option in =emacs-eclim= itself.
| ~SPC m p u~ | Update project |
*** Maven
| Key Binding | Description |
|-------------+--------------------------------|
| ~SPC m m i~ | Run maven clean install |
@ -77,6 +79,7 @@ option in =emacs-eclim= itself.
| ~SPC m m t~ | Run maven test |
*** Goto
| Key Binding | Description |
|-------------+---------------------------------------------|
| ~M-​,​~ | jump back from go to declaration/definition |
@ -84,6 +87,7 @@ option in =emacs-eclim= itself.
| ~SPC m g t~ | go to type definition |
*** Refactoring
| Key Binding | Description |
|-------------+------------------|
| ~SPC m r i~ | optimize imports |
@ -91,6 +95,7 @@ option in =emacs-eclim= itself.
| ~SPC m r r~ | Rename symbol |
*** Documentation, Find
| Key Binding | Description |
|-------------+----------------------------------------|
| ~SPC m f f~ | general find in project |
@ -98,6 +103,7 @@ option in =emacs-eclim= itself.
| ~SPC m h u~ | show usages for symbol at point |
*** Problems
| Key Binding | Description |
|-------------+--------------------------------------------|
| ~SPC m e a~ | set all problems for next/prev action |
@ -111,12 +117,13 @@ option in =emacs-eclim= itself.
| ~SPC m e w~ | set warnings for next/prev action |
*** Tests
| Key Binding | Description |
|-------------+---------------------------------------------------------------|
| ~SPC m t t~ | run JUnit tests for current method or current file or project |
** Problems buffer
| Key Binding | Description |
|-------------+-------------------------------------|
| ~RET~ | go to problem place |
@ -128,6 +135,7 @@ option in =emacs-eclim= itself.
| ~w~ | show only warnings |
** Projects buffer
| Key Binding | Description |
|-------------+--------------------------------------------|
| ~RET~ | go to current project |

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

@ -88,7 +88,7 @@ run-skewer command in your javascript buffer. If you want to inject it
in your own page, follow the instructions in
https://github.com/skeeto/skewer-mode#skewering-with-cors (install the
Greasemonkey script and then click the triangle in the top-right
corner - if it turns green, you're good to go).
corner - if it turns green, you're good to go).
* Key Bindings
@ -188,7 +188,6 @@ You can check more [[https://github.com/mooz/js-doc/][here]]
| ~SPC m e e~ | evaluates the last expression |
| ~SPC m e E~ | evaluates and inserts the result of the last expression at point |
| Key Binding | Description |
|-------------+------------------------------------------------------------------------------------|
| ~SPC m s a~ | Toggle live evaluation of whole buffer in REPL on buffer changes |

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

@ -10,7 +10,7 @@
- [[#key-bindings][Key bindings]]
- [[#element-insertion][Element insertion]]
- [[#element-removal][Element removal]]
- [[#completion-and-cycling][Completion, and Cycling]]
- [[#completion][Completion]]
- [[#following-and-jumping][Following and Jumping]]
- [[#indentation][Indentation]]
- [[#header-navigation][Header navigation]]

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

@ -22,6 +22,7 @@ file.
* Working with Nim
** Nim commands (start with =m=):
| Key Binding | Description |
|-------------+----------------------------|
| ~SPC m c r~ | nim compile --run main.nim |

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

@ -37,7 +37,7 @@ This layer requires some [[http://opam.ocaml.org][opam]] packages:
- =utop=
- =ocp-indent=
To install them, use the following command:
To install them, use the following command:
#+BEGIN_SRC sh
opam install merlin utop ocp-indent

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

@ -36,7 +36,7 @@ Send code to inferior process with these commands:
** Helpers
| Key Binding | Description |
|-------------+-----------------------------------------------------|
| ~SPC m h h~ | view documentation for function at point |
| ~SPC m h i~ | read octave info documentation |
| Key Binding | Description |
|-------------+------------------------------------------|
| ~SPC m h h~ | view documentation for function at point |
| ~SPC m h i~ | read octave info documentation |

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

@ -1,5 +1,5 @@
#+TITLE: PHP layer
[[file:img/php.png]]
* Table of Contents :TOC_4_gh:noexport:

2
layers/+lang/plantuml/README.org
View File

@ -1,5 +1,6 @@
#+TITLE: plantuml layer
[[file:img/logo.png]]
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#install][Install]]
@ -30,7 +31,6 @@ robbyoconnor->theOtherPerson : And they thinks it's funny? Yup, they definitely
[[file:img/dia.png]]
* Install
To use this contribution add it to your =~/.spacemacs=

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

@ -84,6 +84,7 @@ To use scalastyle,
the jar.
See the [[http://flycheck.readthedocs.org/en/latest/guide/languages.html#el.flycheck-checker.scala-scalastyle][flycheck documentation]] for up-to-date configuration instructions.
* Automatically show the type of the symbol under the cursor
To enable the feature =ensime-print-type-at-point= when cursor moves, set the

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

@ -4,7 +4,7 @@
- [[#description][Description]]
- [[#install][Install]]
- [[#key-bindings][Key Bindings]]
- [[#compiling-][Compiling ]]
- [[#compiling][Compiling]]
- [[#navigation][Navigation]]
- [[#documentation][Documentation]]
- [[#insertion][Insertion]]
@ -34,7 +34,7 @@ For full Chicken support, the following commands should be run:
* Key Bindings
** Compiling
** Compiling
| Key Binding | Description |
|-------------+----------------------------|

4
layers/+lang/swift/README.org
View File

@ -28,7 +28,7 @@ First check that you are able to run this from the command line:
On OS X:
#+BEGIN_SRC sh
xcrun swift
xcrun swift
#+END_SRC
Then to use this configuration layer, add it to your =~/.spacemacs=. You will
@ -50,7 +50,7 @@ The universal prefix ~SPC u~ (~C-u~) may be used to modify command invocation.
| ~SPC m s b~ | swift-mode-send-buffer |
| ~SPC m s r~ | swift-mode-send-region |
Notes:
Notes:
1. ~swift-mode-run-repl~ will run or switch to an existing REPL.
2. To edit the command invocation, prefix with ~SPC u~ (or ~C-u~).
3. Emacs key bindings in use are the those set by the package.

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

@ -10,7 +10,7 @@
- [[#notes][Notes]]
- [[#key-bindings][Key bindings]]
- [[#typescript-major-mode][Typescript Major Mode]]
- [[#reference-major-mode--------------------------][Reference Major Mode ]]
- [[#reference-major-mode][Reference Major Mode]]
* Description
@ -32,9 +32,9 @@ This layer provides:
** Pre-requisites
You will need =node.js v0.12.0= or greater
If you want linting run: =npm install -g typescript= =npm install -g tslint=
If you want linting run: =npm install -g typescript= =npm install -g tslint=
If you want formatting run: =npm install -g typescript-formatter=
If you want formatting run: =npm install -g typescript-formatter=
For best results, make sure that the =auto-completion= (company) and =html= layers are enabled.
@ -95,8 +95,7 @@ Currently tsserver doesn't pickup tsconfig.json file changes. You might need to
| ~SPC m r r~ | rename symbol |
| ~SPC m s r~ | restart server |
** Reference Major Mode
** Reference Major Mode
| Key Binding | Description |
|-------------+-------------------------|

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

@ -1,6 +1,5 @@
#+TITLE: Git contribution layer for Spacemacs
[[file:img/git.png]]
* Table of Contents :TOC_4_gh:noexport:

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

@ -59,11 +59,11 @@ one over the other:
* Key Bindings
| Key Binding | Description |
|-------------+------------------------------|
| ~SPC g .~ | version control transient-state |
| ~SPC T d~ | toggle diff margins |
| ~SPC T C-d~ | toggle diff margins globally |
| Key Binding | Description |
|-------------+---------------------------------|
| ~SPC g .~ | version control transient-state |
| ~SPC T d~ | toggle diff margins |
| ~SPC T C-d~ | toggle diff margins globally |
** Version Control Transient-state

11
layers/+themes/colors/local/nyan-mode/README.org
View File

@ -1,3 +1,14 @@
#+TITLE:nyan-mode
* Table of Contents :TOC_4_gh:noexport:
- [[#nyan-mode---turn-your-emacs-into-nyanmacs-][Nyan Mode - Turn your Emacs into Nyanmacs! :)]]
- [[#fork-modifications][Fork modifications]]
- [[#introduction][Introduction]]
- [[#features][Features]]
- [[#using-nyan-mode-with-custom-modeline][Using Nyan Mode with custom modeline]]
- [[#known-issues][Known issues]]
- [[#credits][Credits]]
* Nyan Mode - Turn your Emacs into Nyanmacs! :)
** Fork modifications

4
layers/+tools/chrome/README.org
View File

@ -51,8 +51,8 @@ To change frame defaults (width, height, etc. use =edit-server-new-frame-alist=)
If you want Emacs to switch focus to Chrome after done editing, you can utilize =edit-server-done-hook=.
Emacs cannot control focus of windows for external apps, so you need to use some sort of command line window manager like =wmctrl=.
The following example works on OS X:
The following example works on OS X:
#+BEGIN_SRC emacs-lisp
(add-hook 'edit-server-done-hook (lambda () (shell-command "open -a \"Google Chrome\"")))
(add-hook 'edit-server-done-hook (lambda () (shell-command "open -a \"Google Chrome\"")))
#+END_SRC

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

@ -14,7 +14,7 @@
- [[#helm-dash][helm-dash]]
- [[#todos][TODOs]]
- [[#check-zeal][Check zeal]]
- [[#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][Make helm-dash use zeal or dash docsets by default]]
* Description
+*This layer works only on OS X for the moment*+
@ -42,7 +42,7 @@ file.
You have to install [[http://kapeli.com/dash][dash]] on your machine.
It is recommended to set the =HUD mode= in your Dash application preferences
when using this layer.
when using this layer.
** Zeal (Linux & Windows)
@ -78,4 +78,4 @@ Or you can use [[https://github.com/areina/helm-dash][helm-dash]] instead, it re
CLOSED: [2015-06-12 Fri 16:30]
[[http://zealdocs.org/][zeal]] is an open source alternative to dash with Emacs integration available.
** TODO Make helm-dash use zeal or dash docsets by default.
** TODO Make helm-dash use zeal or dash docsets by default

2
layers/+tools/deft/README.org
View File

@ -20,7 +20,7 @@ you prefer that =Deft= recognize other extensions set an alternate
configuration by adding the following in your config file:
#+Begin_SRC emacs-lisp
(setq deft-extensions '("org" "md" "txt"))
(setq deft-extensions '("org" "md" "txt"))
#+END_SRC
Just add or substitute your preferred extension.

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

@ -3,7 +3,7 @@
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#install][Install]]
- [[#layer-][Layer ]]
- [[#layer][Layer]]
- [[#fasd][fasd]]
- [[#keybindings][Keybindings]]
@ -15,7 +15,7 @@ to quickly jump between locations in a POSIX shell.
The integration is implemented in the package [[https://github.com/steckerhalter/emacs-fasd][emacs-fasd]].
* Install
** Layer
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =fasd= to the existing =dotspacemacs-configuration-layers= list in this
file.

3
layers/+tools/geolocation/README.org
View File

@ -91,7 +91,7 @@ It will use the imperial unit system by default. To switch to metric, add
#+END_SRC
Weather forecast icons are disabled by default, and can be toggled by pressing
`i' within this mode's main buffer.
`i' within this mode's main buffer.
To display weather forecast icons by default ("pretty mode"), add
~sunshine-show-icons t~ to the variables list for this layer, or add this:
@ -112,6 +112,7 @@ activated.
* Key Bindings
** Weather
| Evil | Holy | Command |
|-----------+------+-----------------------------------------------|
| ~SPC a w~ | | Display pretty weather forecast |

4
layers/+tools/pdf-tools/README.org
View File

@ -59,7 +59,7 @@ If everything goes right, the compilation won't display any error and you will
be able to see /PDFView/ (instead of /DocView/) on the spaceline after opening a
pdf file.
If the compilation run successfully but you get
If the compilation run successfully but you get
~Error (use-package): pdf-tools :config: No executable `epdfinfo' found~,
try restarting Spacemacs ([[https://github.com/politza/pdf-tools/issues/31][issue]]).
@ -85,7 +85,7 @@ Tips:
lateral margins, making the useful portion larger.
- The last visited page is not saved across Emacs sessions. If you want save it,
use the bookmarks commands on ~SPC j b~ to save and go to a bookmark.
* Known Issues
Due to =image-mode='s behaviour, the =pdf-tools= buffer might go back to the
first page after switching windows. If this happens, you can quickly go back to

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

@ -7,4 +7,3 @@
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.

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

@ -22,6 +22,7 @@ add =evil-commentary= to the existing =dotspacemacs-configuration-layers= list i
file.
* Key bindings
| Key Binding | Description |
|-------------+-------------------------------|
| ~SPC ;~ | comment operator |

1
layers/+web-services/elfeed/README.org
View File

@ -92,6 +92,7 @@ By default web interface is available on [[http://localhost:8080/elfeed/][localh
the default port by changing the value of =httpd-port=.
* Key Bindings
| Key Binding | Description |
|-------------+--------------|
| ~SPC a f~ | start elfeed |

2
layers/+web-services/search-engine/README.org
View File

@ -33,7 +33,7 @@ This layer adds support for the [[https://github.com/hrs/engine-mode/engine-mode
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =search-engine= to the existing =dotspacemacs-configuration-layers= list in this
file.
* Key Bindings
| Evil | Holy | Command |