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

Format and cleanup docs. Fix links.

This commit is contained in:
JAremko 2017-04-25 18:42:58 +03:00 committed by syl20bnr
parent 276fa38a5f
commit c1e4556882
73 changed files with 304 additions and 224 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis-build.sh
View File

@ -147,7 +147,7 @@ if [ $TRAVIS_SECURE_ENV_VARS = true ] && [ ! -z "$PUBLISH" ]; then
exit 0 exit 0
else else
printf '=%.0s' {1..70} printf '=%.0s' {1..70}
printf "\n NOTING TO COMMIT!\n" printf "\n NOTHING TO COMMIT!\n"
printf '=%.0s' {1..70} printf '=%.0s' {1..70}
echo echo
exit 0 exit 0

11
COMMUNITY.org
View File

@ -31,6 +31,7 @@
intentions. intentions.
- In a nutshell: Be good, positive and/or with good intentions and focused on - In a nutshell: Be good, positive and/or with good intentions and focused on
the project. the project.
** For Users ** For Users
- Any question related to the project is welcomed and encouraged, the worst - Any question related to the project is welcomed and encouraged, the worst
thing that can happen is that we redirect you to the documentation. thing that can happen is that we redirect you to the documentation.
@ -51,18 +52,22 @@ by the collaborators since the beginning of the project which started officially
in August 2014. It should allow you to decide whether or not you want to be part in August 2014. It should allow you to decide whether or not you want to be part
of this community. If you are not convinced then be assured that the only evil of this community. If you are not convinced then be assured that the only evil
part in Spacemacs is the evil mode :-) part in Spacemacs is the evil mode :-)
** Guidelines ** Guidelines
These guidelines apply to all collaborators of the project, namely @syl20bnr, These guidelines apply to all collaborators of the project, namely @syl20bnr,
@TheBB, @d12frosted and @bmag. @TheBB, @d12frosted and @bmag.
*** People *** People
- Collaborators cannot ban any GitHub user from the repository but they can ban - Collaborators cannot ban any GitHub user from the repository but they can ban
users from the official Gitter channel. users from the official Gitter channel.
- A user can be banned if and only if all the collaborators agree to do so. - A user can be banned if and only if all the collaborators agree to do so.
- The reasons of the ban are mentioned in the moderation actions log (see - The reasons of the ban are mentioned in the moderation actions log (see
below). below).
*** Issues *** Issues
- Issues can be locked if their contents are judged _inappropriate_, _offending_ - Issues can be locked if their contents are judged _inappropriate_, _offending_
or if they deviate _dangerously_ from the project. or if they deviate _dangerously_ from the project.
*** Pull requests and Commmits *** Pull requests and Commmits
- Collaborators can push to the repository without making a PR. - Collaborators can push to the repository without making a PR.
- PR can be rejected. Rejected PR always go with a reason explicitly written - PR can be rejected. Rejected PR always go with a reason explicitly written
@ -71,6 +76,7 @@ These guidelines apply to all collaborators of the project, namely @syl20bnr,
reason is contained in the commit comments. reason is contained in the commit comments.
- Pull request are also issues, thus issue guidelines also apply to pull - Pull request are also issues, thus issue guidelines also apply to pull
requests. requests.
*** Messages *** Messages
- Only the form of a message can be edited, not its meaning, except if this - Only the form of a message can be edited, not its meaning, except if this
meaning is _outrageous_. meaning is _outrageous_.
@ -83,11 +89,13 @@ These guidelines apply to all collaborators of the project, namely @syl20bnr,
#+END_EXAMPLE #+END_EXAMPLE
- The reason is added only when needed (for instance we won't add a reason for - The reason is added only when needed (for instance we won't add a reason for
formatting edits) formatting edits)
** Interpretation ** Interpretation
Words used in these guidelines like _good_, _inappropriate_, _offending_, Words used in these guidelines like _good_, _inappropriate_, _offending_,
_dangerously_ and _outrageous_ are used without any explanation, their meanings _dangerously_ and _outrageous_ are used without any explanation, their meanings
and interpretations are left solely to the discretion of the collaborators who and interpretations are left solely to the discretion of the collaborators who
are educated persons working in the interest of the community. are educated persons working in the interest of the community.
** Collaborators privacy ** Collaborators privacy
Life and actions of collaborators outside of the project (i.e. outside of the Life and actions of collaborators outside of the project (i.e. outside of the
Spacemacs GitHub repository, official Spacemacs Gitter channels and Twitter Spacemacs GitHub repository, official Spacemacs Gitter channels and Twitter
@ -96,15 +104,18 @@ activities and roles in the project. They are free to express any opinion on the
project or any other subjects and those opinions cannot be used to compromise project or any other subjects and those opinions cannot be used to compromise
their roles in the project as long as they follow the moderation guidelines with their roles in the project as long as they follow the moderation guidelines with
good intentions. good intentions.
** Maintainer ** Maintainer
- The maintainer @syl20bnr as a BDFL is free to demote a collaborator in extreme - The maintainer @syl20bnr as a BDFL is free to demote a collaborator in extreme
situations. situations.
- When there is no consensus on a subject, the BDFL can decide to impose his - When there is no consensus on a subject, the BDFL can decide to impose his
view on the subject. view on the subject.
** Log ** Log
For transparency and future reference any major moderation actions are recorded For transparency and future reference any major moderation actions are recorded
here. As of Sunday, April 10th 2016, 7200 issues have been opened and 2 major here. As of Sunday, April 10th 2016, 7200 issues have been opened and 2 major
moderation actions have been taken: moderation actions have been taken:
| Date | Moderator | Action | Issue | Reason | | Date | Moderator | Action | Issue | Reason |
|------------+-----------+--------+-------+-----------------------------------------------------------------| |------------+-----------+--------+-------+-----------------------------------------------------------------|
| 2016/01/27 | syl20bnr | lock | #3484 | comments judged to be offending towards the Spacemacs community | | 2016/01/27 | syl20bnr | lock | #3484 | comments judged to be offending towards the Spacemacs community |

5
Dockerfile.emacs25
View File

@ -47,7 +47,7 @@ RUN cp ${UHOME}/.emacs.d/core/templates/.spacemacs.template ${UHOME}/ \
&& asEnvUser emacs -batch -u ${UNAME} -kill \ && asEnvUser emacs -batch -u ${UNAME} -kill \
&& chmod ug+rw -R ${UHOME} && chmod ug+rw -R ${UHOME}
# test Spacemacs # Test Spacemacs
RUN asEnvUser make -C ${UHOME}/.emacs.d/tests/core/ test \ RUN asEnvUser make -C ${UHOME}/.emacs.d/tests/core/ test \
&& cd ${UHOME}/.emacs.d \ && cd ${UHOME}/.emacs.d \
&& printf "SPACEMACS REVISION: %s\n" "$(git rev-parse --verify HEAD)" && printf "SPACEMACS REVISION: %s\n" "$(git rev-parse --verify HEAD)"
@ -58,6 +58,9 @@ RUN ln -s \
&& chown root:root /usr/local/sbin/install-deps \ && chown root:root /usr/local/sbin/install-deps \
&& chmod 770 /usr/local/sbin/install-deps && chmod 770 /usr/local/sbin/install-deps
# Install global dependencies (if any exists)
RUN install-deps
# Entrypoint and deps installation script will recreate it. # Entrypoint and deps installation script will recreate it.
RUN userdel $UNAME \ RUN userdel $UNAME \
&& groupdel $GNAME && groupdel $GNAME

3
Dockerfile.snapshot
View File

@ -58,6 +58,9 @@ RUN ln -s \
&& chown root:root /usr/local/sbin/install-deps \ && chown root:root /usr/local/sbin/install-deps \
&& chmod 770 /usr/local/sbin/install-deps && chmod 770 /usr/local/sbin/install-deps
# Install global dependencies (if any exists)
RUN install-deps
# Entrypoint and deps installation script will recreate it. # Entrypoint and deps installation script will recreate it.
RUN userdel $UNAME \ RUN userdel $UNAME \
&& groupdel $GNAME && groupdel $GNAME

2
README.md
View File

@ -1,4 +1,4 @@
<a name="top"></a> <a name="top" id="fork-destination-box"></a>
<a href="http://spacemacs.org"><img src="https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg" alt="Made with Spacemacs"></a><a href="http://www.twitter.com/spacemacs"><img src="http://i.imgur.com/tXSoThF.png" alt="Twitter" align="right"></a><br> <a href="http://spacemacs.org"><img src="https://cdn.rawgit.com/syl20bnr/spacemacs/442d025779da2f62fc86c2082703697714db6514/assets/spacemacs-badge.svg" alt="Made with Spacemacs"></a><a href="http://www.twitter.com/spacemacs"><img src="http://i.imgur.com/tXSoThF.png" alt="Twitter" align="right"></a><br>
*** ***
<p align="center"><img src="/doc/img/title2.png" alt="Spacemacs"/></p> <p align="center"><img src="/doc/img/title2.png" alt="Spacemacs"/></p>

15
doc/DOCUMENTATION.org
View File

@ -2116,13 +2116,13 @@ Buffer manipulation commands (start with ~b~):
**** Create a new empty buffer **** Create a new empty buffer
| Key Binding | Description | | Key Binding | Description |
|-------------+--------------------------------------------------------------| |-------------+-------------------------------------------------------|
| ~SPC b N h~ | create new empty buffer in a new window on the left | | ~SPC b N h~ | create new empty buffer in a new window on the left |
| ~SPC b N j~ | create new empty buffer in a new window at the bottom | | ~SPC b N j~ | create new empty buffer in a new window at the bottom |
| ~SPC b N k~ | create new empty buffer in a new window above | | ~SPC b N k~ | create new empty buffer in a new window above |
| ~SPC b N l~ | create new empty buffer in a new window below | | ~SPC b N l~ | create new empty buffer in a new window below |
| ~SPC b N n~ | create new empty buffer in current window | | ~SPC b N n~ | create new empty buffer in current window |
**** Buffers manipulation transient state **** Buffers manipulation transient state
A convenient buffer manipulation transient state allows to quickly cycles through A convenient buffer manipulation transient state allows to quickly cycles through
@ -2543,6 +2543,7 @@ bindings (~SPC e n~ and ~SPC e p~) as well as the error transient state (~SPC e~
| ~SPC s t F~ | =pt= with default text | | ~SPC s t F~ | =pt= with default text |
**** Searching in a project **** Searching in a project
| Key Binding | Description | | Key Binding | Description |
|-----------------------+-----------------------------------------------------| |-----------------------+-----------------------------------------------------|
| ~SPC /~ or ~SPC s p~ | search with the first found tool | | ~SPC /~ or ~SPC s p~ | search with the first found tool |

2
doc/FAQ.org
View File

@ -200,7 +200,7 @@ Instead, call =helm-M-x= first, select the command you want to run, and press
In the terminal version of Emacs, color themes will not render correctly as In the terminal version of Emacs, color themes will not render correctly as
colors are rendered by the terminal and not by emacs. You will probably have to colors are rendered by the terminal and not by emacs. You will probably have to
change your terminal color palette. More explanations can be found on change your terminal color palette. More explanations can be found on
[[https://github.com/sellout/emacs-color-theme-solarized#important-note-for-terminal-users][emacs-color-theme-solarized webpage]]. [[https://github.com/sellout/emacs-color-theme-solarized#user-content-important-note-for-terminal-users][emacs-color-theme-solarized webpage]].
** Typing quickly =fd= takes me out of =insert state=. What is going on? ** Typing quickly =fd= takes me out of =insert state=. What is going on?
This is a feature of Spacemacs, enabling you to easily escape from a lot of This is a feature of Spacemacs, enabling you to easily escape from a lot of

2
doc/LAYERS.org
View File

@ -333,7 +333,7 @@ as follows:
The =:location= attribute specifies where the package may be found. Spacemacs The =:location= attribute specifies where the package may be found. Spacemacs
currently supports packages on ELPA compliant repositories, local packages and currently supports packages on ELPA compliant repositories, local packages and
MELPA recipes (through the Quelpa package). Local packages should reside at =<layer>/local/<package>/=. For information about recipes see the [[https://github.com/milkypostman/melpa#recipe-format][MELPA documentation]]. MELPA recipes (through the Quelpa package). Local packages should reside at =<layer>/local/<package>/=. For information about recipes see the [[https://github.com/milkypostman/melpa#user-content-recipe-format][MELPA documentation]].
Packages may be /excluded/ by setting the =:excluded= property to true. This 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 will prevent the package from being installed even if it is used by another

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

@ -25,6 +25,7 @@ file.
| ~SPC a j~ | Connect all accounts | | ~SPC a j~ | Connect all accounts |
** Jabber Roster ** Jabber Roster
| Key Binding | Description | | Key Binding | Description |
| ~SPC m a~ | Jabber send presence | | ~SPC m a~ | Jabber send presence |
| ~SPC m b~ | Jabber get browse | | ~SPC m b~ | Jabber get browse |

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

@ -61,11 +61,11 @@ stuff elsewhere (like Dropbox for instance) and load the file in your dotfile.
The following bindings are provided to mimic bindings in the official Slack The following bindings are provided to mimic bindings in the official Slack
client. client.
| Key Binding | Description | | Key Binding | Description |
|-------------+-------------------------------------------| |-------------+--------------------------|
| ~SPC m @~ | Embed mention of user | | ~SPC m @~ | Embed mention of user |
| ~SPC m #~ | Embed mention of channel | | ~SPC m #~ | Embed mention of channel |
| ~SPC m k~ | Join a channel, group, and direct message | | ~SPC m k~ | Join a channel |
In insert state, one can also use ~@~ and ~#~ directly without the leader key In insert state, one can also use ~@~ and ~#~ directly without the leader key
prefix. prefix.

2
layers/+completion/auto-completion/README.org
View File

@ -14,7 +14,7 @@
- [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]] - [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]]
- [[#completion-back-ends][Completion back ends]] - [[#completion-back-ends][Completion back ends]]
- [[#improved-faces][Improved faces]] - [[#improved-faces][Improved faces]]
- [[#key-bindings-1][Key Bindings]] - [[#key-bindings][Key Bindings]]
- [[#company][Company]] - [[#company][Company]]
- [[#auto-complete][Auto-complete]] - [[#auto-complete][Auto-complete]]
- [[#yasnippet][Yasnippet]] - [[#yasnippet][Yasnippet]]

8
layers/+distributions/spacemacs-base/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-base distribution
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-base-distribution-in-this-file][describe spacemacs-base distribution in this file]]
* Description
** TODO describe spacemacs-base distribution in this file

8
layers/+distributions/spacemacs-bootstrap/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-bootstrap distribution
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-bootstrap-distribution-in-this-file][describe spacemacs-bootstrap distribution in this file]]
* Description
** TODO describe spacemacs-bootstrap distribution in this file

15
layers/+distributions/spacemacs-docker/README.org
View File

@ -2,13 +2,14 @@
* Table of Contents :TOC_4_gh:noexport: * Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]] - [[#description][Description]]
- [[#screenshots][Screenshots]]
- [[#major-benefits][Major benefits]] - [[#major-benefits][Major benefits]]
- [[#how-setup][How setup]] - [[#how-to-setup][How to setup]]
- [[#how-to-use][How to use]] - [[#how-to-use][How to use]]
- [[#macos][MacOS]] - [[#macos][MacOS]]
- [[#windows][Windows]] - [[#windows][Windows]]
- [[#gnulinux][GNU/Linux]] - [[#gnulinux][GNU/Linux]]
- [[#with-xpra-on-any-and-via-web-browser][With Xpra on any and via web-browser]] - [[#with-xpra-on-any-of-the-oses-and-via-web-browser][With Xpra on any of the OSes and via web-browser]]
- [[#pros][Pros]] - [[#pros][Pros]]
- [[#cons][Cons]] - [[#cons][Cons]]
- [[#instruction][Instruction]] - [[#instruction][Instruction]]
@ -20,6 +21,7 @@
Spacemacs distribution that aims to automate dependency installation for Spacemacs distribution that aims to automate dependency installation for
Spacemacs layers and provide well tested Docker based development environment Spacemacs layers and provide well tested Docker based development environment
with GUI support on all major platforms and even [[https://i.imgur.com/wDLDMZN.gif][your web browser]]. with GUI support on all major platforms and even [[https://i.imgur.com/wDLDMZN.gif][your web browser]].
** Screenshots ** Screenshots
#+CAPTION: MacOS #+CAPTION: MacOS
[[file:img/MAC_SP.jpg]] [[file:img/MAC_SP.jpg]]
@ -33,6 +35,7 @@ with GUI support on all major platforms and even [[https://i.imgur.com/wDLDMZN.g
[[file:img/WIN_SP.jpg]] [[file:img/WIN_SP.jpg]]
[[https://i.imgur.com/WmsnCUo.jpg][HD Windows image]] [[https://i.imgur.com/WmsnCUo.jpg][HD Windows image]]
** Major benefits ** Major benefits
- Automatically get Spacemacs layers dependency installed with [[./deps-install/README.org][installer scripts]] - Automatically get Spacemacs layers dependency installed with [[./deps-install/README.org][installer scripts]]
- Reap the benefit of Emacs and other GNU/Linux tools on Windows/MacOS machines - Reap the benefit of Emacs and other GNU/Linux tools on Windows/MacOS machines
@ -58,6 +61,7 @@ the machine that will run development environment and then use
With one of the methods below replace =spacemacs/emacs25= with your images. With one of the methods below replace =spacemacs/emacs25= with your images.
NOTE: The guide assumes that you want to run Docker and connect to it from NOTE: The guide assumes that you want to run Docker and connect to it from
the same machine. the same machine.
** MacOS ** MacOS
Get [[https://www.xquartz.org][XQuartz]] and =open -a XQuartz= In the XQuartz preferences go to the "Security" Get [[https://www.xquartz.org][XQuartz]] and =open -a XQuartz= In the XQuartz preferences go to the "Security"
tab and make sure you’ve got "Allow connections from network clients" ticked tab and make sure you’ve got "Allow connections from network clients" ticked
@ -72,6 +76,7 @@ tab and make sure you’ve got "Allow connections from network clients" ticked
#+END_SRC #+END_SRC
[[https://fredrikaverpil.github.io/2016/07/31/docker-for-mac-and-gui-applications][source]], [[https://fredrikaverpil.github.io/2016/07/31/docker-for-mac-and-gui-applications][source]],
[[https://github.com/chanezon/docker-tips/blob/master/x11/README.md][another method]] [[https://github.com/chanezon/docker-tips/blob/master/x11/README.md][another method]]
** Windows ** Windows
Get [[https://www.cygwin.com][Cygwin]] with =xinit=, =xorg-server= and optionaly [[https://github.com/rprichard/winpty][winpty]](to run Emacs container with =-t=) Get [[https://www.cygwin.com][Cygwin]] with =xinit=, =xorg-server= and optionaly [[https://github.com/rprichard/winpty][winpty]](to run Emacs container with =-t=)
#+BEGIN_SRC sh #+BEGIN_SRC sh
@ -95,6 +100,7 @@ winpty docker run -ti --name spacemacs \
#+END_SRC #+END_SRC
[[http://manomarks.github.io/2015/12/03/docker-gui-windows.html][source]] [[http://manomarks.github.io/2015/12/03/docker-gui-windows.html][source]]
Also You can use [[https://github.com/JAremko/docker-emacs/issues/2#issuecomment-260047233][@ninrod 's vagrant setup]] Also You can use [[https://github.com/JAremko/docker-emacs/issues/2#issuecomment-260047233][@ninrod 's vagrant setup]]
** GNU/Linux ** GNU/Linux
Make sure that =$DISPLAY= variable is set Make sure that =$DISPLAY= variable is set
#+BEGIN_SRC sh #+BEGIN_SRC sh
@ -122,17 +128,21 @@ Or allow local connection from the container's host-name
xhost +local:`docker inspect --format='{{ .Config.Hostname }}' spacemacs` xhost +local:`docker inspect --format='{{ .Config.Hostname }}' spacemacs`
#+END_SRC #+END_SRC
[[http://stackoverflow.com/questions/25281992/alternatives-to-ssh-x11-forwarding-for-docker-containers][source]] [[http://stackoverflow.com/questions/25281992/alternatives-to-ssh-x11-forwarding-for-docker-containers][source]]
** With Xpra on any of the OSes and via web-browser ** With Xpra on any of the OSes and via web-browser
*** Pros *** Pros
- Xpra has a client for GNU/Linux, Windows and MacOS + can work via web browser - Xpra has a client for GNU/Linux, Windows and MacOS + can work via web browser
- Persistent server (you can connect and disconnect without disrupting Emacs) - Persistent server (you can connect and disconnect without disrupting Emacs)
- Interactive screen sharing [[https://imgur.com/ijdSuX6][demo]] - Interactive screen sharing [[https://imgur.com/ijdSuX6][demo]]
- Read/write rss/email with Emacs in web-browser (O_O) [[https://imgur.com/wDLDMZN][demo]] - Read/write rss/email with Emacs in web-browser (O_O) [[https://imgur.com/wDLDMZN][demo]]
*** Cons *** Cons
- Lag spikes with some OSes - Lag spikes with some OSes
*** Instruction *** Instruction
It's a good idea to read [[https://github.com/JAremko/docker-x11-bridge][docker-x11-bridge]] and [[https://www.xpra.org/trac/][Xpra]] documentations, but It's a good idea to read [[https://github.com/JAremko/docker-x11-bridge][docker-x11-bridge]] and [[https://www.xpra.org/trac/][Xpra]] documentations, but
here is a short instruction: here is a short instruction:
**** With Xpra desktop client **** With Xpra desktop client
Get [[https://xpra.org/][Xpra]] client for your OS. then Get [[https://xpra.org/][Xpra]] client for your OS. then
#+BEGIN_SRC sh #+BEGIN_SRC sh
@ -155,6 +165,7 @@ Now you can connect to it with Xpra desktop client
--ssh="ssh -o StrictHostKeyChecking=no -p 22" \ --ssh="ssh -o StrictHostKeyChecking=no -p 22" \
ssh:xpra@localhost:14 ssh:xpra@localhost:14
#+END_SRC #+END_SRC
**** Via web-browser **** Via web-browser
#+BEGIN_SRC sh #+BEGIN_SRC sh
docker run -ti --rm --name x11-bridge \ docker run -ti --rm --name x11-bridge \

1
layers/+distributions/spacemacs-docker/deps-install/README.org
View File

@ -8,6 +8,7 @@
* Description * Description
Dependency installation scripts for Spacemacs layers Dependency installation scripts for Spacemacs layers
in Docker environment. in Docker environment.
* Supported layers * Supported layers
1. [[./installers/clojure/README.org][Clojure]] 1. [[./installers/clojure/README.org][Clojure]]
2. [[./installers/dash/README.org][Dash]] 2. [[./installers/dash/README.org][Dash]]

2
layers/+distributions/spacemacs-docker/deps-install/installers/fasd/README.org
View File

@ -8,4 +8,4 @@
Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/fasd/README.org][fasd layer.]] Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/fasd/README.org][fasd layer.]]
* List of installed software: * List of installed software:
1. [[https://github.com/clvv/fasd][fasd]] 1. [[https://github.com/clvv/fasd][fasd]]

2
layers/+distributions/spacemacs-docker/deps-install/installers/gtags/README.org
View File

@ -10,4 +10,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/
* List of installed software: * List of installed software:
1. [[http://packages.ubuntu.com/en/xenial/python-pygments][python-pygments]] 1. [[http://packages.ubuntu.com/en/xenial/python-pygments][python-pygments]]
2. [[https://github.com/universal-ctags/ctags][universal-ctags]] 2. [[https://github.com/universal-ctags/ctags][universal-ctags]]
3. [[https://www.tamacom.com/global.html][global]] 3. [[https://www.tamacom.com/global.html][global]]

2
layers/+distributions/spacemacs-docker/deps-install/installers/html/README.org
View File

@ -18,4 +18,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/
8. [[https://github.com/sds/slim-lint][slim_lint]] 8. [[https://github.com/sds/slim-lint][slim_lint]]
9. [[http://sass-lang.com][sass]] 9. [[http://sass-lang.com][sass]]
10. [[https://github.com/brigade/scss-lint][scss-lint]] 10. [[https://github.com/brigade/scss-lint][scss-lint]]
11. [[https://github.com/Sweetchuck/scss_lint_reporter_checkstyle][scss_lint_reporter_checkstyle]] 11. [[https://github.com/Sweetchuck/scss_lint_reporter_checkstyle][scss_lint_reporter_checkstyle]]

2
layers/+distributions/spacemacs-docker/deps-install/installers/javascript/README.org
View File

@ -14,4 +14,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/
4. [[https://ternjs.net/][tern]] 4. [[https://ternjs.net/][tern]]
5. [[https://github.com/beautify-web/js-beautify][js-beautify]] 5. [[https://github.com/beautify-web/js-beautify][js-beautify]]
6. [[https://github.com/eslint/eslint][eslint]] 6. [[https://github.com/eslint/eslint][eslint]]
7. [[https://github.com/jshint/jshint][jshint]] 7. [[https://github.com/jshint/jshint][jshint]]

2
layers/+distributions/spacemacs-docker/deps-install/installers/pandoc/README.org
View File

@ -8,4 +8,4 @@
Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/pandoc/README.org][pandoc layer.]] Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/pandoc/README.org][pandoc layer.]]
* List of installed software: * List of installed software:
1. [[http://packages.ubuntu.com/xenial/pandoc][pandoc]] 1. [[http://packages.ubuntu.com/xenial/pandoc][pandoc]]

2
layers/+distributions/spacemacs-docker/deps-install/installers/pdf-tools/README.org
View File

@ -9,4 +9,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/
* List of installed software: * List of installed software:
1. [[https://www.imagemagick.org/script/index.php][imagemagick]] 1. [[https://www.imagemagick.org/script/index.php][imagemagick]]
2. [[https://github.com/politza/pdf-tools][pdf-tools]] 2. [[https://github.com/politza/pdf-tools][pdf-tools]]

18
layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/README.org
View File

@ -1,18 +0,0 @@
#+TITLE: spacemacs-docker distribution installers
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#subdirectories][Subdirectories]]
- [[#note][Note]]
* Description
This directory contains layers installation scripts and their dependencies
that will be executed by Dockerfiles.
* Subdirectories
1. [[./deps-installers/README.org][deps-installers]]
2. [[./lib/README.org][lib]]
* Note
Dockerfiles actually use a copy of this directory
located at =/usr/local/spacemacs=

33
layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/deps-installers/README.org
View File

@ -1,33 +0,0 @@
#+TITLE: spacemacs-docker layers dependency installation scripts
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#supported-layers][Supported layers]]
- [[#how-it-works][How it works]]
* Description
Dependency installation scripts for [[../../../../../../README.org][spacemacs-docker distribution.]]
* Supported layers
1. [[./clojure/README.org][Clojure]]
2. [[./dash/README.org][Dash]]
3. [[./fasd/README.org][fasd]]
4. [[./go/README.org][Go]]
5. [[./gtags/README.org][gtags]]
6. [[./html/README.org][html]]
7. [[./javascript/README.org][JavaScript]]
8. [[./pandoc/README.org][pandoc]]
9. [[./pdf-tools/README.org][pdf-tools]]
10. [[./spell-checking/README.org][spell-checking]]
* How it works
If user's .spacemacs file contains one of supported layers and its installation
isn't disabled, it will be used to satisfy the layer's requirements, taking
into account its configurations. For example, [[https://github.com/alecthomas/gometalinter][gometalinter]] will be installed
only if the variable =go-use-gometalinter= is =t=.
Set =<LAYER_NAME>-docker-spacemacs-disable-dependencies-installer= to =t=
if you want to disable dependency installation for the =<LAYER_NAME>= layer.
Example:
#+BEGIN_SRC emacs-lisp
(pandoc :variables pandoc-docker-spacemacs-disable-dependencies-installer t)
#+END_SRC

7
layers/+distributions/spacemacs-docker/funcs.el
View File

@ -30,7 +30,8 @@ the `spacemacs-docker-dump-layer-data-fp' file"
obarray))) obarray)))
(dolist (name names) (dolist (name names)
(let* ((symbol (intern-soft name)) (let* ((symbol (intern-soft name))
(fp (when (boundp symbol) (symbol-file symbol)))) (fp (when (boundp symbol) (symbol-file symbol)))
(sym-val (bound-and-true-p symbol)))
(when (or (and fp (when (or (and fp
(string-prefix-p (string-prefix-p
(configuration-layer/get-layer-path layer) (configuration-layer/get-layer-path layer)
@ -40,5 +41,7 @@ the `spacemacs-docker-dump-layer-data-fp' file"
(insert (format "%-28s(%s . %s)\n" (insert (format "%-28s(%s . %s)\n"
"" ""
name name
(symbol-value symbol)))))))) (if (stringp sym-val)
(format "\"%s\"" sym-val)
sym-val))))))))
(insert "))\n\n")))) (insert "))\n\n"))))

8
layers/+distributions/spacemacs/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs distribution
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-distribution-in-this-file][describe spacemacs distribution in this file]]
* Description
** TODO describe spacemacs distribution in this file

6
layers/+emacs/ibuffer/README.org
View File

@ -40,9 +40,9 @@ Example:
* Key bindings * Key bindings
** Global ** Global
| Key Binding | Description | | Key Binding | Description |
|-------------+-------------------------------| |-------------+----------------------------|
| ~SPC b B~ | open IBuffer menu (global) | | ~SPC b B~ | open IBuffer menu (global) |
*Note:* The layer will also replace regular ~C-x C-b~ with =ibuffer=. *Note:* The layer will also replace regular ~C-x C-b~ with =ibuffer=.

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

@ -200,8 +200,6 @@ For example:
) )
#+END_SRC #+END_SRC
** Different bullets ** Different bullets
You can tweak the bullets displayed in the org buffer in the function You can tweak the bullets displayed in the org buffer in the function
=dotspacemacs/user-config= of your dotfile by setting the variable =dotspacemacs/user-config= of your dotfile by setting the variable
@ -485,7 +483,7 @@ are listed bellow.
|-------------+---------------------+-----------------------------------| |-------------+---------------------+-----------------------------------|
| ~ht~ | set status | org-agenda-todo | | ~ht~ | set status | org-agenda-todo |
| ~hk~ | kill | org-agenda-kill | | ~hk~ | kill | org-agenda-kill |
| ~hR~ | refile | org-agenda-refile | | ~hR~ | refile | org-agenda-refile |
| ~hA~ | archive | org-agenda-archive-default | | ~hA~ | archive | org-agenda-archive-default |
| ~h:~ | set tags | org-agenda-set-tags | | ~h:~ | set tags | org-agenda-set-tags |
| ~hp~ | set priority | org-agenda-priority | | ~hp~ | set priority | org-agenda-priority |

1
layers/+fun/selectric/README.org
View File

@ -6,6 +6,7 @@
- [[#description][Description]] - [[#description][Description]]
- [[#install][Install]] - [[#install][Install]]
- [[#key-bindings][Key Bindings]] - [[#key-bindings][Key Bindings]]
- [[#notes][Notes]]
* Description * Description
This layer makes your Emacs sound like an IBM Selectric typewriter, for those This layer makes your Emacs sound like an IBM Selectric typewriter, for those

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

@ -202,7 +202,7 @@ As this state works the same for all files, the documentation is in global
|-------------+--------------------------------| |-------------+--------------------------------|
| ~SPC m d b~ | instrument expression at point | | ~SPC m d b~ | instrument expression at point |
| ~SPC m d e~ | display last stacktrace | | ~SPC m d e~ | display last stacktrace |
| ~SPC m d r~ | reload namespaces | | ~SPC m d r~ | reload namespaces |
| ~SPC m d v~ | inspect expression at point | | ~SPC m d v~ | inspect expression at point |
*** Refactoring *** Refactoring

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

@ -96,12 +96,12 @@ As this state works the same for all files, the documentation is in global
*** Navigation *** Navigation
| Key Binding | Description | | Key Binding | Description |
|---------------------------+--------------------| |---------------------------+------------------|
| ~SPC m g g~ | Go to definition | | ~SPC m g g~ | Go to definition |
| ~SPC m g b~ | Go back | | ~SPC m g b~ | Go back |
| ~SPC m g n~ | Next note | | ~SPC m g n~ | Next note |
| ~SPC m g N~ or ~SPC m g p | Previous note | | ~SPC m g N~ or ~SPC m g p | Previous note |
*** Macroexpansion *** Macroexpansion

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

@ -25,8 +25,8 @@
- [[#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-1][elm-oracle]] - [[#elm-oracle][elm-oracle]]
- [[#elm-format-1][elm-format]] - [[#elm-format][elm-format]]
- [[#refactoring][Refactoring]] - [[#refactoring][Refactoring]]
* Description * Description
@ -217,8 +217,8 @@ cycle through the list (note that hitting any other key will cancel the cycle).
** elm-format ** elm-format
| Key Binding | Description | | Key Binding | Description |
| ~SPC m = b~ | elm-mode-format-buffer | | ~SPC m = b~ | elm-mode-format-buffer |
** Refactoring ** Refactoring

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

@ -1,6 +1,5 @@
#+TITLE: Forth layer #+TITLE: Forth layer
* Table of Contents :TOC_4_gh:noexport: * Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]] - [[#description][Description]]
- [[#install][Install]] - [[#install][Install]]

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

@ -25,12 +25,12 @@
- [[#cabal-commands][Cabal commands]] - [[#cabal-commands][Cabal commands]]
- [[#cabal-files][Cabal files]] - [[#cabal-files][Cabal files]]
- [[#refactor][Refactor]] - [[#refactor][Refactor]]
- [[#ghc-mod-1][Ghc-mod]] - [[#ghc-mod][Ghc-mod]]
- [[#insert-template][Insert template]] - [[#insert-template][Insert template]]
- [[#syntax-checking][Syntax checking]] - [[#syntax-checking][Syntax checking]]
- [[#flycheck][Flycheck]] - [[#flycheck][Flycheck]]
- [[#hlint][HLint]] - [[#hlint][HLint]]
- [[#ghc-mod-2][ghc-mod]] - [[#ghc-mod][ghc-mod]]
- [[#interactive-haskell-mode][Interactive haskell-mode]] - [[#interactive-haskell-mode][Interactive haskell-mode]]
- [[#flymake][Flymake]] - [[#flymake][Flymake]]
- [[#troubleshooting][Troubleshooting]] - [[#troubleshooting][Troubleshooting]]

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

@ -12,31 +12,31 @@
- [[#installation][Installation]] - [[#installation][Installation]]
- [[#about-maven][About Maven]] - [[#about-maven][About Maven]]
- [[#eclim][Eclim]] - [[#eclim][Eclim]]
- [[#installation-1][Installation]] - [[#installation][Installation]]
- [[#eclipse][Eclipse]] - [[#eclipse][Eclipse]]
- [[#eclim-1][Eclim]] - [[#eclim][Eclim]]
- [[#configuration][Configuration]] - [[#configuration][Configuration]]
- [[#usage][Usage]] - [[#usage][Usage]]
- [[#ensime][ENSIME]] - [[#ensime][ENSIME]]
- [[#installation-2][Installation]] - [[#installation][Installation]]
- [[#configuration-1][Configuration]] - [[#configuration][Configuration]]
- [[#usage-1][Usage]] - [[#usage][Usage]]
- [[#issues][Issues]] - [[#issues][Issues]]
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
- [[#meghanada-1][Meghanada]] - [[#meghanada][Meghanada]]
- [[#server][Server]] - [[#server][Server]]
- [[#navigation][Navigation]] - [[#navigation][Navigation]]
- [[#compilation][Compilation]] - [[#compilation][Compilation]]
- [[#tests-junit][Tests (junit)]] - [[#tests-junit][Tests (junit)]]
- [[#refactoring][Refactoring]] - [[#refactoring][Refactoring]]
- [[#tasks][Tasks]] - [[#tasks][Tasks]]
- [[#eclim-2][Eclim]] - [[#eclim][Eclim]]
- [[#java-mode][Java-mode]] - [[#java-mode][Java-mode]]
- [[#project-management][Project management]] - [[#project-management][Project management]]
- [[#eclim-daemon][Eclim daemon]] - [[#eclim-daemon][Eclim daemon]]
- [[#maven][Maven]] - [[#maven][Maven]]
- [[#goto][Goto]] - [[#goto][Goto]]
- [[#refactoring-1][Refactoring]] - [[#refactoring][Refactoring]]
- [[#documentation-find][Documentation, Find]] - [[#documentation-find][Documentation, Find]]
- [[#errors-problems][Errors (problems)]] - [[#errors-problems][Errors (problems)]]
- [[#tests][Tests]] - [[#tests][Tests]]
@ -48,12 +48,12 @@
- [[#typecheck][Typecheck]] - [[#typecheck][Typecheck]]
- [[#debug][Debug]] - [[#debug][Debug]]
- [[#errors][Errors]] - [[#errors][Errors]]
- [[#goto-1][Goto]] - [[#goto][Goto]]
- [[#print-and-yank-types][Print and yank types]] - [[#print-and-yank-types][Print and yank types]]
- [[#documentation-inspect][Documentation, Inspect]] - [[#documentation-inspect][Documentation, Inspect]]
- [[#server-1][Server]] - [[#server][Server]]
- [[#refactoring-2][Refactoring]] - [[#refactoring][Refactoring]]
- [[#tests-1][Tests]] - [[#tests][Tests]]
- [[#repl][REPL]] - [[#repl][REPL]]
* Description * Description
@ -88,7 +88,6 @@ Backend can be chosen on a per project basis using directory local variables
*Note:* you can easily add a directory local variable with ~SPC f v d~. *Note:* you can easily add a directory local variable with ~SPC f v d~.
* Backends * Backends
** Meghanada ** Meghanada
Meghanada is composed of a lightweight server and an Emacs minor mode. It Meghanada is composed of a lightweight server and an Emacs minor mode. It
@ -247,11 +246,11 @@ particular refactoring doesn't work.
*** Refactoring *** Refactoring
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------------------------------------| |-------------+------------------|
| ~SPC m =~ | Beautify code | | ~SPC m =~ | Beautify code |
| ~SPC m r i~ | Optimize imports | | ~SPC m r i~ | Optimize imports |
| ~SPC m r I~ | Import all | | ~SPC m r I~ | Import all |
*** Tasks *** Tasks
@ -429,6 +428,7 @@ particular refactoring doesn't work.
| ~SPC m g t~ | go to test | | ~SPC m g t~ | go to test |
*** Print and yank types *** Print and yank types
|-------------+--------------------------------| |-------------+--------------------------------|
| ~SPC m h T~ | print full type name at point | | ~SPC m h T~ | print full type name at point |
| ~SPC m h t~ | print short type name at point | | ~SPC m h t~ | print short type name at point |

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

@ -1,15 +1,13 @@
#+TITLE: reStructuredText layer #+TITLE: reStructuredText layer
[[file:img/restructuredtext.png]] * Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
* Table of Contents :TOC_4_org:noexport: - [[#features][Features]]
- [[Description][Description]] - [[#install][Install]]
- [[Features][Features]] - [[#configuration][Configuration]]
- [[Install][Install]] - [[#sphinx-target][Sphinx target]]
- [[Configuration][Configuration]] - [[#web-browser][Web browser]]
- [[Sphinx target][Sphinx target]] - [[#key-bindings][Key bindings]]
- [[Web browser][Web browser]]
- [[Key bindings][Key bindings]]
* Description * Description
The layer adds ReStructuredText (ReST) support to Spacemacs and adds some The layer adds ReStructuredText (ReST) support to Spacemacs and adds some

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

@ -65,7 +65,7 @@ specific documentation for details and caveats):
#+END_SRC #+END_SRC
** Ruby version management ** Ruby version management
This layer supports [[https://rvm.io/][RVM]], [[https://github.com/sstephenson/rbenv][Rbenv]], and [[https://github.com/postmodern/chruby][Chruby]]. You can choose the default version This layer supports [[https://rvm.io/][RVM]], [[https://github.com/rbenv/rbenv][Rbenv]], and [[https://github.com/postmodern/chruby][Chruby]]. You can choose the default version
manager by setting the variable =ruby-version-manager= in your dotfile, for manager by setting the variable =ruby-version-manager= in your dotfile, for
example: example:

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

@ -15,7 +15,7 @@
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
* Description * Description
This layer adds support for the Scala language using the excellent [[http://ensime.github.io/][ENSIME]] This layer adds support for the Scala language using the excellent [[http://ensime.org/][ENSIME]]
client/server. client/server.
* Layer Installation * Layer Installation
@ -24,7 +24,7 @@ add =scala= to the existing =dotspacemacs-configuration-layers= list in this
file. file.
* Ensime * Ensime
[[http://ensime.github.io/][ENSIME]] provides IDE-like features, such as refactoring, incremental compilation [[http://ensime.org/][ENSIME]] provides IDE-like features, such as refactoring, incremental compilation
and project-wide type-checking. and project-wide type-checking.
ENSIME requires a configuration file at the root of each Scala project. It ENSIME requires a configuration file at the root of each Scala project. It

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

@ -38,4 +38,3 @@ In order to enable =sh= scripts linting, install [[https://www.shellcheck.net/][
| ~SPC i !~ | insert shebang in a script file | | ~SPC i !~ | insert shebang in a script file |
| ~SPC m \~ | insert end-of-line backslashes to the lines in the region | | ~SPC m \~ | insert end-of-line backslashes to the lines in the region |

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

@ -14,7 +14,7 @@
This layer adds support for Apple's Swift programming language, used as a This layer adds support for Apple's Swift programming language, used as a
general purpose scripting language. general purpose scripting language.
It relies on the [[https://github.com/chrisbarrett/swift-mode][swift-mode]] major-mode* for Emacs 24.4 or later, to provide the It relies on the [[https://github.com/swift-emacs/swift-mode][swift-mode]] major-mode* for Emacs 24.4 or later, to provide the
following features: following features:
- Syntax highlighting - Syntax highlighting

8
layers/+misc/nlinum/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: nlinum layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-nlinum-layer-in-this-file][describe nlinum layer in this file]]
* Description
** TODO describe nlinum layer in this file

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

@ -20,7 +20,7 @@
- [[#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-1][Git-Flow]] - [[#git-flow][Git-Flow]]
- [[#git-time-machine][Git time machine]] - [[#git-time-machine][Git time machine]]
- [[#git-links-to-web-services][Git links to web services]] - [[#git-links-to-web-services][Git links to web services]]
- [[#repository-list][Repository list]] - [[#repository-list][Repository list]]

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

@ -64,13 +64,13 @@ possible.
** magithub ** magithub
| Key Binding | Description | | Key Binding | Description |
|-------------+-------------------------------------------------------------| |-------------+--------------------------------------------------|
| ~@ H~ | opens the current repository in the browser | | ~@ H~ | opens the current repository in the browser |
| ~@ c~ | pushes a brand-new local repository up to GitHub | | ~@ c~ | pushes a brand-new local repository up to GitHub |
| ~@ f~ | create a fork of an existing repository | | ~@ f~ | create a fork of an existing repository |
| ~@ p~ | submit pull request upstream | | ~@ p~ | submit pull request upstream |
| ~@ i~ | create an issue | | ~@ i~ | create an issue |
** gist.el ** gist.el

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

@ -9,14 +9,14 @@
* Description * Description
This layer adds support for [[http://www.perforce.com/][Perforce]] (p4). This layer adds support for [[https://www.perforce.com/][Perforce]] (p4).
* Install * Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =perforce= to the existing =dotspacemacs-configuration-layers= list in this add =perforce= to the existing =dotspacemacs-configuration-layers= list in this
file. file.
You'll have to install the =p4== command line tool from the [[http://www.perforce.com/downloads][download page]]. You'll have to install the =p4== command line tool from the [[https://www.perforce.com/downloads/helix][download page]].
Don't forget to setup the environment variables: Don't forget to setup the environment variables:
- =P4_PORT= - =P4_PORT=

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

@ -97,7 +97,6 @@ one over the other:
| ~SPC g . F~ | Pull repo with popup | | ~SPC g . F~ | Pull repo with popup |
| ~SPC g . l~ | Show repo log | | ~SPC g . l~ | Show repo log |
** Smerge Mode Transient-state ** Smerge Mode Transient-state
| Key Binding | Description | | Key Binding | Description |

8
layers/+spacemacs/spacemacs-completion/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-completion layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-completion-layer-in-this-file][describe spacemacs-completion layer in this file]]
* Description
** TODO describe spacemacs-completion layer in this file

8
layers/+spacemacs/spacemacs-editing-visual/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-editing-visual layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-editing-visual-layer-in-this-file][describe spacemacs-editing-visual layer in this file]]
* Description
** TODO describe spacemacs-editing-visual layer in this file

8
layers/+spacemacs/spacemacs-editing/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-editing layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-editing-layer-in-this-file][describe spacemacs-editing layer in this file]]
* Description
** TODO describe spacemacs-editing layer in this file

8
layers/+spacemacs/spacemacs-evil/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-evil layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-evil-layer-in-this-file][describe spacemacs-evil layer in this file]]
* Description
** TODO describe spacemacs-evil layer in this file

8
layers/+spacemacs/spacemacs-language/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-language layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-language-layer-in-this-file][describe spacemacs-language layer in this file]]
* Description
** TODO describe spacemacs-language layer in this file

8
layers/+spacemacs/spacemacs-layouts/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-layouts layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-layouts-layer-in-this-file][describe spacemacs-layouts layer in this file]]
* Description
** TODO describe spacemacs-layouts layer in this file

8
layers/+spacemacs/spacemacs-misc/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-misc layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-misc-layer-in-this-file][describe spacemacs-misc layer in this file]]
* Description
** TODO describe spacemacs-misc layer in this file

8
layers/+spacemacs/spacemacs-modeline/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-modeline layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-modeline-layer-in-this-file][describe spacemacs-modeline layer in this file]]
* Description
** TODO describe spacemacs-modeline layer in this file

8
layers/+spacemacs/spacemacs-navigation/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-navigation layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-navigation-layer-in-this-file][describe spacemacs-navigation layer in this file]]
* Description
** TODO describe spacemacs-navigation layer in this file

8
layers/+spacemacs/spacemacs-org/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-org layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-org-layer-in-this-file][describe spacemacs-org layer in this file]]
* Description
** TODO describe spacemacs-org layer in this file

8
layers/+spacemacs/spacemacs-visual/README.org Normal file
View File

@ -0,0 +1,8 @@
#+TITLE: spacemacs-visual layer
* Table of Contents :TOC_4_gh:noexport:
- [[#description][Description]]
- [[#describe-spacemacs-visual-layer-in-this-file][describe spacemacs-visual layer in this file]]
* Description
** TODO describe spacemacs-visual layer in this file

2
layers/+themes/colors/README.org
View File

@ -9,7 +9,7 @@
- [[#colorize-identifiers][Colorize identifiers]] - [[#colorize-identifiers][Colorize identifiers]]
- [[#enable-nyan-cat][Enable Nyan cat]] - [[#enable-nyan-cat][Enable Nyan cat]]
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
- [[#colorize-identifiers-1][Colorize Identifiers]] - [[#colorize-identifiers][Colorize Identifiers]]
- [[#rainbow-mode][Rainbow Mode]] - [[#rainbow-mode][Rainbow Mode]]
- [[#nyan-mode][Nyan Mode]] - [[#nyan-mode][Nyan Mode]]

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

@ -56,4 +56,4 @@ from anchor= to =2=. For example:
| Key Binding | Description | | Key Binding | Description |
|-------------+-----------------------| |-------------+-----------------------|
| ~SPC m j~ | Reformats JSON string | | ~SPC m j~ | Reformats JSON string |

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

@ -15,10 +15,9 @@
This layer provides some integration with the Google Chrome browser. This layer provides some integration with the Google Chrome browser.
** Features ** Features
- Edit text boxes with Emacs using [[http://melpa.org/#/edit-server][edit-server]] - Edit text boxes with Emacs using [[https://github.com/stsquad/emacs_chrome][edit-server]]
- Write markdown in Emacs and realtime show in chrome using [[https://github.com/mola-T/flymd][flymd]] - Write markdown in Emacs and realtime show in chrome using [[https://github.com/mola-T/flymd][flymd]]
* Install * Install
** Layer ** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@ -26,7 +25,7 @@ add =chrome= to the existing =dotspacemacs-configuration-layers= list in this
file. file.
** Chrome extension ** Chrome extension
[[http://melpa.org/#/edit-server][edit-server]] is a server that responds to edit requests sent Chrome via the [[https://github.com/stsquad/emacs_chrome][edit-server]] is a server that responds to edit requests sent Chrome via the
Google Chrome extension [[https://chrome.google.com/webstore/detail/edit-with-emacs/ljobjlafonikaiipfkggjbhkghgicgoh][Edit with Emacs]]. You have to install this extension. Google Chrome extension [[https://chrome.google.com/webstore/detail/edit-with-emacs/ljobjlafonikaiipfkggjbhkghgicgoh][Edit with Emacs]]. You have to install this extension.
More information can be found on [[http://www.emacswiki.org/emacs/Edit_with_Emacs][Emacs Wiki]]. More information can be found on [[http://www.emacswiki.org/emacs/Edit_with_Emacs][Emacs Wiki]].

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

@ -8,20 +8,21 @@
- [[#description][Description]] - [[#description][Description]]
- [[#install][Install]] - [[#install][Install]]
- [[#dash-os-x][Dash (OS X)]] - [[#dash-os-x][Dash (OS X)]]
- [[#sqlite3][Sqlite3]]
- [[#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-and-counsel-dash][helm-dash and counsel-dash]] - [[#helm-dash-and-counsel-dash][helm-dash and counsel-dash]]
* Description * Description
- [[http://kapeli.com/dash][dash]] :: Is a great tool for quick access to various sets of documentation, - [[https://kapeli.com/dash][dash]] :: Is a great tool for quick access to various sets of documentation,
only available in OS X. only available in OS X.
- [[https://github.com/stanaka/dash-at-point][dash-at-point]] :: Is the package used to integrate =dash= in Emacs. It will try - [[https://github.com/stanaka/dash-at-point][dash-at-point]] :: Is the package used to integrate =dash= in Emacs. It will try
to intelligently guess specific docsets to use based off of to intelligently guess specific docsets to use based off of
your current mode. your current mode.
- [[http://zealdocs.org/][zeal]] :: Zeal is an offline documentation browser inspired by Dash, - [[https://zealdocs.org/][zeal]] :: Zeal is an offline documentation browser inspired by Dash,
available for Linux and Windows. available for Linux and Windows.
- [[https://github.com/jinzhu/zeal-at-point][zeal-at-point]] :: Run zeal-at-point to search the word at point (or string in - [[https://github.com/jinzhu/zeal-at-point][zeal-at-point]] :: Run zeal-at-point to search the word at point (or string in
@ -35,17 +36,17 @@ file.
** Dash (OS X) ** Dash (OS X)
You have to install [[http://kapeli.com/dash][dash]] on your machine. You have to install [[https://kapeli.com/dash][dash]] on your machine.
It is recommended to set the =HUD mode= in your Dash application preferences It is recommended to set the =HUD mode= in your Dash application preferences
when using this layer. when using this layer.
** Sqlite3 ** Sqlite3
Helm Dash [[https://github.com/areina/helm-dash#requirements][requires]] sqlite3 to be installed to function properly. Helm Dash [[https://github.com/areina/helm-dash#user-content-requirements][requires]] sqlite3 to be installed to function properly.
** Zeal (Linux & Windows) ** Zeal (Linux & Windows)
You have to install [[http://zealdocs.org/][zeal]] on your machine. You have to install [[https://zealdocs.org/][zeal]] on your machine.
Then install the docsets you use more frequently Then install the docsets you use more frequently

10
layers/+tools/docker/README.org
View File

@ -3,11 +3,11 @@
[[file:img/docker.png]] [[file:img/docker.png]]
* Table of Contents :TOC_4_gh:noexport: * Table of Contents :TOC_4_gh:noexport:
- [[Description][Description]] - [[#description][Description]]
- [[Install][Install]] - [[#install][Install]]
- [[Usage][Usage]] - [[#usage][Usage]]
- [[TRAMP access to docker containers][TRAMP access to docker containers]] - [[#tramp-access-to-docker-containers][TRAMP access to docker containers]]
- [[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

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

@ -24,7 +24,7 @@ file.
[[https://github.com/clvv/fasd][fasd]] must be installed on your system. The general installation [[https://github.com/clvv/fasd][fasd]] must be installed on your system. The general installation
instructions can be found in the repository [[https://github.com/clvv/fasd#install][README]] instructions can be found in the repository [[https://github.com/clvv/fasd#install][README]]
On OS X, it can be installed via [[https://github.com/Homebrew/homebrew][homebrew]]: On OS X, it can be installed via [[https://github.com/Homebrew/legacy-homebrew][homebrew]]:
#+BEGIN_SRC sh #+BEGIN_SRC sh
$ brew install fasd $ brew install fasd

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

@ -7,13 +7,13 @@
- [[#configuration][Configuration]] - [[#configuration][Configuration]]
- [[#ledger][Ledger]] - [[#ledger][Ledger]]
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
- [[#ledger-1][Ledger]] - [[#ledger][Ledger]]
- [[#ledger-reconcile][Ledger-Reconcile]] - [[#ledger-reconcile][Ledger-Reconcile]]
* Description * Description
This layer adds finance related packages: This layer adds finance related packages:
- [[https://github.com/ledger/ledger][ledger]] support via [[https://github.com/ledger/ledger/tree/next/lisp][ledger-mode]] - [[https://github.com/ledger/ledger][ledger]] support via [[https://www.emacswiki.org/emacs/LedgerMode][ledger-mode]]
[[file:img/ledger.png]] [[file:img/ledger.png]]

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

@ -63,7 +63,7 @@ cycling, etc.
** sunshine (weather forecast) ** sunshine (weather forecast)
Sunshine display local weather forecast. Sunshine display local weather forecast.
Setup [[http://home.openweathermap.org/][OpenWeatherMap]] API key. Setup [[https://home.openweathermap.org/users/sign_in][OpenWeatherMap]] API key.
Set ~sunshine-appid~ to some hash string from the openweathermap Set ~sunshine-appid~ to some hash string from the openweathermap
website. You need to sign up to the website to get a API key. website. You need to sign up to the website to get a API key.

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

@ -10,7 +10,7 @@
* Description * Description
This layer adds support for [[http://johnmacfarlane.net/pandoc][Pandoc]]. This layer adds support for [[http://pandoc.org/][Pandoc]].
Pandoc is a universal document converter. It makes it easy to e.g. convert a Pandoc is a universal document converter. It makes it easy to e.g. convert a
Markdown file to org mode or vice versa. It can also export your text to PDF or Markdown file to org mode or vice versa. It can also export your text to PDF or
@ -28,9 +28,9 @@ file.
To use the mode please [[http://pandoc.org/installing.html][install]] pandoc first. To use the mode please [[http://pandoc.org/installing.html][install]] pandoc first.
* Usage * Usage
For a full list of possible conversions see the [[http://johnmacfarlane.net/pandoc][Pandoc documentation]]. For a full list of possible conversions see the [[http://pandoc.org/][Pandoc documentation]].
An explanation of all the options offered by =pandoc-mode= can be found at the An explanation of all the options offered by =pandoc-mode= can be found at the
[[http://joostkremers.github.io/pandoc-mode][Pandoc-mode website]]. [[http://joostkremers.github.io/pandoc-mode/][Pandoc-mode website]].
* Key Bindings * Key Bindings

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

@ -8,7 +8,7 @@
- [[#key-bindings][Key bindings]] - [[#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/voxpupuli/puppet-mode][puppet-mode]].
* Install * Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to To use this configuration layer, add it to your =~/.spacemacs=. You will need to

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

@ -16,7 +16,7 @@
- [[#eshell][Eshell]] - [[#eshell][Eshell]]
- [[#key-bindings][Key bindings]] - [[#key-bindings][Key bindings]]
- [[#multi-term][Multi-term]] - [[#multi-term][Multi-term]]
- [[#eshell-1][Eshell]] - [[#eshell][Eshell]]
* Description * Description
This layer configures the various shells available in Emacs. This layer configures the various shells available in Emacs.
@ -169,7 +169,7 @@ Some advanced configuration is setup for =eshell= in this layer:
- =z= for quickly jumping to a previously visited directory - =z= for quickly jumping to a previously visited directory
- optional configuration for =em-smart= (see =Install= section for more info) - optional configuration for =em-smart= (see =Install= section for more info)
- support for visual commands via =em-term= - support for visual commands via =em-term=
- working directory sensitive prompt via [[https://github.com/hiddenlotus/eshell-prompt-extras][eshell-prompt-extras]] - working directory sensitive prompt via [[https://github.com/kaihaosw/eshell-prompt-extras][eshell-prompt-extras]]
- advanced help support via =esh-help= (enable =el-doc= support in eshell) - advanced help support via =esh-help= (enable =el-doc= support in eshell)
- add support for auto-completion via =company= (when the =auto-completion= - add support for auto-completion via =company= (when the =auto-completion=
layer is installed) layer is installed)

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

@ -4,6 +4,6 @@
- [[#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/keith/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.

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

@ -30,25 +30,25 @@ file.
to install the =ruby= layer as well. to install the =ruby= layer as well.
** Vagrant ** Vagrant
Follow the [[http://docs.vagrantup.com/v2/installation/index.html][Installing Vagrant]] and [[http://docs.vagrantup.com/v2/getting-started/index.html][Getting Started]] guides in Follow the [[https://www.vagrantup.com/docs/installation/index.html][Installing Vagrant]] and [[https://www.vagrantup.com/intro/getting-started/index.html][Getting Started]] guides in
Vagrant's documentation. Vagrant's documentation.
** Testing ** Testing
If you'd like to test this layer out in a simple way (for example to If you'd like to test this layer out in a simple way (for example to
make sure you have Vagrant configured correctly) there is a [[file:Vagrantfile][Vagrantfile]] make sure you have Vagrant configured correctly) there is a [[https://gist.github.com/anonymous/578279337caf180298cd91c61be995bc][Vagrantfile]]
in this directory. in this directory.
* Keybindings * Keybindings
| Key Binding | Description | | Key Binding | Description |
|-------------+------------------------------------------------------------------------------------------------| |-------------+------------------------------------------------------------------------------------------------|
| ~SPC a V D~ | destroy a box | | ~SPC a V D~ | destroy a box |
| ~SPC a V e~ | edit the =Vagrantfile= | | ~SPC a V e~ | edit the =Vagrantfile= |
| ~SPC a V H~ | halt (shut down) a box | | ~SPC a V H~ | halt (shut down) a box |
| ~SPC a V p~ | (re)provision a box that is already up | | ~SPC a V p~ | (re)provision a box that is already up |
| ~SPC a V r~ | resume a suspended box (you can also use =SPC V V= for this) | | ~SPC a V r~ | resume a suspended box (you can also use =SPC V V= for this) |
| ~SPC a V R~ | reload a box | | ~SPC a V R~ | reload a box |
| ~SPC a V s~ | view the status of running boxes in the current project | | ~SPC a V s~ | view the status of running boxes in the current project |
| ~SPC a V S~ | suspend a box | | ~SPC a V S~ | suspend a box |
| ~SPC a V t~ | start a =vagrant-tramp-term= session - after start, edit files at =/vagrant:box_name:filename= | | ~SPC a V t~ | start a =vagrant-tramp-term= session - after start, edit files at =/vagrant:box_name:filename= |
| ~SPC a V V~ | bring up a Vagrant box | | ~SPC a V V~ | bring up a Vagrant box |

14
layers/+tools/vagrant/Vagrantfile vendored
View File

@ -1,14 +0,0 @@
# -*- mode: ruby -*-
# vi: set ft=ruby :
# This file is provided for testing this layer - it doesn't really do
# very much!
# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
VAGRANTFILE_API_VERSION = "2"
Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
config.vm.box = "ubuntu/trusty64"
config.vm.provision :shell, inline: "echo provisioned"
end

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

@ -23,7 +23,7 @@ add =ycmd= to the existing =dotspacemacs-configuration-layers= list in this
file. file.
** YCMD ** YCMD
1) Install the =ycm= server. Installation instructions can be found [[https://github.com/Valloric/ycmd#building][here]]. 1) Install the =ycm= server. Installation instructions can be found [[https://github.com/Valloric/ycmd#user-content-building][here]].
2) Set the =ycmd-server-command= variable to reflect the path to the installation: 2) Set the =ycmd-server-command= variable to reflect the path to the installation:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq ycmd-server-command '("python" "/path/to/YouCompleteMe/third_party/ycmd/ycmd")) (setq ycmd-server-command '("python" "/path/to/YouCompleteMe/third_party/ycmd/ycmd"))
@ -47,7 +47,6 @@ file.
(setq ycmd-force-semantic-completion t) (setq ycmd-force-semantic-completion t)
#+END_SRC #+END_SRC
** Other Requirements ** Other Requirements
This package requires the =auto-completion= layer in order to get actual This package requires the =auto-completion= layer in order to get actual
completion. The =syntax-checking= layer is required for flycheck support. completion. The =syntax-checking= layer is required for flycheck support.
@ -67,7 +66,7 @@ specific languages like:
** Getting the compilation flags ** Getting the compilation flags
Spacemacs uses its own ycmd global configuration file. If you prefer, you can Spacemacs uses its own ycmd global configuration file. If you prefer, you can
write your own [[https://github.com/Valloric/YouCompleteMe/blob/master/README.md#c-family-semantic-completion][.ycm_extra_conf.py]]. write your own [[https://github.com/Valloric/YouCompleteMe/blob/master/README.md#user-content-c-family-semantic-completion][.ycm_extra_conf.py]].
Spacemacs will search for a compile_command.json or fall back to a Spacemacs will search for a compile_command.json or fall back to a
.clang_complete file in all parent directories of the current translation unit. .clang_complete file in all parent directories of the current translation unit.

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

@ -50,12 +50,11 @@ Here is an example of such a file (note the usage of org tags to tag your feeds)
** [[http://orgmode.org][Org Mode Links supported as well]] ** [[http://orgmode.org][Org Mode Links supported as well]]
** Software Development :dev: ** Software Development :dev:
*** Emacs :emacs:mustread: *** Emacs :emacs:mustread:
**** http://www.terminally-incoherent.com/blog/feed **** http://www.terminally-incoherent.com/blog/feed/
**** http://nullprogram.com/feed **** http://nullprogram.com/feed/
**** entry-title: \(emacs\|org-mode\) **** entry-title: \(emacs\|org-mode\)
**** http://planet.emacsen.org/atom.xml **** http://planet.emacsen.org/atom.xml
*** Web Development :web: *** Web Development :web:
**** http://planet.phpunit.de/atom.xml
**** http://feeds.feedburner.com/symfony/blog **** http://feeds.feedburner.com/symfony/blog
**** http://feeds.feedburner.com/qooxdoo/blog/content **** http://feeds.feedburner.com/qooxdoo/blog/content
*** Eclipse :eclipse: *** Eclipse :eclipse:

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

@ -11,7 +11,7 @@
* Description * Description
This layer adds support for the [[https://github.com/hrs/engine-mode/engine-mode.el][Search Engine]] package. This layer adds support for the [[https://github.com/hrs/engine-mode][Search Engine]] package.
** Supported search engines ** Supported search engines

43
layers/LAYERS.org
View File

@ -1,27 +1,26 @@
#+TITLE: Configuration layers #+TITLE: Configuration layers
#+HTML_HEAD_EXTRA: <link rel="stylesheet" type="text/css" href="../css/readtheorg.css" />
* Table of Contents :TOC_4_org:noexport: * Table of Contents :TOC_4_gh:noexport:
- [[Chat][Chat]] - [[#chat][Chat]]
- [[Checkers][Checkers]] - [[#checkers][Checkers]]
- [[Completion][Completion]] - [[#completion][Completion]]
- [[Distributions][Distributions]] - [[#distributions][Distributions]]
- [[Emacs][Emacs]] - [[#emacs][Emacs]]
- [[E-mail][E-mail]] - [[#e-mail][E-mail]]
- [[Frameworks][Frameworks]] - [[#frameworks][Frameworks]]
- [[Fun][Fun]] - [[#fun][Fun]]
- [[International support][International support]] - [[#international-support][International support]]
- [[Programming and markup languages][Programming and markup languages]] - [[#programming-and-markup-languages][Programming and markup languages]]
- [[Misc][Misc]] - [[#misc][Misc]]
- [[Operating systems][Operating systems]] - [[#operating-systems][Operating systems]]
- [[Pair programming][Pair programming]] - [[#pair-programming][Pair programming]]
- [[Source control][Source control]] - [[#source-control][Source control]]
- [[Spacemacs distribution layers][Spacemacs distribution layers]] - [[#spacemacs-distribution-layers][Spacemacs distribution layers]]
- [[Tags][Tags]] - [[#tags][Tags]]
- [[Themes][Themes]] - [[#themes][Themes]]
- [[Tools][Tools]] - [[#tools][Tools]]
- [[Vim][Vim]] - [[#vim][Vim]]
- [[Web services][Web services]] - [[#web-services][Web services]]
* Chat * Chat
- [[file:+chat/erc/README.org][erc]] - [[file:+chat/erc/README.org][erc]]