diff --git a/.travis-build.sh b/.travis-build.sh index 096ef1c16..08559cb56 100755 --- a/.travis-build.sh +++ b/.travis-build.sh @@ -147,7 +147,7 @@ if [ $TRAVIS_SECURE_ENV_VARS = true ] && [ ! -z "$PUBLISH" ]; then exit 0 else printf '=%.0s' {1..70} - printf "\n NOTING TO COMMIT!\n" + printf "\n NOTHING TO COMMIT!\n" printf '=%.0s' {1..70} echo exit 0 diff --git a/COMMUNITY.org b/COMMUNITY.org index 9e1f00048..f2ac24bbc 100644 --- a/COMMUNITY.org +++ b/COMMUNITY.org @@ -31,6 +31,7 @@ intentions. - In a nutshell: Be good, positive and/or with good intentions and focused on the project. + ** For Users - Any question related to the project is welcomed and encouraged, the worst 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 of this community. If you are not convinced then be assured that the only evil part in Spacemacs is the evil mode :-) + ** Guidelines These guidelines apply to all collaborators of the project, namely @syl20bnr, @TheBB, @d12frosted and @bmag. + *** People - Collaborators cannot ban any GitHub user from the repository but they can ban users from the official Gitter channel. - 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 below). + *** Issues - Issues can be locked if their contents are judged _inappropriate_, _offending_ or if they deviate _dangerously_ from the project. + *** Pull requests and Commmits - Collaborators can push to the repository without making a PR. - 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. - Pull request are also issues, thus issue guidelines also apply to pull requests. + *** Messages - Only the form of a message can be edited, not its meaning, except if this meaning is _outrageous_. @@ -83,11 +89,13 @@ These guidelines apply to all collaborators of the project, namely @syl20bnr, #+END_EXAMPLE - The reason is added only when needed (for instance we won't add a reason for formatting edits) + ** Interpretation Words used in these guidelines like _good_, _inappropriate_, _offending_, _dangerously_ and _outrageous_ are used without any explanation, their meanings and interpretations are left solely to the discretion of the collaborators who are educated persons working in the interest of the community. + ** Collaborators privacy Life and actions of collaborators outside of the project (i.e. outside of the 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 their roles in the project as long as they follow the moderation guidelines with good intentions. + ** Maintainer - The maintainer @syl20bnr as a BDFL is free to demote a collaborator in extreme situations. - When there is no consensus on a subject, the BDFL can decide to impose his view on the subject. + ** Log 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 moderation actions have been taken: + | Date | Moderator | Action | Issue | Reason | |------------+-----------+--------+-------+-----------------------------------------------------------------| | 2016/01/27 | syl20bnr | lock | #3484 | comments judged to be offending towards the Spacemacs community | diff --git a/Dockerfile.emacs25 b/Dockerfile.emacs25 index 93e34a72d..721e8d047 100644 --- a/Dockerfile.emacs25 +++ b/Dockerfile.emacs25 @@ -47,7 +47,7 @@ RUN cp ${UHOME}/.emacs.d/core/templates/.spacemacs.template ${UHOME}/ \ && asEnvUser emacs -batch -u ${UNAME} -kill \ && chmod ug+rw -R ${UHOME} -# test Spacemacs +# Test Spacemacs RUN asEnvUser make -C ${UHOME}/.emacs.d/tests/core/ test \ && cd ${UHOME}/.emacs.d \ && 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 \ && chmod 770 /usr/local/sbin/install-deps +# Install global dependencies (if any exists) +RUN install-deps + # Entrypoint and deps installation script will recreate it. RUN userdel $UNAME \ && groupdel $GNAME diff --git a/Dockerfile.snapshot b/Dockerfile.snapshot index 081e1f4f7..d796192bc 100644 --- a/Dockerfile.snapshot +++ b/Dockerfile.snapshot @@ -58,6 +58,9 @@ RUN ln -s \ && chown root:root /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. RUN userdel $UNAME \ && groupdel $GNAME diff --git a/README.md b/README.md index 9ac0f8729..c0bcd40de 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ - + Made with SpacemacsTwitter
***

Spacemacs

diff --git a/doc/DOCUMENTATION.org b/doc/DOCUMENTATION.org index 7b497cdc4..b7d44ee1d 100644 --- a/doc/DOCUMENTATION.org +++ b/doc/DOCUMENTATION.org @@ -2116,13 +2116,13 @@ Buffer manipulation commands (start with ~b~): **** Create a new empty buffer -| Key Binding | Description | -|-------------+--------------------------------------------------------------| -| ~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 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 n~ | create new empty buffer in current window | +| Key Binding | Description | +|-------------+-------------------------------------------------------| +| ~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 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 n~ | create new empty buffer in current window | **** Buffers manipulation transient state 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 | **** Searching in a project + | Key Binding | Description | |-----------------------+-----------------------------------------------------| | ~SPC /~ or ~SPC s p~ | search with the first found tool | diff --git a/doc/FAQ.org b/doc/FAQ.org index 4a2379b39..a29e32072 100644 --- a/doc/FAQ.org +++ b/doc/FAQ.org @@ -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 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 -[[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? This is a feature of Spacemacs, enabling you to easily escape from a lot of diff --git a/doc/LAYERS.org b/doc/LAYERS.org index 2b3e35f6a..8561d9eb6 100644 --- a/doc/LAYERS.org +++ b/doc/LAYERS.org @@ -333,7 +333,7 @@ as follows: The =:location= attribute specifies where the package may be found. Spacemacs currently supports packages on ELPA compliant repositories, local packages and -MELPA recipes (through the Quelpa package). Local packages should reside at =/local//=. 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 =/local//=. 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 will prevent the package from being installed even if it is used by another diff --git a/layers/+chat/jabber/README.org b/layers/+chat/jabber/README.org index 6c1192295..69f19050f 100644 --- a/layers/+chat/jabber/README.org +++ b/layers/+chat/jabber/README.org @@ -25,6 +25,7 @@ file. | ~SPC a j~ | Connect all accounts | ** Jabber Roster + | Key Binding | Description | | ~SPC m a~ | Jabber send presence | | ~SPC m b~ | Jabber get browse | diff --git a/layers/+chat/slack/README.org b/layers/+chat/slack/README.org index 90775ea05..0973709e5 100644 --- a/layers/+chat/slack/README.org +++ b/layers/+chat/slack/README.org @@ -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 client. -| Key Binding | Description | -|-------------+-------------------------------------------| -| ~SPC m @~ | Embed mention of user | -| ~SPC m #~ | Embed mention of channel | -| ~SPC m k~ | Join a channel, group, and direct message | +| Key Binding | Description | +|-------------+--------------------------| +| ~SPC m @~ | Embed mention of user | +| ~SPC m #~ | Embed mention of channel | +| ~SPC m k~ | Join a channel | In insert state, one can also use ~@~ and ~#~ directly without the leader key prefix. diff --git a/layers/+completion/auto-completion/README.org b/layers/+completion/auto-completion/README.org index 069012bcf..6403e96d6 100644 --- a/layers/+completion/auto-completion/README.org +++ b/layers/+completion/auto-completion/README.org @@ -14,7 +14,7 @@ - [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]] - [[#completion-back-ends][Completion back ends]] - [[#improved-faces][Improved faces]] - - [[#key-bindings-1][Key Bindings]] + - [[#key-bindings][Key Bindings]] - [[#company][Company]] - [[#auto-complete][Auto-complete]] - [[#yasnippet][Yasnippet]] diff --git a/layers/+distributions/spacemacs-base/README.org b/layers/+distributions/spacemacs-base/README.org new file mode 100644 index 000000000..1bc3e89aa --- /dev/null +++ b/layers/+distributions/spacemacs-base/README.org @@ -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 diff --git a/layers/+distributions/spacemacs-bootstrap/README.org b/layers/+distributions/spacemacs-bootstrap/README.org new file mode 100644 index 000000000..5e7dbf631 --- /dev/null +++ b/layers/+distributions/spacemacs-bootstrap/README.org @@ -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 diff --git a/layers/+distributions/spacemacs-docker/README.org b/layers/+distributions/spacemacs-docker/README.org index 873f0b732..437dbfdb9 100644 --- a/layers/+distributions/spacemacs-docker/README.org +++ b/layers/+distributions/spacemacs-docker/README.org @@ -2,13 +2,14 @@ * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] + - [[#screenshots][Screenshots]] - [[#major-benefits][Major benefits]] - - [[#how-setup][How setup]] + - [[#how-to-setup][How to setup]] - [[#how-to-use][How to use]] - [[#macos][MacOS]] - [[#windows][Windows]] - [[#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]] - [[#cons][Cons]] - [[#instruction][Instruction]] @@ -20,6 +21,7 @@ Spacemacs distribution that aims to automate dependency installation for 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]]. + ** Screenshots #+CAPTION: MacOS [[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]] [[https://i.imgur.com/WmsnCUo.jpg][HD Windows image]] + ** Major benefits - 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 @@ -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. NOTE: The guide assumes that you want to run Docker and connect to it from the same machine. + ** MacOS 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 @@ -72,6 +76,7 @@ tab and make sure you’ve got "Allow connections from network clients" ticked #+END_SRC [[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]] + ** 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=) #+BEGIN_SRC sh @@ -95,6 +100,7 @@ winpty docker run -ti --name spacemacs \ #+END_SRC [[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]] + ** GNU/Linux Make sure that =$DISPLAY= variable is set #+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` #+END_SRC [[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 *** Pros - 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) - Interactive screen sharing [[https://imgur.com/ijdSuX6][demo]] - Read/write rss/email with Emacs in web-browser (O_O) [[https://imgur.com/wDLDMZN][demo]] + *** Cons - Lag spikes with some OSes + *** 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 here is a short instruction: + **** With Xpra desktop client Get [[https://xpra.org/][Xpra]] client for your OS. then #+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:xpra@localhost:14 #+END_SRC + **** Via web-browser #+BEGIN_SRC sh docker run -ti --rm --name x11-bridge \ diff --git a/layers/+distributions/spacemacs-docker/deps-install/README.org b/layers/+distributions/spacemacs-docker/deps-install/README.org index 61806f2ad..304fdbdeb 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/README.org @@ -8,6 +8,7 @@ * Description Dependency installation scripts for Spacemacs layers in Docker environment. + * Supported layers 1. [[./installers/clojure/README.org][Clojure]] 2. [[./installers/dash/README.org][Dash]] diff --git a/layers/+distributions/spacemacs-docker/deps-install/installers/fasd/README.org b/layers/+distributions/spacemacs-docker/deps-install/installers/fasd/README.org index 314a7aaa5..89e453de1 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/installers/fasd/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/installers/fasd/README.org @@ -8,4 +8,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/fasd/README.org][fasd layer.]] * List of installed software: -1. [[https://github.com/clvv/fasd][fasd]] \ No newline at end of file +1. [[https://github.com/clvv/fasd][fasd]] diff --git a/layers/+distributions/spacemacs-docker/deps-install/installers/gtags/README.org b/layers/+distributions/spacemacs-docker/deps-install/installers/gtags/README.org index 5de3b88fd..2b0d58141 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/installers/gtags/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/installers/gtags/README.org @@ -10,4 +10,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/ * List of installed software: 1. [[http://packages.ubuntu.com/en/xenial/python-pygments][python-pygments]] 2. [[https://github.com/universal-ctags/ctags][universal-ctags]] -3. [[https://www.tamacom.com/global.html][global]] \ No newline at end of file +3. [[https://www.tamacom.com/global.html][global]] diff --git a/layers/+distributions/spacemacs-docker/deps-install/installers/html/README.org b/layers/+distributions/spacemacs-docker/deps-install/installers/html/README.org index f2a84de78..6c1f4dda5 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/installers/html/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/installers/html/README.org @@ -18,4 +18,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/ 8. [[https://github.com/sds/slim-lint][slim_lint]] 9. [[http://sass-lang.com][sass]] 10. [[https://github.com/brigade/scss-lint][scss-lint]] -11. [[https://github.com/Sweetchuck/scss_lint_reporter_checkstyle][scss_lint_reporter_checkstyle]] \ No newline at end of file +11. [[https://github.com/Sweetchuck/scss_lint_reporter_checkstyle][scss_lint_reporter_checkstyle]] diff --git a/layers/+distributions/spacemacs-docker/deps-install/installers/javascript/README.org b/layers/+distributions/spacemacs-docker/deps-install/installers/javascript/README.org index 550534294..fd4576507 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/installers/javascript/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/installers/javascript/README.org @@ -14,4 +14,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/ 4. [[https://ternjs.net/][tern]] 5. [[https://github.com/beautify-web/js-beautify][js-beautify]] 6. [[https://github.com/eslint/eslint][eslint]] -7. [[https://github.com/jshint/jshint][jshint]] \ No newline at end of file +7. [[https://github.com/jshint/jshint][jshint]] diff --git a/layers/+distributions/spacemacs-docker/deps-install/installers/pandoc/README.org b/layers/+distributions/spacemacs-docker/deps-install/installers/pandoc/README.org index d25afbf65..4b821b854 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/installers/pandoc/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/installers/pandoc/README.org @@ -8,4 +8,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Btools/pandoc/README.org][pandoc layer.]] * List of installed software: -1. [[http://packages.ubuntu.com/xenial/pandoc][pandoc]] \ No newline at end of file +1. [[http://packages.ubuntu.com/xenial/pandoc][pandoc]] diff --git a/layers/+distributions/spacemacs-docker/deps-install/installers/pdf-tools/README.org b/layers/+distributions/spacemacs-docker/deps-install/installers/pdf-tools/README.org index 63caf2b05..e244a4d8c 100644 --- a/layers/+distributions/spacemacs-docker/deps-install/installers/pdf-tools/README.org +++ b/layers/+distributions/spacemacs-docker/deps-install/installers/pdf-tools/README.org @@ -9,4 +9,4 @@ Dependency installation script for [[https://github.com/syl20bnr/spacemacs/blob/ * List of installed software: 1. [[https://www.imagemagick.org/script/index.php][imagemagick]] -2. [[https://github.com/politza/pdf-tools][pdf-tools]] \ No newline at end of file +2. [[https://github.com/politza/pdf-tools][pdf-tools]] diff --git a/layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/README.org b/layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/README.org deleted file mode 100644 index 7f8c3fc36..000000000 --- a/layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/README.org +++ /dev/null @@ -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= diff --git a/layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/deps-installers/README.org b/layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/deps-installers/README.org deleted file mode 100644 index 55ed6d95f..000000000 --- a/layers/+distributions/spacemacs-docker/dockerfiles/spacemacs-docker/usr/local/spacemacs/deps-installers/README.org +++ /dev/null @@ -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 =-docker-spacemacs-disable-dependencies-installer= to =t= -if you want to disable dependency installation for the == layer. -Example: -#+BEGIN_SRC emacs-lisp - (pandoc :variables pandoc-docker-spacemacs-disable-dependencies-installer t) -#+END_SRC diff --git a/layers/+distributions/spacemacs-docker/funcs.el b/layers/+distributions/spacemacs-docker/funcs.el index 0d90d77f3..ef4c34c4a 100644 --- a/layers/+distributions/spacemacs-docker/funcs.el +++ b/layers/+distributions/spacemacs-docker/funcs.el @@ -30,7 +30,8 @@ the `spacemacs-docker-dump-layer-data-fp' file" obarray))) (dolist (name names) (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 (string-prefix-p (configuration-layer/get-layer-path layer) @@ -40,5 +41,7 @@ the `spacemacs-docker-dump-layer-data-fp' file" (insert (format "%-28s(%s . %s)\n" "" name - (symbol-value symbol)))))))) + (if (stringp sym-val) + (format "\"%s\"" sym-val) + sym-val)))))))) (insert "))\n\n")))) diff --git a/layers/+distributions/spacemacs/README.org b/layers/+distributions/spacemacs/README.org new file mode 100644 index 000000000..852d4b374 --- /dev/null +++ b/layers/+distributions/spacemacs/README.org @@ -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 diff --git a/layers/+emacs/ibuffer/README.org b/layers/+emacs/ibuffer/README.org index 484254e3e..c864ffbb8 100644 --- a/layers/+emacs/ibuffer/README.org +++ b/layers/+emacs/ibuffer/README.org @@ -40,9 +40,9 @@ Example: * Key bindings ** Global -| Key Binding | Description | -|-------------+-------------------------------| -| ~SPC b B~ | open IBuffer menu (global) | +| Key Binding | Description | +|-------------+----------------------------| +| ~SPC b B~ | open IBuffer menu (global) | *Note:* The layer will also replace regular ~C-x C-b~ with =ibuffer=. diff --git a/layers/+emacs/org/README.org b/layers/+emacs/org/README.org index 8d7b9e398..c0302f21a 100644 --- a/layers/+emacs/org/README.org +++ b/layers/+emacs/org/README.org @@ -200,8 +200,6 @@ For example: ) #+END_SRC - - ** Different bullets You can tweak the bullets displayed in the org buffer in the function =dotspacemacs/user-config= of your dotfile by setting the variable @@ -485,7 +483,7 @@ are listed bellow. |-------------+---------------------+-----------------------------------| | ~ht~ | set status | org-agenda-todo | | ~hk~ | kill | org-agenda-kill | -| ~hR~ | refile | org-agenda-refile | +| ~hR~ | refile | org-agenda-refile | | ~hA~ | archive | org-agenda-archive-default | | ~h:~ | set tags | org-agenda-set-tags | | ~hp~ | set priority | org-agenda-priority | diff --git a/layers/+fun/selectric/README.org b/layers/+fun/selectric/README.org index 6cd5d60e7..35cda6731 100644 --- a/layers/+fun/selectric/README.org +++ b/layers/+fun/selectric/README.org @@ -6,6 +6,7 @@ - [[#description][Description]] - [[#install][Install]] - [[#key-bindings][Key Bindings]] + - [[#notes][Notes]] * Description This layer makes your Emacs sound like an IBM Selectric typewriter, for those diff --git a/layers/+lang/clojure/README.org b/layers/+lang/clojure/README.org index 80f0acb44..6081a29a4 100644 --- a/layers/+lang/clojure/README.org +++ b/layers/+lang/clojure/README.org @@ -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 e~ | display last stacktrace | -| ~SPC m d r~ | reload namespaces | +| ~SPC m d r~ | reload namespaces | | ~SPC m d v~ | inspect expression at point | *** Refactoring diff --git a/layers/+lang/common-lisp/README.org b/layers/+lang/common-lisp/README.org index 45f73172c..e4de99be9 100644 --- a/layers/+lang/common-lisp/README.org +++ b/layers/+lang/common-lisp/README.org @@ -96,12 +96,12 @@ As this state works the same for all files, the documentation is in global *** Navigation -| Key Binding | Description | -|---------------------------+--------------------| -| ~SPC m g g~ | Go to definition | -| ~SPC m g b~ | Go back | -| ~SPC m g n~ | Next note | -| ~SPC m g N~ or ~SPC m g p | Previous note | +| Key Binding | Description | +|---------------------------+------------------| +| ~SPC m g g~ | Go to definition | +| ~SPC m g b~ | Go back | +| ~SPC m g n~ | Next note | +| ~SPC m g N~ or ~SPC m g p | Previous note | *** Macroexpansion diff --git a/layers/+lang/elm/README.org b/layers/+lang/elm/README.org index 5653a56e9..6596e0439 100644 --- a/layers/+lang/elm/README.org +++ b/layers/+lang/elm/README.org @@ -25,8 +25,8 @@ - [[#elm-reactor][elm-reactor]] - [[#elm-package][elm-package]] - [[#package-list-buffer][package list buffer]] - - [[#elm-oracle-1][elm-oracle]] - - [[#elm-format-1][elm-format]] + - [[#elm-oracle][elm-oracle]] + - [[#elm-format][elm-format]] - [[#refactoring][Refactoring]] * Description @@ -217,8 +217,8 @@ cycle through the list (note that hitting any other key will cancel the cycle). ** elm-format -| Key Binding | Description | -| ~SPC m = b~ | elm-mode-format-buffer | +| Key Binding | Description | +| ~SPC m = b~ | elm-mode-format-buffer | ** Refactoring diff --git a/layers/+lang/forth/README.org b/layers/+lang/forth/README.org index 4be7bf804..724e7721f 100644 --- a/layers/+lang/forth/README.org +++ b/layers/+lang/forth/README.org @@ -1,6 +1,5 @@ #+TITLE: Forth layer - * Table of Contents :TOC_4_gh:noexport: - [[#description][Description]] - [[#install][Install]] diff --git a/layers/+lang/haskell/README.org b/layers/+lang/haskell/README.org index 1a2dfedc9..7ae337a2d 100644 --- a/layers/+lang/haskell/README.org +++ b/layers/+lang/haskell/README.org @@ -25,12 +25,12 @@ - [[#cabal-commands][Cabal commands]] - [[#cabal-files][Cabal files]] - [[#refactor][Refactor]] - - [[#ghc-mod-1][Ghc-mod]] + - [[#ghc-mod][Ghc-mod]] - [[#insert-template][Insert template]] - [[#syntax-checking][Syntax checking]] - [[#flycheck][Flycheck]] - [[#hlint][HLint]] - - [[#ghc-mod-2][ghc-mod]] + - [[#ghc-mod][ghc-mod]] - [[#interactive-haskell-mode][Interactive haskell-mode]] - [[#flymake][Flymake]] - [[#troubleshooting][Troubleshooting]] diff --git a/layers/+lang/java/README.org b/layers/+lang/java/README.org index cae536230..e56c7b8ab 100644 --- a/layers/+lang/java/README.org +++ b/layers/+lang/java/README.org @@ -12,31 +12,31 @@ - [[#installation][Installation]] - [[#about-maven][About Maven]] - [[#eclim][Eclim]] - - [[#installation-1][Installation]] + - [[#installation][Installation]] - [[#eclipse][Eclipse]] - - [[#eclim-1][Eclim]] + - [[#eclim][Eclim]] - [[#configuration][Configuration]] - [[#usage][Usage]] - [[#ensime][ENSIME]] - - [[#installation-2][Installation]] - - [[#configuration-1][Configuration]] - - [[#usage-1][Usage]] + - [[#installation][Installation]] + - [[#configuration][Configuration]] + - [[#usage][Usage]] - [[#issues][Issues]] - [[#key-bindings][Key bindings]] - - [[#meghanada-1][Meghanada]] + - [[#meghanada][Meghanada]] - [[#server][Server]] - [[#navigation][Navigation]] - [[#compilation][Compilation]] - [[#tests-junit][Tests (junit)]] - [[#refactoring][Refactoring]] - [[#tasks][Tasks]] - - [[#eclim-2][Eclim]] + - [[#eclim][Eclim]] - [[#java-mode][Java-mode]] - [[#project-management][Project management]] - [[#eclim-daemon][Eclim daemon]] - [[#maven][Maven]] - [[#goto][Goto]] - - [[#refactoring-1][Refactoring]] + - [[#refactoring][Refactoring]] - [[#documentation-find][Documentation, Find]] - [[#errors-problems][Errors (problems)]] - [[#tests][Tests]] @@ -48,12 +48,12 @@ - [[#typecheck][Typecheck]] - [[#debug][Debug]] - [[#errors][Errors]] - - [[#goto-1][Goto]] + - [[#goto][Goto]] - [[#print-and-yank-types][Print and yank types]] - [[#documentation-inspect][Documentation, Inspect]] - - [[#server-1][Server]] - - [[#refactoring-2][Refactoring]] - - [[#tests-1][Tests]] + - [[#server][Server]] + - [[#refactoring][Refactoring]] + - [[#tests][Tests]] - [[#repl][REPL]] * 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~. - * Backends ** Meghanada Meghanada is composed of a lightweight server and an Emacs minor mode. It @@ -247,11 +246,11 @@ particular refactoring doesn't work. *** Refactoring - | Key Binding | Description | - |-------------+----------------------------------------------| - | ~SPC m =~ | Beautify code | - | ~SPC m r i~ | Optimize imports | - | ~SPC m r I~ | Import all | + | Key Binding | Description | + |-------------+------------------| + | ~SPC m =~ | Beautify code | + | ~SPC m r i~ | Optimize imports | + | ~SPC m r I~ | Import all | *** Tasks @@ -429,6 +428,7 @@ particular refactoring doesn't work. | ~SPC m g t~ | go to test | *** Print and yank types + |-------------+--------------------------------| | ~SPC m h T~ | print full type name at point | | ~SPC m h t~ | print short type name at point | diff --git a/layers/+lang/rest/README.org b/layers/+lang/rest/README.org index d963280fc..8bc8427ed 100644 --- a/layers/+lang/rest/README.org +++ b/layers/+lang/rest/README.org @@ -1,15 +1,13 @@ #+TITLE: reStructuredText layer -[[file:img/restructuredtext.png]] - -* Table of Contents :TOC_4_org:noexport: - - [[Description][Description]] - - [[Features][Features]] - - [[Install][Install]] - - [[Configuration][Configuration]] - - [[Sphinx target][Sphinx target]] - - [[Web browser][Web browser]] - - [[Key bindings][Key bindings]] +* Table of Contents :TOC_4_gh:noexport: + - [[#description][Description]] + - [[#features][Features]] + - [[#install][Install]] + - [[#configuration][Configuration]] + - [[#sphinx-target][Sphinx target]] + - [[#web-browser][Web browser]] + - [[#key-bindings][Key bindings]] * Description The layer adds ReStructuredText (ReST) support to Spacemacs and adds some diff --git a/layers/+lang/ruby/README.org b/layers/+lang/ruby/README.org index d9d7df918..4cdad0fe5 100644 --- a/layers/+lang/ruby/README.org +++ b/layers/+lang/ruby/README.org @@ -65,7 +65,7 @@ specific documentation for details and caveats): #+END_SRC ** 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 example: diff --git a/layers/+lang/scala/README.org b/layers/+lang/scala/README.org index a6b4d8e49..63aaf3bc4 100644 --- a/layers/+lang/scala/README.org +++ b/layers/+lang/scala/README.org @@ -15,7 +15,7 @@ - [[#key-bindings][Key bindings]] * 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. * Layer Installation @@ -24,7 +24,7 @@ add =scala= to the existing =dotspacemacs-configuration-layers= list in this file. * 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. ENSIME requires a configuration file at the root of each Scala project. It diff --git a/layers/+lang/shell-scripts/README.org b/layers/+lang/shell-scripts/README.org index c2bca5ee7..5a681a168 100644 --- a/layers/+lang/shell-scripts/README.org +++ b/layers/+lang/shell-scripts/README.org @@ -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 m \~ | insert end-of-line backslashes to the lines in the region | - diff --git a/layers/+lang/swift/README.org b/layers/+lang/swift/README.org index 13e189e69..68688568c 100644 --- a/layers/+lang/swift/README.org +++ b/layers/+lang/swift/README.org @@ -14,7 +14,7 @@ This layer adds support for Apple's Swift programming language, used as a 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: - Syntax highlighting diff --git a/layers/+misc/nlinum/README.org b/layers/+misc/nlinum/README.org new file mode 100644 index 000000000..2c8e6d68e --- /dev/null +++ b/layers/+misc/nlinum/README.org @@ -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 diff --git a/layers/+source-control/git/README.org b/layers/+source-control/git/README.org index 2ce07d128..6afcd9b88 100644 --- a/layers/+source-control/git/README.org +++ b/layers/+source-control/git/README.org @@ -20,7 +20,7 @@ - [[#commit-message-editing-buffer][Commit message editing buffer]] - [[#interactive-rebase-buffer][Interactive rebase buffer]] - [[#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-links-to-web-services][Git links to web services]] - [[#repository-list][Repository list]] diff --git a/layers/+source-control/github/README.org b/layers/+source-control/github/README.org index 9a65e3fa3..01f8a9632 100644 --- a/layers/+source-control/github/README.org +++ b/layers/+source-control/github/README.org @@ -64,13 +64,13 @@ possible. ** magithub -| Key Binding | Description | -|-------------+-------------------------------------------------------------| -| ~@ H~ | opens the current repository in the browser | -| ~@ c~ | pushes a brand-new local repository up to GitHub | -| ~@ f~ | create a fork of an existing repository | -| ~@ p~ | submit pull request upstream | -| ~@ i~ | create an issue | +| Key Binding | Description | +|-------------+--------------------------------------------------| +| ~@ H~ | opens the current repository in the browser | +| ~@ c~ | pushes a brand-new local repository up to GitHub | +| ~@ f~ | create a fork of an existing repository | +| ~@ p~ | submit pull request upstream | +| ~@ i~ | create an issue | ** gist.el diff --git a/layers/+source-control/perforce/README.org b/layers/+source-control/perforce/README.org index 7308835a3..ae5fe488e 100644 --- a/layers/+source-control/perforce/README.org +++ b/layers/+source-control/perforce/README.org @@ -9,14 +9,14 @@ * Description -This layer adds support for [[http://www.perforce.com/][Perforce]] (p4). +This layer adds support for [[https://www.perforce.com/][Perforce]] (p4). * Install To use this configuration layer, add it to your =~/.spacemacs=. You will need to add =perforce= to the existing =dotspacemacs-configuration-layers= list in this file. -You'll have to install the =p4== command line tool from the [[http://www.perforce.com/downloads][download page]]. +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: - =P4_PORT= diff --git a/layers/+source-control/version-control/README.org b/layers/+source-control/version-control/README.org index d4ecfd382..458a1d73d 100644 --- a/layers/+source-control/version-control/README.org +++ b/layers/+source-control/version-control/README.org @@ -97,7 +97,6 @@ one over the other: | ~SPC g . F~ | Pull repo with popup | | ~SPC g . l~ | Show repo log | - ** Smerge Mode Transient-state | Key Binding | Description | diff --git a/layers/+spacemacs/spacemacs-completion/README.org b/layers/+spacemacs/spacemacs-completion/README.org new file mode 100644 index 000000000..fbcc1348f --- /dev/null +++ b/layers/+spacemacs/spacemacs-completion/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-editing-visual/README.org b/layers/+spacemacs/spacemacs-editing-visual/README.org new file mode 100644 index 000000000..d07e63e62 --- /dev/null +++ b/layers/+spacemacs/spacemacs-editing-visual/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-editing/README.org b/layers/+spacemacs/spacemacs-editing/README.org new file mode 100644 index 000000000..7d2340966 --- /dev/null +++ b/layers/+spacemacs/spacemacs-editing/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-evil/README.org b/layers/+spacemacs/spacemacs-evil/README.org new file mode 100644 index 000000000..7f8dc07b6 --- /dev/null +++ b/layers/+spacemacs/spacemacs-evil/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-language/README.org b/layers/+spacemacs/spacemacs-language/README.org new file mode 100644 index 000000000..f454b2f3d --- /dev/null +++ b/layers/+spacemacs/spacemacs-language/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-layouts/README.org b/layers/+spacemacs/spacemacs-layouts/README.org new file mode 100644 index 000000000..e0b76cb7c --- /dev/null +++ b/layers/+spacemacs/spacemacs-layouts/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-misc/README.org b/layers/+spacemacs/spacemacs-misc/README.org new file mode 100644 index 000000000..e7cd7dcbd --- /dev/null +++ b/layers/+spacemacs/spacemacs-misc/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-modeline/README.org b/layers/+spacemacs/spacemacs-modeline/README.org new file mode 100644 index 000000000..85f60e458 --- /dev/null +++ b/layers/+spacemacs/spacemacs-modeline/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-navigation/README.org b/layers/+spacemacs/spacemacs-navigation/README.org new file mode 100644 index 000000000..216af9fdb --- /dev/null +++ b/layers/+spacemacs/spacemacs-navigation/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-org/README.org b/layers/+spacemacs/spacemacs-org/README.org new file mode 100644 index 000000000..4316a0393 --- /dev/null +++ b/layers/+spacemacs/spacemacs-org/README.org @@ -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 diff --git a/layers/+spacemacs/spacemacs-visual/README.org b/layers/+spacemacs/spacemacs-visual/README.org new file mode 100644 index 000000000..1ea81c769 --- /dev/null +++ b/layers/+spacemacs/spacemacs-visual/README.org @@ -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 diff --git a/layers/+themes/colors/README.org b/layers/+themes/colors/README.org index b97ca57a2..81593827a 100644 --- a/layers/+themes/colors/README.org +++ b/layers/+themes/colors/README.org @@ -9,7 +9,7 @@ - [[#colorize-identifiers][Colorize identifiers]] - [[#enable-nyan-cat][Enable Nyan cat]] - [[#key-bindings][Key bindings]] - - [[#colorize-identifiers-1][Colorize Identifiers]] + - [[#colorize-identifiers][Colorize Identifiers]] - [[#rainbow-mode][Rainbow Mode]] - [[#nyan-mode][Nyan Mode]] diff --git a/layers/+tools/cfengine/README.org b/layers/+tools/cfengine/README.org index 48db1fe05..250660b07 100644 --- a/layers/+tools/cfengine/README.org +++ b/layers/+tools/cfengine/README.org @@ -56,4 +56,4 @@ from anchor= to =2=. For example: | Key Binding | Description | |-------------+-----------------------| -| ~SPC m j~ | Reformats JSON string | +| ~SPC m j~ | Reformats JSON string | diff --git a/layers/+tools/chrome/README.org b/layers/+tools/chrome/README.org index e9a0b5f4e..c2a54e146 100644 --- a/layers/+tools/chrome/README.org +++ b/layers/+tools/chrome/README.org @@ -15,10 +15,9 @@ This layer provides some integration with the Google Chrome browser. ** 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]] - * Install ** Layer 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. ** 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. More information can be found on [[http://www.emacswiki.org/emacs/Edit_with_Emacs][Emacs Wiki]]. diff --git a/layers/+tools/dash/README.org b/layers/+tools/dash/README.org index ea673423e..da8e8c29f 100644 --- a/layers/+tools/dash/README.org +++ b/layers/+tools/dash/README.org @@ -8,20 +8,21 @@ - [[#description][Description]] - [[#install][Install]] - [[#dash-os-x][Dash (OS X)]] + - [[#sqlite3][Sqlite3]] - [[#zeal-linux--windows][Zeal (Linux & Windows)]] - [[#check-documentation-for-x-at-point][Check Documentation for x-at-point]] - [[#key-bindings][Key bindings]] - [[#helm-dash-and-counsel-dash][helm-dash and counsel-dash]] * 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. - [[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 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. - [[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) -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 when using this layer. ** 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) -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 diff --git a/layers/+tools/docker/README.org b/layers/+tools/docker/README.org index 12544460c..8d71d59de 100644 --- a/layers/+tools/docker/README.org +++ b/layers/+tools/docker/README.org @@ -3,11 +3,11 @@ [[file:img/docker.png]] * Table of Contents :TOC_4_gh:noexport: - - [[Description][Description]] - - [[Install][Install]] - - [[Usage][Usage]] - - [[TRAMP access to docker containers][TRAMP access to docker containers]] - - [[Key bindings][Key bindings]] + - [[#description][Description]] + - [[#install][Install]] + - [[#usage][Usage]] + - [[#tramp-access-to-docker-containers][TRAMP access to docker containers]] + - [[#key-bindings][Key bindings]] * Description This layer provides syntax highlighting and build functionality for Docker files diff --git a/layers/+tools/fasd/README.org b/layers/+tools/fasd/README.org index 25a742fe0..634414359 100644 --- a/layers/+tools/fasd/README.org +++ b/layers/+tools/fasd/README.org @@ -24,7 +24,7 @@ file. [[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]] -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 $ brew install fasd diff --git a/layers/+tools/finance/README.org b/layers/+tools/finance/README.org index 79cb1bb35..4c702282f 100644 --- a/layers/+tools/finance/README.org +++ b/layers/+tools/finance/README.org @@ -7,13 +7,13 @@ - [[#configuration][Configuration]] - [[#ledger][Ledger]] - [[#key-bindings][Key bindings]] - - [[#ledger-1][Ledger]] + - [[#ledger][Ledger]] - [[#ledger-reconcile][Ledger-Reconcile]] * Description 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]] diff --git a/layers/+tools/geolocation/README.org b/layers/+tools/geolocation/README.org index a14d21306..2efd8995e 100644 --- a/layers/+tools/geolocation/README.org +++ b/layers/+tools/geolocation/README.org @@ -63,7 +63,7 @@ cycling, etc. ** sunshine (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 website. You need to sign up to the website to get a API key. diff --git a/layers/+tools/pandoc/README.org b/layers/+tools/pandoc/README.org index a1d14f2c2..e0efcf3f5 100644 --- a/layers/+tools/pandoc/README.org +++ b/layers/+tools/pandoc/README.org @@ -10,7 +10,7 @@ * 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 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. * 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 -[[http://joostkremers.github.io/pandoc-mode][Pandoc-mode website]]. +[[http://joostkremers.github.io/pandoc-mode/][Pandoc-mode website]]. * Key Bindings diff --git a/layers/+tools/puppet/README.org b/layers/+tools/puppet/README.org index 5102858b1..4950461b6 100644 --- a/layers/+tools/puppet/README.org +++ b/layers/+tools/puppet/README.org @@ -8,7 +8,7 @@ - [[#key-bindings][Key bindings]] * 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 To use this configuration layer, add it to your =~/.spacemacs=. You will need to diff --git a/layers/+tools/shell/README.org b/layers/+tools/shell/README.org index 65beeefd1..e19b089c8 100644 --- a/layers/+tools/shell/README.org +++ b/layers/+tools/shell/README.org @@ -16,7 +16,7 @@ - [[#eshell][Eshell]] - [[#key-bindings][Key bindings]] - [[#multi-term][Multi-term]] - - [[#eshell-1][Eshell]] + - [[#eshell][Eshell]] * Description 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 - optional configuration for =em-smart= (see =Install= section for more info) - 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) - add support for auto-completion via =company= (when the =auto-completion= layer is installed) diff --git a/layers/+tools/tmux/README.org b/layers/+tools/tmux/README.org index b14540f1c..c9519bc28 100644 --- a/layers/+tools/tmux/README.org +++ b/layers/+tools/tmux/README.org @@ -4,6 +4,6 @@ - [[#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. diff --git a/layers/+tools/vagrant/README.org b/layers/+tools/vagrant/README.org index fc82bf02c..5816a851f 100644 --- a/layers/+tools/vagrant/README.org +++ b/layers/+tools/vagrant/README.org @@ -30,25 +30,25 @@ file. to install the =ruby= layer as well. ** Vagrant -Follow the [[http://docs.vagrantup.com/v2/installation/index.html][Installing Vagrant]] and [[http://docs.vagrantup.com/v2/getting-started/index.html][Getting Started]] guides in +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. ** Testing If you'd like to test this layer out in a simple way (for example to -make sure you have Vagrant configured correctly) there is a [[file:Vagrantfile][Vagrantfile]] +make sure you have Vagrant configured correctly) there is a [[https://gist.github.com/anonymous/578279337caf180298cd91c61be995bc][Vagrantfile]] in this directory. * Keybindings | Key Binding | Description | |-------------+------------------------------------------------------------------------------------------------| -| ~SPC a V D~ | destroy a box | -| ~SPC a V e~ | edit the =Vagrantfile= | -| ~SPC a V H~ | halt (shut down) a box | -| ~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~ | reload a box | -| ~SPC a V s~ | view the status of running boxes in the current project | -| ~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 V~ | bring up a Vagrant box | +| ~SPC a V D~ | destroy a box | +| ~SPC a V e~ | edit the =Vagrantfile= | +| ~SPC a V H~ | halt (shut down) a box | +| ~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~ | reload a box | +| ~SPC a V s~ | view the status of running boxes in the current project | +| ~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 V~ | bring up a Vagrant box | diff --git a/layers/+tools/vagrant/Vagrantfile b/layers/+tools/vagrant/Vagrantfile deleted file mode 100644 index 245438d78..000000000 --- a/layers/+tools/vagrant/Vagrantfile +++ /dev/null @@ -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 diff --git a/layers/+tools/ycmd/README.org b/layers/+tools/ycmd/README.org index 25e14d315..6583fbb04 100644 --- a/layers/+tools/ycmd/README.org +++ b/layers/+tools/ycmd/README.org @@ -23,7 +23,7 @@ add =ycmd= to the existing =dotspacemacs-configuration-layers= list in this file. ** 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: #+BEGIN_SRC emacs-lisp (setq ycmd-server-command '("python" "/path/to/YouCompleteMe/third_party/ycmd/ycmd")) @@ -47,7 +47,6 @@ file. (setq ycmd-force-semantic-completion t) #+END_SRC - ** Other Requirements This package requires the =auto-completion= layer in order to get actual completion. The =syntax-checking= layer is required for flycheck support. @@ -67,7 +66,7 @@ specific languages like: ** Getting the compilation flags 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 .clang_complete file in all parent directories of the current translation unit. diff --git a/layers/+web-services/elfeed/README.org b/layers/+web-services/elfeed/README.org index 260139934..96075bc5b 100644 --- a/layers/+web-services/elfeed/README.org +++ b/layers/+web-services/elfeed/README.org @@ -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]] ** Software Development :dev: *** Emacs :emacs:mustread: - **** http://www.terminally-incoherent.com/blog/feed - **** http://nullprogram.com/feed + **** http://www.terminally-incoherent.com/blog/feed/ + **** http://nullprogram.com/feed/ **** entry-title: \(emacs\|org-mode\) **** http://planet.emacsen.org/atom.xml *** Web Development :web: - **** http://planet.phpunit.de/atom.xml **** http://feeds.feedburner.com/symfony/blog **** http://feeds.feedburner.com/qooxdoo/blog/content *** Eclipse :eclipse: diff --git a/layers/+web-services/search-engine/README.org b/layers/+web-services/search-engine/README.org index 3cfc64bda..5c590eb57 100644 --- a/layers/+web-services/search-engine/README.org +++ b/layers/+web-services/search-engine/README.org @@ -11,7 +11,7 @@ * 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 diff --git a/layers/LAYERS.org b/layers/LAYERS.org index 80460c40e..d29929481 100644 --- a/layers/LAYERS.org +++ b/layers/LAYERS.org @@ -1,27 +1,26 @@ #+TITLE: Configuration layers -#+HTML_HEAD_EXTRA: -* Table of Contents :TOC_4_org:noexport: - - [[Chat][Chat]] - - [[Checkers][Checkers]] - - [[Completion][Completion]] - - [[Distributions][Distributions]] - - [[Emacs][Emacs]] - - [[E-mail][E-mail]] - - [[Frameworks][Frameworks]] - - [[Fun][Fun]] - - [[International support][International support]] - - [[Programming and markup languages][Programming and markup languages]] - - [[Misc][Misc]] - - [[Operating systems][Operating systems]] - - [[Pair programming][Pair programming]] - - [[Source control][Source control]] - - [[Spacemacs distribution layers][Spacemacs distribution layers]] - - [[Tags][Tags]] - - [[Themes][Themes]] - - [[Tools][Tools]] - - [[Vim][Vim]] - - [[Web services][Web services]] +* Table of Contents :TOC_4_gh:noexport: + - [[#chat][Chat]] + - [[#checkers][Checkers]] + - [[#completion][Completion]] + - [[#distributions][Distributions]] + - [[#emacs][Emacs]] + - [[#e-mail][E-mail]] + - [[#frameworks][Frameworks]] + - [[#fun][Fun]] + - [[#international-support][International support]] + - [[#programming-and-markup-languages][Programming and markup languages]] + - [[#misc][Misc]] + - [[#operating-systems][Operating systems]] + - [[#pair-programming][Pair programming]] + - [[#source-control][Source control]] + - [[#spacemacs-distribution-layers][Spacemacs distribution layers]] + - [[#tags][Tags]] + - [[#themes][Themes]] + - [[#tools][Tools]] + - [[#vim][Vim]] + - [[#web-services][Web services]] * Chat - [[file:+chat/erc/README.org][erc]]