diff --git a/doc/CONTRIBUTE.org b/doc/CONTRIBUTE.org index 37f53eff6..6d0a46f81 100644 --- a/doc/CONTRIBUTE.org +++ b/doc/CONTRIBUTE.org @@ -1,28 +1,27 @@ -* Contribute to Spacemacs +#+SETUPFILE: theme-readtheorg.setup -** Table of Contents :TOC@4: - - [[#contribute-to-spacemacs][Contribute to Spacemacs]] - - [[#pull-request-guidelines][Pull Request Guidelines]] - - [[#ideally-and-for-simple-prs][Ideally and for /simple/ PRs:]] - - [[#for-complex-pull-requests][For complex pull requests:]] - - [[#getting-help][Getting Help]] - - [[#submitting-a-configuration-layer][Submitting a configuration layer]] - - [[#testing][Testing]] - - [[#submitting-a-banner][Submitting a banner]] - - [[#credits][Credits]] - - [[#license][License]] - - [[#file-header][File header]] - - [[#author-of-a-contribution-layer][Author of a contribution layer]] - - [[#contributor-of-a-contribution-layer][Contributor of a contribution layer]] +* Contribute to Spacemacs :TOC_4_org:noexport: + - [[Pull Request Guidelines][Pull Request Guidelines]] + - [[Ideally and for /simple/ PRs:][Ideally and for /simple/ PRs:]] + - [[For complex pull requests:][For complex pull requests:]] + - [[Getting Help][Getting Help]] + - [[Submitting a configuration layer][Submitting a configuration layer]] + - [[Testing][Testing]] + - [[Submitting a banner][Submitting a banner]] + - [[Credits][Credits]] + - [[License][License]] + - [[File header][File header]] + - [[Author of a contribution layer][Author of a contribution layer]] + - [[Contributor of a contribution layer][Contributor of a contribution layer]] -** Pull Request Guidelines +* Pull Request Guidelines Spacemacs branch model is inspired from the [[http://nvie.com/posts/a-successful-git-branching-model/][git-flow]] model: You'll have to submit your contributions and fixes within a pull-request to apply against the =develop= branch. /PR = pull request/ -*** Ideally and for /simple/ PRs: +** Ideally and for /simple/ PRs: - branch from =develop= - one topic per PR - one commit per PR @@ -35,19 +34,19 @@ apply against the =develop= branch. Those PRs are /fast-forwarded/ whenever it's possible and /cherry-picked/ otherwise (most likely they will be cherry-picked). -*** For complex pull requests: +** For complex pull requests: - squash only the commits with uninteresting changes like typos, syntax fixes, etc... and keep the important and /isolated/ steps in different commits. Those PRs are /merged/ and explicitly /not fast-forwarded/. -*** Getting Help +** Getting Help If you have any question on this process, join the [[https://gitter.im/syl20bnr/spacemacs][gitter chatroom]] and ask your questions there. It will be a pleasure to help you to contribute! -** Submitting a configuration layer +* Submitting a configuration layer Contributed configuration layers are stored in the =layers= folder. The =layers= folder also contains categories prefixed with =+= to put your layers in. For example a layer for a language would go in the @@ -62,9 +61,9 @@ It is recommended to join a =README.org= file with your layer: - if a logo exists for the layer you can add it at the top of the =README.org= before the TOC. The maximum recommended height is 200 pixels. -Please read the [[LAYERS.org][tips for writing layers]] first. +Please read the [[file:LAYERS.org][tips for writing layers]] first. -** Testing +* Testing Tests live in the =tests= folder, with a folder structure corresponding to the rest of the repository. @@ -104,7 +103,7 @@ To add tests for a layer, do the following: Spacemacs is lacking tests, so contributions are welcome. -** Submitting a banner +* Submitting a banner The startup banner is by default randomly chosen among a pool of banners each time Spacemacs starts. Banners are located in directory =~/.emacs.d/core/banners=. @@ -114,8 +113,8 @@ If you have some ASCII skills you can submit your artwork! You are free to choose a reasonable height size but the width size should be around 75 characters. -** Credits -*** License +* Credits +** License The license is GPLv3 for all parts specific to Spacemacs, this includes: - the initialization and core files - all the layer files. @@ -123,7 +122,7 @@ For files not belonging to Spacemacs like extensions and libraries, refer to the header file. Those files should not have an empty header, please report any file imported in Spacemacs without a proper header. -*** File header +** File header Template: #+BEGIN_EXAMPLE @@ -140,14 +139,14 @@ Template: ;;; License: GPLv3 #+END_EXAMPLE -*** Author of a contribution layer +** Author of a contribution layer In the file header: - change =NAME= to the name of the layer, - change the default author name =Sylvain Benner= to your name, - do not remove the line: =;; Copyright (c) 2012-2014 Sylvain Benner= - modify the second copyright line by replacing the default name and dates, *keep* =& Contributors= in this line, - other lines should not be modified -*** Contributor of a contribution layer +** Contributor of a contribution layer You should not modify any header file. A very cool way to show your contributions will be available in Spacemacs at some point, /Stay Tuned/. diff --git a/doc/CONVENTIONS.org b/doc/CONVENTIONS.org index c66f299f3..9e770a321 100644 --- a/doc/CONVENTIONS.org +++ b/doc/CONVENTIONS.org @@ -1,43 +1,43 @@ -* Spacemacs conventions -** Table of Contents :TOC@4: - - [[#spacemacs-conventions][Spacemacs conventions]] - - [[#code-guidelines][Code guidelines]] - - [[#spacemacs-core-and-layer][Spacemacs core and layer]] - - [[#all-layers][All layers]] - - [[#key-bindings-conventions][Key bindings conventions]] - - [[#reserved-prefix][Reserved prefix]] - - [[#user-prefix][User prefix]] - - [[#major-mode-prefix][Major mode prefix]] - - [[#micro-state][Micro-state]] - - [[#evilified-buffers][Evilified buffers]] - - [[#navigation][Navigation]] - - [[#n-and-n][n and N]] - - [[#code-navigation][Code Navigation]] - - [[#insert-state-buffers][=insert state= buffers]] - - [[#evaluation][Evaluation]] - - [[#repls][REPLs]] - - [[#send-code][Send code]] - - [[#in-terminal][In terminal]] - - [[#building-and-compilation][Building and Compilation]] - - [[#debugging][Debugging]] - - [[#plain-text-markup-languages][Plain Text Markup Languages]] - - [[#headers][Headers]] - - [[#insertion-of-common-elements][Insertion of common elements]] - - [[#text-manipulation][Text manipulation]] - - [[#movement-in-normal-mode][Movement in normal mode]] - - [[#promotion-demotion-and-element-movement][Promotion, Demotion and element movement]] - - [[#table-editing][Table editing]] - - [[#tests][Tests]] - - [[#all-languages][All languages]] - - [[#language-specific][Language specific]] - - [[#toggles][Toggles]] - - [[#refactoring][Refactoring]] - - [[#help-or-documentation][Help or Documentation]] - - [[#writing-documentation][Writing documentation]] - - [[#spacing-in-documentation][Spacing in documentation]] +#+SETUPFILE: theme-readtheorg.setup -** Code guidelines -*** Spacemacs core and layer +* Spacemacs conventions :TOC_4_org:noexport: + - [[Code guidelines][Code guidelines]] + - [[Spacemacs core and layer][Spacemacs core and layer]] + - [[All layers][All layers]] + - [[Key bindings conventions][Key bindings conventions]] + - [[Reserved prefix][Reserved prefix]] + - [[User prefix][User prefix]] + - [[Major mode prefix][Major mode prefix]] + - [[Micro-state][Micro-state]] + - [[Evilified buffers][Evilified buffers]] + - [[Navigation][Navigation]] + - [[n and N][n and N]] + - [[Code Navigation][Code Navigation]] + - [[=insert state= buffers][=insert state= buffers]] + - [[Evaluation][Evaluation]] + - [[REPLs][REPLs]] + - [[Send code][Send code]] + - [[In terminal][In terminal]] + - [[Building and Compilation][Building and Compilation]] + - [[Debugging][Debugging]] + - [[Plain Text Markup Languages][Plain Text Markup Languages]] + - [[Headers][Headers]] + - [[Insertion of common elements][Insertion of common elements]] + - [[Text manipulation][Text manipulation]] + - [[Movement in normal mode][Movement in normal mode]] + - [[Promotion, Demotion and element movement][Promotion, Demotion and element movement]] + - [[Table editing][Table editing]] + - [[Tests][Tests]] + - [[All languages][All languages]] + - [[Language specific][Language specific]] + - [[Toggles][Toggles]] + - [[Refactoring][Refactoring]] + - [[Help or Documentation][Help or Documentation]] + - [[Writing documentation][Writing documentation]] + - [[Spacing in documentation][Spacing in documentation]] + +* Code guidelines +** Spacemacs core and layer Function names follow these conventions: - =spacemacs/xxx= is an interactive function called =xxx= - =spacemacs//xxx= is a private function called =xxx= (implementation details) @@ -47,22 +47,22 @@ Variables follow these conventions: - =spacemacs-xxx= is a variable - =spacemacs--xxx= is a private variable (implementation details) -*** All layers +** All layers A package is initialized in a function with name =/init-xxx= where: - == is the layer name - =xxx= is the package name -** Key bindings conventions -*** Reserved prefix -**** User prefix +* Key bindings conventions +** Reserved prefix +*** User prefix ~SPC o~ and ~SPC m o~ must not be used by any layer. They are reserved for the user. -**** Major mode prefix +*** Major mode prefix ~SPC m~ is reserved for the current major mode. Three keys bindings are not an issue (ie. ~SPC m h d~) since ~SPC m~ can be accessed via ~,~. -**** Micro-state +*** Micro-state Whenever possible a micro-state should be enabled with ~M-SPC~ and ~s-M-SPC~. We need the latter bindings on OS X since ~M-SPC~ is used by the OS for spotlight. @@ -71,7 +71,7 @@ buffers are good candidates to be put on ~M-SPC~ and ~s-M-SPC~. It is recommended to add ~q~ to leave the micro-state. -*** Evilified buffers +** Evilified buffers /Evilifying/ a buffer is to set the =evilified state= as the default state for the major mode of the buffer. @@ -100,17 +100,17 @@ rules: If a key binding cannot be remapped then it is ignored and a warning message is displayed in =*Messages*=. -*** Navigation -**** n and N +** Navigation +*** n and N To be consistent with the Vim way, ~n~ and ~N~ are favored over Emacs ~n~ and ~p~. Ideally a micro-state should be provided to smooth the navigation experience. A micro-state allows to repeat key bindings without entering each time the prefix commands. More info on micro-states in the -[[DOCUMENTATION.org#micro-states][documentation]]. +[[file:DOCUMENTATION.org::Micro-states][documentation]]. -**** Code Navigation +*** Code Navigation The prefix for going to something is ~SPC m g~. | Key | Description | @@ -121,7 +121,7 @@ The prefix for going to something is ~SPC m g~. | ~m g G~ | go to things under point in other window | | ~m g t~ | go to corresponding test file if any | -**** =insert state= buffers +*** =insert state= buffers Navigation in buffers like =Helm= and =ido= which are in =insert state= should be performed with ~C-j~ and ~C-k~ bindings for vertical movements. @@ -130,7 +130,7 @@ should be performed with ~C-j~ and ~C-k~ bindings for vertical movements. | ~C-j~ | go down | | ~C-k~ | go up | -*** Evaluation +** Evaluation Live evaluation of code is under the prefix ~SPC m e~. | Key | Description | @@ -142,8 +142,8 @@ Live evaluation of code is under the prefix ~SPC m e~. | ~m e l~ | evaluate line | | ~m e r~ | evaluate region | -*** REPLs -**** Send code +** REPLs +*** Send code A lot of languages can interact with a REPL. To help keeping a consistent behavior between those languages the following conventions should be followed: @@ -168,7 +168,7 @@ should be followed: Note: we don't distinguish between the file and the buffer. -**** In terminal +*** In terminal History navigation in shells or REPLs buffers should be bound as well to ~C-j~ and ~C-k~. @@ -179,7 +179,7 @@ History navigation in shells or REPLs buffers should be bound as well to | ~C-l~ | clear screen | | ~C-r~ | search backward in history | -*** Building and Compilation +** Building and Compilation The base prefix for major mode specific compilation is ~SPC m c~. | Key Binding | Description | @@ -191,7 +191,7 @@ The base prefix for major mode specific compilation is ~SPC m c~. Note: we don't distinguish between the file and the buffer. We can implement an auto-save of the buffer before compiling the buffer. -*** Debugging +** Debugging The base prefix for debugging commands is ~SPC d~. | Key Binding | Description | @@ -213,11 +213,11 @@ Notes: the spacemacs level and ideally the function should be proposed as a patch upstream (major mode repository). -*** Plain Text Markup Languages +** Plain Text Markup Languages For layers supporting markup languages please follow the following keybindings whenever applicable. -**** Headers +*** Headers All header functionality should be grouped under ~SPC m h~ | Key Binding | Description | @@ -226,7 +226,7 @@ All header functionality should be grouped under ~SPC m h~ | ~m h I~ | Insert a header alternative method (if existing) | | ~m h 1..10~ | Insert a header of level 1..10 (if possible) | -**** Insertion of common elements +*** Insertion of common elements Insertion of common elements like links or footnotes should be grouped under ~SPC m i~ @@ -238,7 +238,7 @@ under ~SPC m i~ | ~m i u~ | Insert url | | ~m i w~ | Insert wiki-link | -**** Text manipulation +*** Text manipulation Manipulation of text regions should be grouped under ~SPC m x~ | Key Binding | Description | @@ -252,7 +252,7 @@ Manipulation of text regions should be grouped under ~SPC m x~ | ~m x u~ | Make region underlined | | ~m x v~ | Make region verbose | -**** Movement in normal mode +*** Movement in normal mode In normal mode Vim style movement should be enabled with these keybindings: | Key Binding | Description | @@ -262,7 +262,7 @@ In normal mode Vim style movement should be enabled with these keybindings: | ~g k~ | Move to previous heading on same level | | ~g l~ | Move down one level in headings | -**** Promotion, Demotion and element movement +*** Promotion, Demotion and element movement Promotion, demotion and movement of headings or list elements (whatever is possible) should be enabled with the following keys in any mode @@ -273,17 +273,17 @@ possible) should be enabled with the following keys in any mode | ~M-k~ | Move element up | | ~M-l~ | Demote heading by one level | -**** Table editing +*** Table editing If table specific commands are available the they are grouped under the ~SPC m t~ group. -*** Tests +** Tests A lot of languages have their own test frameworks. These frameworks share common actions that we can unite under the same key bindings: - ~SPC m t~ is the prefix for test execution. - ~SPC m t X~ is used to execute ~SPC m t x~ but in debug mode (if supported). -**** All languages +*** All languages | Key | Description | |---------+--------------------------------------------------------------| @@ -298,7 +298,7 @@ Note: we don't distinguish between the file and the buffer. We can implement an auto-save of the buffer before executing the tests of buffer. -**** Language specific +*** Language specific | Key | Description | |---------+--------------------------------------------------| | ~m t m~ | execute the tests of the current module | @@ -309,14 +309,14 @@ buffer. Note that there are overlaps, depending on the language we will choose one or more bindings for the same thing -*** Toggles +** Toggles - Global toggles are under ~SPC t~, ~SPC T~ and ~SPC C-t~ - Major mode toggles are only under ~SPC m T~ -*** Refactoring +** Refactoring Refactoring prefix is ~SPC m r~. -*** Help or Documentation +** Help or Documentation The base prefix for help commands is ~SPC h~. Documentation is considered as an help command. @@ -325,11 +325,11 @@ as an help command. | ~m h h~ | documentation of thing under point | | ~m h r~ | documentation of selected region | -** Writing documentation +* Writing documentation Spacemacs provides an example layer =README.org= file in =~/.emacs.d/core/templates/layer-README.template=. -*** Spacing in documentation +** Spacing in documentation Spacemacs tries to keep the documentation consistent between all layers by providing some rules for spacing: - After each header, you should not add an empty line diff --git a/doc/DOCUMENTATION.org b/doc/DOCUMENTATION.org index 1c4cb1d04..c454f9173 100644 --- a/doc/DOCUMENTATION.org +++ b/doc/DOCUMENTATION.org @@ -1,185 +1,188 @@ -* Spacemacs Documentation :TOC@4: - - [[#core-pillars][Core Pillars]] - - [[#mnemonic][Mnemonic]] - - [[#discoverability][Discoverability]] - - [[#consistency][Consistency]] - - [[#crowd-configured][Crowd-Configured]] - - [[#goals][Goals]] - - [[#screenshots][Screenshots]] - - [[#who-can-benefit-from-this][Who can benefit from this?]] - - [[#update-and-rollback][Update and Rollback]] - - [[#update-spacemacs-repository][Update Spacemacs repository]] - - [[#automatic-updates][Automatic Updates]] - - [[#updating-from-the-spacemacs-buffer][Updating from the Spacemacs Buffer]] - - [[#updating-manually-with-git][Updating Manually with git]] - - [[#update-packages][Update packages]] - - [[#configuration-layers][Configuration layers]] - - [[#purpose][Purpose]] - - [[#structure][Structure]] - - [[#packages][Packages]] - - [[#within-a-layer][Within a layer]] - - [[#declaration][Declaration]] - - [[#initialization][Initialization]] - - [[#exclusion][Exclusion]] - - [[#without-a-layer][Without a layer]] - - [[#packages-synchronization-vundle-like-feature][Packages synchronization (Vundle like feature)]] - - [[#types-of-configuration-layers][Types of configuration layers]] - - [[#submitting-a-configuration-layer-upstream][Submitting a configuration layer upstream]] - - [[#example-themes-megapack-example][Example: Themes Megapack example]] - - [[#managing-private-configuration-layers][Managing private configuration layers]] - - [[#using-the-private-directory][Using the private directory]] - - [[#using-an-external-git-repository][Using an external Git repository]] - - [[#using-a-personal-branch][Using a personal branch]] - - [[#tips-for-writing-layers][Tips for writing layers]] - - [[#dotfile-configuration][Dotfile Configuration]] - - [[#installation][Installation]] - - [[#alternative-setup][Alternative setup]] - - [[#synchronization-of-dotfile-changes][Synchronization of dotfile changes]] - - [[#testing][Testing]] - - [[#content][Content]] - - [[#using-configuration-layers][Using configuration layers]] - - [[#setting-configuration-layers-variables][Setting configuration layers variables]] - - [[#excluding-packages][Excluding packages]] - - [[#hooks][Hooks]] - - [[#binding-keys][Binding keys]] - - [[#custom-variables][Custom variables]] - - [[#main-principles][Main principles]] - - [[#editing-styles][Editing Styles]] - - [[#vim][Vim]] - - [[#emacs][Emacs]] - - [[#hybrid][Hybrid]] - - [[#evilified-modes][Evilified modes]] - - [[#states][States]] - - [[#evil-leader][Evil leader]] - - [[#universal-argument][Universal argument]] - - [[#micro-states][Micro-states]] - - [[#differences-between-vim-evil-and-spacemacs][Differences between Vim, Evil and Spacemacs]] - - [[#the-vim-surround-case][The vim-surround case]] - - [[#evil-plugins][Evil plugins]] - - [[#spacemacs-ui][Spacemacs UI]] - - [[#graphical-ui][Graphical UI]] - - [[#color-themes][Color themes]] - - [[#font][Font]] - - [[#graphical-ui-toggles][Graphical UI Toggles]] - - [[#global-line-numbers][Global line numbers]] - - [[#mouse-usage][Mouse usage]] - - [[#mode-line][Mode-line]] - - [[#powerline-font-installation-for-terminal-mode-users][Powerline font installation for terminal-mode users]] - - [[#flycheck-integration][Flycheck integration]] - - [[#anzu-integration][Anzu integration]] - - [[#battery-status-integration][Battery status integration]] - - [[#powerline-separators][Powerline separators]] - - [[#minor-modes][Minor Modes]] - - [[#customizing-the-mode-line][Customizing the mode-line]] - - [[#commands][Commands]] - - [[#vim-key-bindings][Vim key bindings]] - - [[#escaping][Escaping]] - - [[#executing-vim-and-emacs-exm-x-commands][Executing Vim and Emacs ex/M-x commands]] - - [[#leader-key][Leader key]] - - [[#additional-text-objects][Additional text objects]] - - [[#reserved-prefix-command-for-user][Reserved prefix command for user]] - - [[#helm][Helm]] - - [[#c-z-and-tab-switch][C-z and Tab switch]] - - [[#helm-focus][Helm focus]] - - [[#helm-micro-state][Helm micro-state]] - - [[#discovering][Discovering]] - - [[#key-bindings][Key bindings]] - - [[#which-key][Which-key]] - - [[#helm-describe-key-bindings][Helm describe key bindings]] - - [[#getting-help][Getting help]] - - [[#available-layers][Available layers]] - - [[#available-packages-in-spacemacs][Available packages in Spacemacs]] - - [[#new-packages-from-elpa-repositories][New packages from ELPA repositories]] - - [[#toggles][Toggles]] - - [[#navigating][Navigating]] - - [[#pointcursor][Point/Cursor]] - - [[#smooth-scrolling][Smooth scrolling]] - - [[#vim-motions-with-ace-jump-mode][Vim motions with ace-jump mode]] - - [[#ace-link-mode][ace-link mode]] - - [[#window-manipulation][Window manipulation]] - - [[#window-manipulation-key-bindings][Window manipulation key bindings]] - - [[#window-manipulation-micro-state][Window manipulation micro-state]] - - [[#golden-ratio][Golden ratio]] - - [[#buffers-and-files][Buffers and Files]] - - [[#buffers-manipulation-key-bindings][Buffers manipulation key bindings]] - - [[#buffers-manipulation-micro-state][Buffers manipulation micro-state]] - - [[#special-buffers][Special Buffers]] - - [[#files-manipulations-key-bindings][Files manipulations key bindings]] - - [[#emacs-and-spacemacs-files][Emacs and Spacemacs files]] - - [[#browsing-files-with-helm][Browsing files with Helm]] - - [[#ido][Ido]] - - [[#ido-micro-state][Ido micro-state]] - - [[#neotree-file-tree][NeoTree file tree]] - - [[#neotree-navigation][NeoTree navigation]] - - [[#opening-files-with-neotree][Opening files with NeoTree]] - - [[#other-neotree-key-bindings][Other NeoTree key bindings]] - - [[#neotree-mode-line][NeoTree mode-line]] - - [[#bookmarks][Bookmarks]] - - [[#docview-mode][DocView mode]] - - [[#auto-saving][Auto-saving]] - - [[#frequency-of-auto-saving][Frequency of auto-saving]] - - [[#location-of-auto-saved-files][Location of auto-saved files]] - - [[#disable-auto-save][Disable auto-save]] - - [[#searching][Searching]] - - [[#with-an-external-tool][With an external tool]] - - [[#useful-key-bindings][Useful key bindings]] - - [[#searching-in-current-file][Searching in current file]] - - [[#searching-in-all-open-buffers-visiting-files][Searching in all open buffers visiting files]] - - [[#searching-in-files-in-an-arbitrary-directory][Searching in files in an arbitrary directory]] - - [[#searching-in-a-project][Searching in a project]] - - [[#searching-the-web][Searching the web]] - - [[#persistent-highlighting][Persistent highlighting]] - - [[#stacking-highlights][Stacking highlights]] - - [[#highlight-current-symbol][Highlight current symbol]] - - [[#visual-star][Visual Star]] - - [[#listing-symbols-by-semantic][Listing symbols by semantic]] - - [[#helm-swoop][Helm-swoop]] - - [[#editing][Editing]] - - [[#paste-text][Paste text]] - - [[#paste-micro-state][Paste Micro-state]] - - [[#auto-indent-pasted-text][Auto-indent pasted text]] - - [[#text-manipulation-commands][Text manipulation commands]] - - [[#searching-and-inserting-unicode-characters][Searching and inserting Unicode characters]] - - [[#smartparens-strict-mode][Smartparens Strict mode]] - - [[#zooming][Zooming]] - - [[#text][Text]] - - [[#frame][Frame]] - - [[#increasedecrease-numbers][Increase/Decrease numbers]] - - [[#spell-checking][Spell checking]] - - [[#region-selection][Region selection]] - - [[#expand-region][Expand-region]] - - [[#indent-text-object][Indent text object]] - - [[#region-narrowing][Region narrowing]] - - [[#line-formatting][Line formatting]] - - [[#replacing-text-with-iedit][Replacing text with iedit]] - - [[#iedit-states-key-bindings][iedit states key bindings]] - - [[#examples][Examples]] - - [[#replacing-text-in-several-files][Replacing text in several files]] - - [[#commenting][Commenting]] - - [[#deleting-files][Deleting files]] - - [[#editing-lisp-code][Editing Lisp code]] - - [[#lisp-key-bindings][Lisp Key Bindings]] - - [[#managing-projects][Managing projects]] - - [[#registers][Registers]] - - [[#errors-handling][Errors handling]] - - [[#compiling][Compiling]] - - [[#modes][Modes]] - - [[#major-mode-leader-key][Major Mode leader key]] - - [[#helm][Helm]] - - [[#emacs-server][Emacs Server]] - - [[#connecting-to-the-emacs-server][Connecting to the Emacs server]] - - [[#keeping-the-server-alive][Keeping the server alive]] - - [[#troubleshoot][Troubleshoot]] - - [[#loading-fails][Loading fails]] - - [[#i-have-no-file-spacemacs][I have no file ~/.spacemacs]] - - [[#achievements][Achievements]] - - [[#issues][Issues]] - - [[#merged-pull-requests][Merged Pull Requests]] - - [[#stars-forks-and-watchers][Stars, forks and watchers]] - - [[#gitter-chat][Gitter chat]] - - [[#first-times][First times]] - - [[#specials][Specials]] - - [[#thank-you][Thank you]] +#+SETUPFILE: theme-readtheorg.setup +#+TITLE: Spacemacs documentation + +* Spacemacs documentation :TOC_4_org:noexport: + - [[Core Pillars][Core Pillars]] + - [[Mnemonic][Mnemonic]] + - [[Discoverability][Discoverability]] + - [[Consistency][Consistency]] + - [[Crowd-Configured][Crowd-Configured]] + - [[Goals][Goals]] + - [[Screenshots][Screenshots]] + - [[Who can benefit from this?][Who can benefit from this?]] + - [[Update and Rollback][Update and Rollback]] + - [[Update Spacemacs repository][Update Spacemacs repository]] + - [[Automatic Updates][Automatic Updates]] + - [[Updating from the Spacemacs Buffer][Updating from the Spacemacs Buffer]] + - [[Updating Manually with git][Updating Manually with git]] + - [[Update packages][Update packages]] + - [[Configuration layers][Configuration layers]] + - [[Purpose][Purpose]] + - [[Structure][Structure]] + - [[Packages][Packages]] + - [[Within a layer][Within a layer]] + - [[Declaration][Declaration]] + - [[Initialization][Initialization]] + - [[Exclusion][Exclusion]] + - [[Without a layer][Without a layer]] + - [[Packages synchronization (Vundle like feature)][Packages synchronization (Vundle like feature)]] + - [[Types of configuration layers][Types of configuration layers]] + - [[Submitting a configuration layer upstream][Submitting a configuration layer upstream]] + - [[Example: Themes Megapack example][Example: Themes Megapack example]] + - [[Managing private configuration layers][Managing private configuration layers]] + - [[Using the private directory][Using the private directory]] + - [[Using an external Git repository][Using an external Git repository]] + - [[Using a personal branch][Using a personal branch]] + - [[Tips for writing layers][Tips for writing layers]] + - [[Dotfile Configuration][Dotfile Configuration]] + - [[Installation][Installation]] + - [[Alternative setup][Alternative setup]] + - [[Synchronization of dotfile changes][Synchronization of dotfile changes]] + - [[Testing][Testing]] + - [[Content][Content]] + - [[Using configuration layers][Using configuration layers]] + - [[Setting configuration layers variables][Setting configuration layers variables]] + - [[Excluding packages][Excluding packages]] + - [[Hooks][Hooks]] + - [[Binding keys][Binding keys]] + - [[Custom variables][Custom variables]] + - [[Main principles][Main principles]] + - [[Editing Styles][Editing Styles]] + - [[Vim][Vim]] + - [[Emacs][Emacs]] + - [[Hybrid][Hybrid]] + - [[Evilified modes][Evilified modes]] + - [[States][States]] + - [[Evil leader][Evil leader]] + - [[Universal argument][Universal argument]] + - [[Micro-states][Micro-states]] + - [[Differences between Vim, Evil and Spacemacs][Differences between Vim, Evil and Spacemacs]] + - [[The vim-surround case][The vim-surround case]] + - [[Evil plugins][Evil plugins]] + - [[Spacemacs UI][Spacemacs UI]] + - [[Graphical UI][Graphical UI]] + - [[Color themes][Color themes]] + - [[Font][Font]] + - [[Graphical UI Toggles][Graphical UI Toggles]] + - [[Global line numbers][Global line numbers]] + - [[Mouse usage][Mouse usage]] + - [[Mode-line][Mode-line]] + - [[Powerline font installation for terminal-mode users][Powerline font installation for terminal-mode users]] + - [[Flycheck integration][Flycheck integration]] + - [[Anzu integration][Anzu integration]] + - [[Battery status integration][Battery status integration]] + - [[Powerline separators][Powerline separators]] + - [[Minor Modes][Minor Modes]] + - [[Customizing the mode-line][Customizing the mode-line]] + - [[Commands][Commands]] + - [[Vim key bindings][Vim key bindings]] + - [[Escaping][Escaping]] + - [[Executing Vim and Emacs ex/M-x commands][Executing Vim and Emacs ex/M-x commands]] + - [[Leader key][Leader key]] + - [[Additional text objects][Additional text objects]] + - [[Reserved prefix command for user][Reserved prefix command for user]] + - [[Helm][Helm]] + - [[C-z and Tab switch][C-z and Tab switch]] + - [[Helm focus][Helm focus]] + - [[Helm micro-state][Helm micro-state]] + - [[Discovering][Discovering]] + - [[Key bindings][Key bindings]] + - [[Which-key][Which-key]] + - [[Helm describe key bindings][Helm describe key bindings]] + - [[Getting help][Getting help]] + - [[Available layers][Available layers]] + - [[Available packages in Spacemacs][Available packages in Spacemacs]] + - [[New packages from ELPA repositories][New packages from ELPA repositories]] + - [[Toggles][Toggles]] + - [[Navigating][Navigating]] + - [[Point/Cursor][Point/Cursor]] + - [[Smooth scrolling][Smooth scrolling]] + - [[Vim motions with ace-jump mode][Vim motions with ace-jump mode]] + - [[ace-link mode][ace-link mode]] + - [[Window manipulation][Window manipulation]] + - [[Window manipulation key bindings][Window manipulation key bindings]] + - [[Window manipulation micro-state][Window manipulation micro-state]] + - [[Golden ratio][Golden ratio]] + - [[Buffers and Files][Buffers and Files]] + - [[Buffers manipulation key bindings][Buffers manipulation key bindings]] + - [[Buffers manipulation micro-state][Buffers manipulation micro-state]] + - [[Special Buffers][Special Buffers]] + - [[Files manipulations key bindings][Files manipulations key bindings]] + - [[Emacs and Spacemacs files][Emacs and Spacemacs files]] + - [[Browsing files with Helm][Browsing files with Helm]] + - [[Ido][Ido]] + - [[Ido micro-state][Ido micro-state]] + - [[NeoTree file tree][NeoTree file tree]] + - [[NeoTree navigation][NeoTree navigation]] + - [[Opening files with NeoTree][Opening files with NeoTree]] + - [[Other NeoTree key bindings][Other NeoTree key bindings]] + - [[NeoTree mode-line][NeoTree mode-line]] + - [[Bookmarks][Bookmarks]] + - [[DocView mode][DocView mode]] + - [[Auto-saving][Auto-saving]] + - [[Frequency of auto-saving][Frequency of auto-saving]] + - [[Location of auto-saved files][Location of auto-saved files]] + - [[Disable auto-save][Disable auto-save]] + - [[Searching][Searching]] + - [[With an external tool][With an external tool]] + - [[Useful key bindings][Useful key bindings]] + - [[Searching in current file][Searching in current file]] + - [[Searching in all open buffers visiting files][Searching in all open buffers visiting files]] + - [[Searching in files in an arbitrary directory][Searching in files in an arbitrary directory]] + - [[Searching in a project][Searching in a project]] + - [[Searching the web][Searching the web]] + - [[Persistent highlighting][Persistent highlighting]] + - [[Stacking highlights][Stacking highlights]] + - [[Highlight current symbol][Highlight current symbol]] + - [[Visual Star][Visual Star]] + - [[Listing symbols by semantic][Listing symbols by semantic]] + - [[Helm-swoop][Helm-swoop]] + - [[Editing][Editing]] + - [[Paste text][Paste text]] + - [[Paste Micro-state][Paste Micro-state]] + - [[Auto-indent pasted text][Auto-indent pasted text]] + - [[Text manipulation commands][Text manipulation commands]] + - [[Searching and inserting Unicode characters][Searching and inserting Unicode characters]] + - [[Smartparens Strict mode][Smartparens Strict mode]] + - [[Zooming][Zooming]] + - [[Text][Text]] + - [[Frame][Frame]] + - [[Increase/Decrease numbers][Increase/Decrease numbers]] + - [[Spell checking][Spell checking]] + - [[Region selection][Region selection]] + - [[Expand-region][Expand-region]] + - [[Indent text object][Indent text object]] + - [[Region narrowing][Region narrowing]] + - [[Line formatting][Line formatting]] + - [[Replacing text with iedit][Replacing text with iedit]] + - [[iedit states key bindings][iedit states key bindings]] + - [[Examples][Examples]] + - [[Replacing text in several files][Replacing text in several files]] + - [[Commenting][Commenting]] + - [[Deleting files][Deleting files]] + - [[Editing Lisp code][Editing Lisp code]] + - [[Lisp Key Bindings][Lisp Key Bindings]] + - [[Managing projects][Managing projects]] + - [[Registers][Registers]] + - [[Errors handling][Errors handling]] + - [[Compiling][Compiling]] + - [[Modes][Modes]] + - [[Major Mode leader key][Major Mode leader key]] + - [[Helm][Helm]] + - [[Emacs Server][Emacs Server]] + - [[Connecting to the Emacs server][Connecting to the Emacs server]] + - [[Keeping the server alive][Keeping the server alive]] + - [[Troubleshoot][Troubleshoot]] + - [[Loading fails][Loading fails]] + - [[I have no file ~/.spacemacs][I have no file ~/.spacemacs]] + - [[Achievements][Achievements]] + - [[Issues][Issues]] + - [[Merged Pull Requests][Merged Pull Requests]] + - [[Stars, forks and watchers][Stars, forks and watchers]] + - [[Gitter chat][Gitter chat]] + - [[First times][First times]] + - [[Specials][Specials]] + - [[Thank you][Thank you]] * Core Pillars Four core pillars: Mnemonic, Discoverability, Consistency, "Crowd-Configured". @@ -211,13 +214,13 @@ perform this action. This is also true for the documentation, each configuration layer comes with an associated =README.org= file with the same base layout. -The consistency core pillar is supported by a convention file: [[file:CONVENTIONS.org][CONVENTIONS.org]] +The consistency core pillar is supported by a convention file: [[file:CONVENTIONS.org][CONVENTIONS]] ** Crowd-Configured By defining an very light structure called =configuration layer= which is easy to understand, Spacemacs makes it easy to contribute additional support. -The conventions in [[file:CONVENTIONS.org][CONVENTIONS.org]] make it easy to get +The conventions in [[file:CONVENTIONS.org][CONVENTIONS]] make it easy to get the spacemacs way and keep consistency even if there are a lot of contributions. =Crowd-configuration= is the most powerful pillar of Spacemacs. Anybody can @@ -304,9 +307,9 @@ prompted for the version you would like to use. To update manually close Emacs and update the git repository: -#+begin_src sh - $ git pull --rebase -#+end_src +#+BEGIN_SRC sh +$ git pull --rebase +#+END_SRC ** Update packages @@ -319,7 +322,7 @@ link and choose a rollback slot (sorted by date). * Configuration layers *Note*: This is a very simple overview of how layers work. A more extensive -introduction to writing configuration layers can be found [[LAYERS.org][here]]. +introduction to writing configuration layers can be found [[file:LAYERS.org][here]]. ** Purpose Layers help collect related packages together to provide features. For example, @@ -367,20 +370,20 @@ have to use some =eval-after-load= black magic. Example: -#+begin_src emacs-lisp - (setq -packages '(package1 package2 ...) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq -packages '(package1 package2 ...) +#+END_SRC For details on installing local packages using quelpa or in the layer's =local= -folder, see [[file:LAYERS.org#packagesel][LAYERS.org]]. +folder, see [[file:LAYERS.org::packages.el][LAYERS]]. **** Initialization To initialize an extension or a package =xxx=, define a function with this format in or =packages.el=: -#+begin_src emacs-lisp - (defun /init-xxx () ...body ) -#+end_src +#+BEGIN_SRC emacs-lisp +(defun /init-xxx () ...body ) +#+END_SRC It is common to define the body with the [[https://github.com/jwiegley/use-package][use-package]] macro. @@ -394,9 +397,9 @@ To do so add the package names to exclude to the variable Example: -#+begin_src emacs-lisp - (setq -excluded-packages '(package1 package2 ...) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq -excluded-packages '(package1 package2 ...) +#+END_SRC *** Without a layer Sometimes a layer can be an unnecessary overhead, this is the case if you just @@ -412,9 +415,9 @@ or just put the configuration in the =dotspacemacs/user-config= function. Example to install =llvm-mode= and =dts-mode=: -#+begin_src emacs-lisp - (setq dotspacemacs-additional-packages '(llvm-mode dts-mode) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq dotspacemacs-additional-packages '(llvm-mode dts-mode) +#+END_SRC ** Packages synchronization (Vundle like feature) Spacemacs features a synchronization engine for the ELPA packages. It means @@ -432,7 +435,7 @@ There are three types of configuration layers: ** Submitting a configuration layer upstream If you decide to provide a =contrib= configuration layer, please check the -contribution guidelines in [[./CONTRIBUTE.org][CONTRIBUTE.org]]. +contribution guidelines in [[file:CONTRIBUTE.org][CONTRIBUTE]]. ** Example: Themes Megapack example This is a simple =contrib= configuration layer listing a bunch of themes, you @@ -440,9 +443,9 @@ can find it [[../layers/themes-megapack][here]]. To install it, just add =themes-megapack= to your =~/.spacemacs= like so: -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(themes-megapack)) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-configuration-layers '(themes-megapack)) +#+END_SRC You have now installed around 100 themes you are free to try with ~SPC T h~ (helm-themes). @@ -475,7 +478,7 @@ The final main way to manage your private layers is to push them in a personal branch that you keep up to date with upstream =master= or =develop=. ** Tips for writing layers -Please refer to [[LAYERS.org][this]] introduction for some tips on writing layers, and how to +Please refer to [[file:LAYERS.org][this]] introduction for some tips on writing layers, and how to best make them fit with the Spacemacs philosophy and loading strategy. * Dotfile Configuration @@ -526,11 +529,11 @@ tests are also run automatically when you synchronize with ~SPC f e R~. To use a configuration layer, add it to the =dotspacemacs-configuration-layers= variable of your =~/.spacemacs=. -For instance to add the configuration layer of [[#thank-you][RMS]]: +For instance to add the configuration layer of [[Thank you][RMS]]: -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layers '(rms)) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-configuration-layers '(rms)) +#+END_SRC If this layer does not exist you can still try another one in [[file:../layers][the =layers= directory]]. @@ -541,35 +544,35 @@ additional paths where Spacemacs can look for configuration layers. This is done by setting the list =dotspacemacs-configuration-layer-path= in your =~/.spacemacs=: -#+begin_src emacs-lisp - (setq-default dotspacemacs-configuration-layer-path '("~/.myconfig/")) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-configuration-layer-path '("~/.myconfig/")) +#+END_SRC *** Setting configuration layers variables Some configuration layers have configuration variables to enable specific support. For instance the [[../layers/%2Bsource-control/git][git layer]] has several configuration variables, they can be set directly in the =dotspacemacs-configuration-layers= like this: -#+begin_src emacs-lisp - (defun dotspacemacs/layers () - ;; List of configuration layers to load. - (setq-default dotspacemacs-configuration-layers '(auto-completion - (git :variables - git-magit-status-fullscreen t) - smex))) -#+end_src +#+BEGIN_SRC emacs-lisp +(defun dotspacemacs/layers () + ;; List of configuration layers to load. + (setq-default dotspacemacs-configuration-layers '(auto-completion + (git :variables + git-magit-status-fullscreen t) + smex))) +#+END_SRC *** Excluding packages You can exclude packages you don't want to install with the variable =dotspacemacs-excluded-packages=, this variable can exclude both packages and -extensions (see [[#configuration-layers][Configuration layers]] for more info on +extensions (see [[Configuration layers][Configuration layers]] for more info on packages and extensions). For instance to disable the =rainbow-delimiters= package: -#+begin_src emacs-lisp - (setq-default dotspacemacs-excluded-packages '(rainbow-delimiters)) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-excluded-packages '(rainbow-delimiters)) +#+END_SRC When you exclude a package, Spacemacs will automatically delete it for you the next time you launch Emacs. All the orphan dependencies are as well delete @@ -591,9 +594,9 @@ Key sequences are bound to commands in Emacs in various keymaps. The most basic map is the global-map. Setting a key binding the global-map uses the function =global-set-key= as follows (to the command =forward-char= in this case). -#+begin_src emacs-lisp - (global-set-key (kbd "C-]") 'forward-char) -#+end_src +#+BEGIN_SRC emacs-lisp +(global-set-key (kbd "C-]") 'forward-char) +#+END_SRC The =kbd= macro accepts a string describing a key sequence. The global-map is often shadowed by other maps. For example, evil-mode defines keymaps that target @@ -601,19 +604,19 @@ states (or modes in vim terminology). Here is an example that creates the same binding as above but only in insert state (=define-key= is a built-in function. Evil-mode has its own functions for defining keys). -#+begin_src emacs-lisp - (define-key evil-insert-state-map (kbd "C-]") 'forward-char) -#+end_src +#+BEGIN_SRC emacs-lisp +(define-key evil-insert-state-map (kbd "C-]") 'forward-char) +#+END_SRC Perhaps most importantly for spacemacs is the use of the evil-leader package, which binds keys to the evil-leader keymap. This is where most of the spacemacs bindings live. There are two related commands from this package which are used as follows. -#+begin_src emacs-lisp - (evil-leader/set-key "C-]" 'forward-char) - (evil-leader/set-key-for-mode 'emacs-lisp-mode "C-]" 'forward-char) -#+end_src +#+BEGIN_SRC emacs-lisp +(evil-leader/set-key "C-]" 'forward-char) +(evil-leader/set-key-for-mode 'emacs-lisp-mode "C-]" 'forward-char) +#+END_SRC These functions use a macro like =kbd= to translate the key sequences for you. The second function, =evil-leader/set-key-for-mode=, binds the key only in the @@ -625,10 +628,10 @@ nested. Nested keymaps are used extensively in spacemacs, and in vanilla Emacs for that matter. For example, ~SPC a~ points to key bindings for "applications", like ~SPC ac~ for =calc-dispatch=. Nesting bindings is easy. -#+begin_src emacs-lisp - (spacemacs/declare-prefix "]" "bracket-prefix") - (evil-leader/set-key "]]" 'double-bracket-command) -#+end_src +#+BEGIN_SRC emacs-lisp +(spacemacs/declare-prefix "]" "bracket-prefix") +(evil-leader/set-key "]]" 'double-bracket-command) +#+END_SRC The first line declares ~SPC ]~ to be a prefix and the second binds the key sequence ~SPC ]]~ to the corresponding command. The first line is actually @@ -690,19 +693,19 @@ So anything bound to =g= originally will be found on =C-G=, since =g=, =G= and ** States Spacemacs has 10 states: -| State | Color | Description | -|--------------+-------------+--------------------------------------------------------------------------------------------------------------| -| normal | orange | like the =normal mode of Vim=, used to execute and combine commands | -| insert | green | like the =insert mode of Vim=, used to actually insert text | -| visual | gray | like the =visual mode of Vim=, used to make text selection | -| motion | purple | exclusive to =Evil=, used to navigate read only buffers | -| emacs | blue | exclusive to =Evil=, using this state is like using a regular Emacs without Vim | -| replace | chocolate | exclusive to =Evil=, overwrites the character under point instead of inserting a new one | +| State | Color | Description | +|--------------+-------------+------------------------------------------------------------------------------------------------------------| +| normal | orange | like the =normal mode of Vim=, used to execute and combine commands | +| insert | green | like the =insert mode of Vim=, used to actually insert text | +| visual | gray | like the =visual mode of Vim=, used to make text selection | +| motion | purple | exclusive to =Evil=, used to navigate read only buffers | +| emacs | blue | exclusive to =Evil=, using this state is like using a regular Emacs without Vim | +| replace | chocolate | exclusive to =Evil=, overwrites the character under point instead of inserting a new one | | hybrid | blue | exclusive to Spacemacs, this is like the insert state except that all the emacs key bindings are available | | evilified | light brown | exclusive to Spacemacs, this is an =emacs state= modified to bring Vim navigation, selection and search. | -| lisp | pink | exclusive to Spacemacs, used to navigate Lisp code and modify it (more [[#editing-lisp-code][info]]) | -| iedit | red | exclusive to Spacemacs, used to navigate between multiple regions of text using =iedit= (more [[#replacing-text-with-iedit][info]]) | -| iedit-insert | red | exclusive to Spacemacs, used to replace multiple regions of text using =iedit= (more [[#replacing-text-with-iedit][info]]) | +| lisp | pink | exclusive to Spacemacs, used to navigate Lisp code and modify it (more [[Editing Lisp code][info]]) | +| iedit | red | exclusive to Spacemacs, used to navigate between multiple regions of text using =iedit= (more [[Replacing text with iedit][info]]) | +| iedit-insert | red | exclusive to Spacemacs, used to replace multiple regions of text using =iedit= (more [[Replacing text with iedit][info]]) | Note: Technically speaking there is also the =operator= evil state. @@ -738,10 +741,10 @@ presses on the ~SPC~ key. When a =micro-state= is active, a documentation is displayed in the minibuffer. Additional information may as well be displayed in the minibuffer. -[[#auto-highlight-and-edition-of-symbols][Auto-highlight-symbol micro-state]]: +Auto-highlight-symbol micro-state: [[file:img/spacemacs-ahs-micro-state.png]] -[[#text][Text scale micro-state]]: +[[Text][Text scale micro-state]]: [[file:img/spacemacs-scale-micro-state.png]] * Differences between Vim, Evil and Spacemacs @@ -773,10 +776,10 @@ If you are not convinced, then here is the snippet to revert back to the default =Vim + vim-surround= setup (add it to your =dotspacemacs/user-config= function or your =~/.spacemacs=): -#+begin_src emacs-lisp - (evil-define-key 'visual evil-surround-mode-map "s" 'evil-substitute) - (evil-define-key 'visual evil-surround-mode-map "S" 'evil-surround-region) -#+end_src +#+BEGIN_SRC emacs-lisp +(evil-define-key 'visual evil-surround-mode-map "s" 'evil-substitute) +(evil-define-key 'visual evil-surround-mode-map "S" 'evil-surround-region) +#+END_SRC * Evil plugins Spacemacs ships with the following evil plugins: @@ -805,9 +808,9 @@ enjoyable: ** Graphical UI Spacemacs has a minimalistic and distraction free graphical UI: - - custom [[https://github.com/milkypostman/powerline][powerline]] mode-line [[#flycheck-integration][with color feedback]] according to current [[https://github.com/flycheck/flycheck][Flycheck]] status + - custom [[https://github.com/milkypostman/powerline][powerline]] mode-line [[Flycheck integration][with color feedback]] according to current [[https://github.com/flycheck/flycheck][Flycheck]] status - Unicode symbols for minor mode lighters which appear in the mode-line - - [[#errors-handling][custom fringe bitmaps]] and error feedbacks for [[https://github.com/flycheck/flycheck][Flycheck]] + - [[Errors handling][custom fringe bitmaps]] and error feedbacks for [[https://github.com/flycheck/flycheck][Flycheck]] *** Color themes @@ -822,9 +825,9 @@ It is possible to define your default themes in your =~/.spacemacs= with the variable =dotspacemacs-themes=. For instance, to specify =solarized-light=, =leuven= and =zenburn=: -#+begin_src emacs-lisp - (setq-default dotspacemacs-themes '(solarized-light leuven zenburn)) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-themes '(solarized-light leuven zenburn)) +#+END_SRC | Key Binding | Description | |-------------+-------------------------------------------------------| @@ -852,13 +855,13 @@ To change the default font set the variable =dotspacemacs-default-font= in your By default its value is: -#+begin_src emacs-lisp - (setq-default dotspacemacs-default-font '("Source Code Pro" - :size 13 - :weight normal - :width normal - :powerline-scale 1.1)) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-default-font '("Source Code Pro" + :size 13 + :weight normal + :width normal + :powerline-scale 1.1)) +#+END_SRC The properties should be pretty straightforward, it is possible to set any valid property of a [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Low_002dLevel-Font.html][font-spec]]: @@ -942,9 +945,9 @@ Line numbers can be toggled on in all =prog-mode= and =text-mode= buffers by setting the =dotspacemacs-global-line-numbers= variable in your =~/.spacemacs= to something different than =nil=: -#+begin_src emacs-lisp - (setq-default dotspacemacs-global-line-numbers t) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-global-line-numbers t) +#+END_SRC *** Mouse usage There are some added mouse features set for the line number margin (if shown): @@ -1017,11 +1020,11 @@ the time remaining to charge or discharge completely the battery. A color code is used for the battery status: -| Battery State | Color | -|-----------------+----------| -| Charging | Green | -| Discharging | Orange | -| Critical | Red | +| Battery State | Color | +|---------------+--------| +| Charging | Green | +| Discharging | Orange | +| Critical | Red | Note the these colors may vary depending on your theme. @@ -1031,12 +1034,12 @@ It is possible to easily customize the =powerline separator= by setting the you want to set back the separator to the well-known =arrow= separator add the following snippet to your configuration file: -#+begin_src emacs-lisp - (defun dotspacemacs/user-config () - "This is were you can ultimately override default Spacemacs configuration. - This function is called at the very end of Spacemacs initialization." - (setq powerline-default-separator 'arrow)) -#+end_src +#+BEGIN_SRC emacs-lisp +(defun dotspacemacs/user-config () + "This is were you can ultimately override default Spacemacs configuration. +This function is called at the very end of Spacemacs initialization." + (setq powerline-default-separator 'arrow)) +#+END_SRC To save you the time to try all the possible separators provided by the powerline, here is an exhaustive set of screenshots: @@ -1076,31 +1079,31 @@ toggle them. Some toggle have two flavors: local and global. The global version of the toggle can be reached using the =control= key. -| Key Binding | Unicode | ASCII | Mode | -|-------------+---------+-------+-------------------------------------------------------------------------------| -| ~SPC t -~ | =⊝= | - | [[http://emacswiki.org/emacs/centered-cursor-mode.el][centered-cursor]] mode | -| ~SPC t C--~ | =⊝= | | global centered cursor | -| ~SPC t a~ | =ⓐ= | a | auto-completion | -| ~SPC t c~ | =ⓒ= | c | camel case motion with subword mode | -| =none= | =ⓔ= | e | [[https://github.com/edwtjo/evil-org-mode][evil-org]] mode | -| ~SPC t E e~ | =Ⓔe= | Ee | emacs editing style (holy mode) | -| ~SPC t E h~ | =Ⓔh= | Eh | hybrid editing style (hybrid mode) | -| ~SPC t f~ | | | fill-column-indicator mode | -| ~SPC t F~ | =Ⓕ= | F | auto-fill mode | -| ~SPC t g~ | =ⓖ= | g | [[https://github.com/roman/golden-ratio.el][golden-ratio]] mode | -| ~SPC t h i~ | =ⓗi= | hi | toggle highlight indentation levels | -| ~SPC t h c~ | =ⓗc= | hc | toggle highlight indentation current column | -| ~SPC t i~ | =ⓘ= | i | indentation guide | -| ~SPC t C-i~ | =ⓘ= | i | global indentation guide | -| ~SPC t I~ | =Ⓘ= | I | aggressive indent mode | -| ~SPC t K~ | =Ⓚ= | K | which-key mode | -| ~SPC t p~ | =ⓟ= | p | [[https://github.com/Fuco1/smartparens][smartparens]] mode | -| ~SPC t C-p~ | =ⓟ= | | global smartparens | -| ~SPC t s~ | =ⓢ= | s | syntax checking (flycheck) | -| ~SPC t S~ | =Ⓢ= | S | enabled in [[../layers/spell-checking][spell checking layer]] (flyspell) | -| ~SPC t w~ | =ⓦ= | w | whitespace mode | -| ~SPC t C-w~ | =Ⓦ= | W | global whitespace | -| ~SPC t y~ | =ⓨ= | y | [[https://github.com/capitaomorte/yasnippet][yasnippet]] mode | +| Key Binding | Unicode | ASCII | Mode | +|-------------+---------+-------+---------------------------------------------| +| ~SPC t -~ | =⊝= | - | [[http://emacswiki.org/emacs/centered-cursor-mode.el][centered-cursor]] mode | +| ~SPC t C--~ | =⊝= | | global centered cursor | +| ~SPC t a~ | =ⓐ= | a | auto-completion | +| ~SPC t c~ | =ⓒ= | c | camel case motion with subword mode | +| =none= | =ⓔ= | e | [[https://github.com/edwtjo/evil-org-mode][evil-org]] mode | +| ~SPC t E e~ | =Ⓔe= | Ee | emacs editing style (holy mode) | +| ~SPC t E h~ | =Ⓔh= | Eh | hybrid editing style (hybrid mode) | +| ~SPC t f~ | | | fill-column-indicator mode | +| ~SPC t F~ | =Ⓕ= | F | auto-fill mode | +| ~SPC t g~ | =ⓖ= | g | [[https://github.com/roman/golden-ratio.el][golden-ratio]] mode | +| ~SPC t h i~ | =ⓗi= | hi | toggle highlight indentation levels | +| ~SPC t h c~ | =ⓗc= | hc | toggle highlight indentation current column | +| ~SPC t i~ | =ⓘ= | i | indentation guide | +| ~SPC t C-i~ | =ⓘ= | i | global indentation guide | +| ~SPC t I~ | =Ⓘ= | I | aggressive indent mode | +| ~SPC t K~ | =Ⓚ= | K | which-key mode | +| ~SPC t p~ | =ⓟ= | p | [[https://github.com/Fuco1/smartparens][smartparens]] mode | +| ~SPC t C-p~ | =ⓟ= | | global smartparens | +| ~SPC t s~ | =ⓢ= | s | syntax checking (flycheck) | +| ~SPC t S~ | =Ⓢ= | S | enabled in [[../layers/spell-checking][spell checking layer]] (flyspell) | +| ~SPC t w~ | =ⓦ= | w | whitespace mode | +| ~SPC t C-w~ | =Ⓦ= | W | global whitespace | +| ~SPC t y~ | =ⓨ= | y | [[https://github.com/capitaomorte/yasnippet][yasnippet]] mode | **** Customizing the mode-line The mode-line consists of a number of /segments/ arranged on the left and right @@ -1110,20 +1113,20 @@ sides. These are defined in the variables =spacemacs-mode-line-left= and To collect several segments together, use a list. Powerline separators are inserted between each /top-level/ segment. This allows you to group segments together without graphical separators between. -#+begin_src emacs-lisp - (segment-a segment-b segment-c) -#+end_src +#+BEGIN_SRC emacs-lisp +(segment-a segment-b segment-c) +#+END_SRC Properties can be applied to segments as well, e.g. -#+begin_src emacs-lisp - (segment :property value :other-property other-value) -#+end_src +#+BEGIN_SRC emacs-lisp +(segment :property value :other-property other-value) +#+END_SRC or for a list, -#+begin_src emacs-lisp - ((segment-a segment-b) - :property value - :other-property other-value) -#+end_src +#+BEGIN_SRC emacs-lisp +((segment-a segment-b) + :property value + :other-property other-value) +#+END_SRC The available properties are all optional. - =:fallback= :: defines another segment to fall back on if the original segment @@ -1138,11 +1141,11 @@ The available properties are all optional. Segments themselves can be defined using =spacemacs|define-mode-line-segment=. Properties can also be specified there. For example, -#+begin_src emacs-lisp - (spacemacs|define-mode-line-segment name - value-of-segment - :face state-face) -#+end_src +#+BEGIN_SRC emacs-lisp +(spacemacs|define-mode-line-segment name + value-of-segment + :face state-face) +#+END_SRC During evaluation of segments, the following additional bindings are useful. - =default-face= :: The default face to use for this segment. @@ -1186,10 +1189,10 @@ example in ~SPC : customize~ press ~fd~ to make ~SPC b b~ work again). This sequence can be customized in your =~/.spacemacs=. Example to set it to ~jj~: -#+begin_src emacs-lisp - (defun dotspacemacs/user-config () - (setq-default evil-escape-key-sequence "jj")) -#+end_src +#+BEGIN_SRC emacs-lisp +(defun dotspacemacs/user-config () + (setq-default evil-escape-key-sequence "jj")) +#+END_SRC *Note*: Although ~jj~ or ~jk~ are popular choices of vim users, these key sequences are not optimal for Spacemacs. Indeed it is very easy in =visual @@ -1252,7 +1255,7 @@ If you find yourself unable to return focus to Helm (after a careless mouse-click for example), use ~SPC w b~ to return focus to the minibuffer. *** Helm micro-state -Spacemacs defines a [[#micro-states][micro-state]] for =Helm= to make it work like [[https://github.com/Shougo/unite.vim][Vim's Unite]] +Spacemacs defines a [[Micro-states][micro-state]] for =Helm= to make it work like [[https://github.com/Shougo/unite.vim][Vim's Unite]] plugin. Initiate the micro-state with ~M-SPC~ or ~s-M-SPC~ while in a =Helm= buffer. @@ -1387,7 +1390,7 @@ Spacemacs. *** Toggles =helm-spacemacs= is also a central place to discover the available toggles. To -display only the toggles source press ~C-l~ (or in [[#helm-micro-state][Helm micro-state]] you can +display only the toggles source press ~C-l~ (or in [[Helm micro-state][Helm micro-state]] you can press just ~l~). The following helm actions are available on packages: @@ -1419,9 +1422,9 @@ bottom of the screen. It is enabled by default. On Windows, you may want to disable it. To disable the smooth scrolling set the =dotspacemacs-smooth-scrolling= variable in your =~/.spacemacs= to =nil=: -#+begin_src emacs-lisp - (setq-default dotspacemacs-smooth-scrolling t) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-smooth-scrolling t) +#+END_SRC *** Vim motions with ace-jump mode Spacemacs uses the =evil= integration of [[https://github.com/winterTTr/ace-jump-mode][ace-jump mode]] which enables the @@ -1494,7 +1497,7 @@ Windows manipulation commands (start with ~w~): | ~SPC w v~ or ~SPC w -~ | vertical split | | ~SPC w V~ | vertical split and focus new window | | ~SPC w w~ | cycle and focus between windows | -| ~SPC w SPC~ | select window using [[https://github.com/abo-abo/ace-window][ace-window]] | +| ~SPC w SPC~ | select window using [[https://github.com/abo-abo/ace-window][ace-window]] | **** Window manipulation micro-state A convenient window manipulation micro-state allows to perform most of the @@ -1603,8 +1606,7 @@ the opened buffer and kill them. Unlike vim, emacs creates many buffers that most people do not need to see. Some examples are =*Messages*= and =*Compile-Log*=. Spacemacs tries to automatically ignore buffers that are not useful. However, you may want to change the way -Spacemacs marks buffers as useful. For instructions, see the [[./HOWTOs.org#change-special-buffer-rules][special buffer -howto]]. +Spacemacs marks buffers as useful. For instructions, see the [[file:FAQ.org::Change%20special%20buffer%20rules?][special buffer howto]]. **** Files manipulations key bindings Files manipulation commands (start with ~f~): @@ -1635,16 +1637,16 @@ Files manipulation commands (start with ~f~): Convenient key bindings are located under the prefix ~SPC f e~ to quickly navigate between =Emacs= and Spacemacs specific files. -| Key Binding | Description | -|-------------+----------------------------------------------------------------------| -| ~SPC f e c~ | open =ido= in the =contrib= folder | -| ~SPC f e d~ | open the spacemacs dotfile (=~/.spacemacs=) | -| ~SPC f e D~ | open =ediff= buffer of =~/.spacemacs= and =.spacemacs.template= | +| Key Binding | Description | +|-------------+--------------------------------------------------------------------| +| ~SPC f e c~ | open =ido= in the =contrib= folder | +| ~SPC f e d~ | open the spacemacs dotfile (=~/.spacemacs=) | +| ~SPC f e D~ | open =ediff= buffer of =~/.spacemacs= and =.spacemacs.template= | | ~SPC f e h~ | discover Spacemacs documentation, layers and packages using =helm= | -| ~SPC f e f~ | discover the =FAQ= using =helm= | -| ~SPC f e i~ | open the all mighty =init.el= | -| ~SPC f e R~ | resync the dotfile with spacemacs | -| ~SPC f e v~ | display and copy the spacemacs version | +| ~SPC f e f~ | discover the =FAQ= using =helm= | +| ~SPC f e i~ | open the all mighty =init.el= | +| ~SPC f e R~ | resync the dotfile with spacemacs | +| ~SPC f e v~ | display and copy the spacemacs version | **** Browsing files with Helm In =vim= and =hybrid= styles, Spacemacs remap the navigation in Helm find-files @@ -1685,7 +1687,7 @@ Basic =ido= operations can be done with ~Ctrl~ key: | ~C-S-l~ | go to next directory | *** Ido micro-state -Spacemacs defines a [[#micro-states][micro-state]] for =ido=. +Spacemacs defines a [[Micro-states][micro-state]] for =ido=. Initiate the micro-state with ~M-SPC~ or ~s-M-SPC~ while in an =ido= buffer. @@ -1727,17 +1729,17 @@ current state. With default =spacemacs-dark= theme: Navigation is centered on the ~hjkl~ with the hope to provide a fast navigation experience like in [[http://ranger.nongnu.org/][ranger]]: -| Key Binding | Description | -|---------------+--------------------------------------------------------------------------| -| ~h~ | collapse expanded directory or go to parent node | -| ~H~ | previous sibling | -| ~j~ | next file or directory | -| ~J~ | next expanded directory on level down | -| ~k~ | previous file or directory | -| ~K~ | parent directory, when reaching the root change it to parent directory | -| ~l~ or ~RET~ | expand directory | -| ~L~ | next sibling | -| ~R~ | make a directory the root directory | +| Key Binding | Description | +|--------------+------------------------------------------------------------------------| +| ~h~ | collapse expanded directory or go to parent node | +| ~H~ | previous sibling | +| ~j~ | next file or directory | +| ~J~ | next expanded directory on level down | +| ~k~ | previous file or directory | +| ~K~ | parent directory, when reaching the root change it to parent directory | +| ~l~ or ~RET~ | expand directory | +| ~L~ | next sibling | +| ~R~ | make a directory the root directory | *Note*: The point is automatically set to the first letter of a node for a smoother experience. @@ -1880,11 +1882,11 @@ The tool keys are: The available scopes and corresponding keys are: -| Scope | Key | -|----------------------------+--------| -| opened buffers | b | -| files in a given directory | f | -| current project | p | +| Scope | Key | +|----------------------------+-----| +| opened buffers | b | +| files in a given directory | f | +| current project | p | It is possible to search in the current file by double tapping the second key of the sequence, for instance ~SPC s a a~ will search in the current @@ -2048,10 +2050,10 @@ Where = [x/y]*= is: With [[https://github.com/bling/evil-visualstar][evil-visualstar]] you can search for the next occurrence of the current selection. -It is pretty useful combined with the [[#region-selection][expand-region]] bindings. +It is pretty useful combined with the [[Region selection][expand-region]] bindings. *Note*: If the current state is not the =visual state= then pressing ~*~ uses -[[#auto-highlight-symbols][auto-highlight-symbol]] and its micro-state. +auto-highlight-symbol and its micro-state. *** Listing symbols by semantic Use =helm-semantic-or-imenu= command from =Helm= to quickly navigate between the @@ -2151,9 +2153,9 @@ default. It is possible to enable it easily for /all programming modes/ with the variable =dotspacemacs-smartparens-strict-mode= of you =~/.spacemacs=. -#+begin_src emacs-lisp - (setq-default dotspacemacs-smartparens-strict-mode t) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-smartparens-strict-mode t) +#+END_SRC *** Zooming **** Text @@ -2234,11 +2236,11 @@ state=: Example (=|= is the point): -#+begin_src emacs-lisp - (while (not done) - (messa|ge "All work and no play makes Jack a dull boy.")) - (1+ 41) -#+end_src +#+BEGIN_SRC emacs-lisp +(while (not done) + (messa|ge "All work and no play makes Jack a dull boy.")) + (1+ 41) +#+END_SRC - ~vii~ will select the line with message - ~vai~ will select the whole while loop @@ -2386,9 +2388,9 @@ Deletion is configured to send deleted files to system trash. On OS X the =trash= program is required. It can be installed with [[http:www.brew.sh][homebrew]] with the following command: -#+begin_src sh - $ brew install trash -#+end_src +#+BEGIN_SRC sh +$ brew install trash +#+END_SRC To disable the trash you can set the variable =delete-by-moving-to-trash= to =nil= in your =~/.spacemacs=. @@ -2486,7 +2488,7 @@ are defined implicitly, for instance the root of a project is found when a =Helm= is used whenever it is possible. -To search in a project see [[#searching-in-a-project][project searching]]. +To search in a project see [[Searching in a project][project searching]]. =projectile= commands start with p: @@ -2508,7 +2510,7 @@ To search in a project see [[#searching-in-a-project][project searching]]. | ~SPC p p~ | switch project | | ~SPC p r~ | open a recent file | | ~SPC p R~ | replace a string | - | ~SPC p s~ | see [[#searching-in-a-project][search in project]] | + | ~SPC p s~ | see [[Searching in a project][search in project]] | | ~SPC p t~ | open =NeoTree= in =projectile= root | | ~SPC p T~ | find test files | | ~SPC p v~ | open project root in =vc-dir= or =magit= | @@ -2572,9 +2574,9 @@ It is possible to change the major mode leader key by defining the variable =dotspacemacs-major-mode-leader-key= in your =~/.spacemacs=. For example to setup the key on tabulation: -#+begin_src emacs-lisp - (setq-default dotspacemacs-major-mode-leader-key "") -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-major-mode-leader-key "") +#+END_SRC *** Helm Spacemacs add =hjkl= navigation to =helm= buffers: @@ -2599,16 +2601,16 @@ file in Emacs within the terminal. If you want your Linux/OS X system to use Emacs by default for any prompt, you need to set it in your shell configuration, e.g. =~/.bashrc= or =~/.zshrc=: -#+begin_src sh-mode +#+BEGIN_SRC sh-mode export EDITOR="emacsclient -c" -#+end_src +#+END_SRC Note that if you're on OS X, you may have to refer to the emacsclient that comes with your GUI Emacs, e.g.: -#+begin_src sh-mode +#+BEGIN_SRC sh-mode export EDITOR="/Applications/Emacs.app/Contents/MacOS/bin/emacsclient -c" -#+end_src +#+END_SRC Tip: Remember to use ~:wq~ or ~C-x #~ after you are done editing the file in Emacs. @@ -2619,9 +2621,9 @@ See [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Emacs-Server.htm It is possible to keep the server alive when you close Emacs by setting the variable =dotspacemacs-persistent-server= to =t= in your =~./spacemacs=. -#+begin_src emacs-lisp - (setq-default dotspacemacs-persistent-server t) -#+end_src +#+BEGIN_SRC emacs-lisp +(setq-default dotspacemacs-persistent-server t) +#+END_SRC When this variable is set to =t=, the only way to quit Emacs /and/ kill the server is to use the following bindings: @@ -2698,12 +2700,12 @@ file to =~/.spacemacs= | 1000th joiner | [[https://github.com/gabrielpoca][gabrielpoca]] | ** First times -| Achievements | Account | -|----------------------------------------+--------------| -| [[https://github.com/syl20bnr/spacemacs/pull/19][First contribution]] | [[https://github.com/trishume][trishume]] | -| [[https://github.com/syl20bnr/spacemacs/commit/e802027d75d0c0aed55539b0da2dfa0df94dfd39][First contribution layer]] | [[https://github.com/trishume][trishume]] | -| [[http://oli.me.uk/2014/11/06/spacemacs-emacs-vim/][First blog article on Spacemacs]] | [[https://github.com/Wolfy87][Wolfy87]] | -| [[https://github.com/syl20bnr/spacemacs/commit/7b44a56263049482ed540ed6815a295633ffe9d1][First contributed banner]] | [[https://github.com/chrisbarrett][chrisbarrett]] | +| Achievements | Account | +|---------------------------------+--------------| +| [[https://github.com/syl20bnr/spacemacs/pull/19][First contribution]] | [[https://github.com/trishume][trishume]] | +| [[https://github.com/syl20bnr/spacemacs/commit/e802027d75d0c0aed55539b0da2dfa0df94dfd39][First contribution layer]] | [[https://github.com/trishume][trishume]] | +| [[http://oli.me.uk/2014/11/06/spacemacs-emacs-vim/][First blog article on Spacemacs]] | [[https://github.com/Wolfy87][Wolfy87]] | +| [[https://github.com/syl20bnr/spacemacs/commit/7b44a56263049482ed540ed6815a295633ffe9d1][First contributed banner]] | [[https://github.com/chrisbarrett][chrisbarrett]] | ** Specials | Achievements | Account | @@ -2717,7 +2719,7 @@ file to =~/.spacemacs= | The PR Patrol Officer | [[https://github.com/robbyoconnor][robbyoconnor]] | * Thank you -[[#using-configuration-layers][Jokes aside]], thank you Richard for this great piece of software. +[[Using configuration layers][Jokes aside]], thank you Richard for this great piece of software. Thank you to all the contributors and the whole Emacs community from core developers to elisp hackers! diff --git a/doc/FAQ.org b/doc/FAQ.org index 87a11a32d..af56862f9 100644 --- a/doc/FAQ.org +++ b/doc/FAQ.org @@ -1,64 +1,66 @@ -* FAQ :TOC@4: - - [[#common][Common]] - - [[#which-version-of-spacemacs-am-i-running][Which version of Spacemacs am I running?]] - - [[#what-is-the-official-pronunciation-of-spacemacs][What is the official pronunciation of Spacemacs?]] - - [[#why-are-packages-installed-with-package-install-automatically-deleted-by-spacemacs-when-it-boots][Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?]] - - [[#the-spacemacs-banner-is-ugly-what-should-i-do][The Spacemacs banner is ugly, what should I do?]] - - [[#the-powerline-separators-are-ugly-how-can-i-fix-them][The powerline separators are ugly, how can I fix them?]] - - [[#the-powerline-separators-have-no-anti-aliasing-what-can-i-do][The powerline separators have no anti-aliasing, what can I do?]] - - [[#why-is-after-init-hook-not-executed][Why is after-init-hook not executed?]] - - [[#what-is-the-difference-between-spacemacs-base-and-spacemacs-distributions][What is the difference between =spacemacs-base= and =spacemacs= distributions?]] - - [[#how-can-i-change-or-define-an-alias-for-an-evil-leader-prefix][How can I change or define an alias for an =evil-leader= prefix?]] - - [[#should-i-place-my-settings-in-user-init-or-user-config][Should I place my settings in =user-init= or =user-config=?]] - - [[#why-do-some-of-my-org-related-settings-cause-problems][Why do some of my =org=-related settings cause problems?]] - - [[#how-do-i][How do I]] - - [[#disable-a-package-completely][Disable a package completely?]] - - [[#disable-a-package-only-for-a-specific-major-mode][Disable a package only for a specific major-mode?]] - - [[#disable-company-for-a-specific-major-mode][Disable company for a specific major-mode?]] - - [[#change-special-buffer-rules][Change special buffer rules?]] - - [[#enable-navigation-by-visual-lines][Enable navigation by visual lines?]] - - [[#disable-evilification-of-a-mode][Disable evilification of a mode?]] - - [[#include-underscores-in-word-motions][Include underscores in word motions?]] - - [[#setup-path][Setup =$PATH=?]] - - [[#windows][Windows]] - - [[#why-do-the-fonts-look-crappy-on-windows][Why do the fonts look crappy on Windows?]] - - [[#why-is-there-no-spacemacs-logo-in-the-startup-buffer][Why is there no Spacemacs logo in the startup buffer?]] - - [[#why-are-all-packages-unavailable][Why are all packages unavailable?]] - - [[#os-x][OS X]] - - [[#why-are-the-powerline-colors-not-correct-on-os-x][Why are the powerline colors not correct on OS X?]] +#+SETUPFILE: theme-readtheorg.setup -** Common -*** Which version of Spacemacs am I running? +* FAQ :TOC_4_org:noexport: + - [[Common][Common]] + - [[Which version of Spacemacs am I running?][Which version of Spacemacs am I running?]] + - [[What is the official pronunciation of Spacemacs?][What is the official pronunciation of Spacemacs?]] + - [[Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?][Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots?]] + - [[The Spacemacs banner is ugly, what should I do?][The Spacemacs banner is ugly, what should I do?]] + - [[The powerline separators are ugly, how can I fix them?][The powerline separators are ugly, how can I fix them?]] + - [[The powerline separators have no anti-aliasing, what can I do?][The powerline separators have no anti-aliasing, what can I do?]] + - [[Why is after-init-hook not executed?][Why is after-init-hook not executed?]] + - [[What is the difference between =spacemacs-base= and =spacemacs= distributions?][What is the difference between =spacemacs-base= and =spacemacs= distributions?]] + - [[How can I change or define an alias for an =evil-leader= prefix?][How can I change or define an alias for an =evil-leader= prefix?]] + - [[Should I place my settings in =user-init= or =user-config=?][Should I place my settings in =user-init= or =user-config=?]] + - [[Why do some of my =org=-related settings cause problems?][Why do some of my =org=-related settings cause problems?]] + - [[How do I...][How do I...]] + - [[Disable a package completely?][Disable a package completely?]] + - [[Disable a package only for a specific major-mode?][Disable a package only for a specific major-mode?]] + - [[Disable company for a specific major-mode?][Disable company for a specific major-mode?]] + - [[Change special buffer rules?][Change special buffer rules?]] + - [[Enable navigation by visual lines?][Enable navigation by visual lines?]] + - [[Disable evilification of a mode?][Disable evilification of a mode?]] + - [[Include underscores in word motions?][Include underscores in word motions?]] + - [[Setup =$PATH=?][Setup =$PATH=?]] + - [[Windows][Windows]] + - [[Why do the fonts look crappy on Windows?][Why do the fonts look crappy on Windows?]] + - [[Why is there no Spacemacs logo in the startup buffer?][Why is there no Spacemacs logo in the startup buffer?]] + - [[Why are all packages unavailable?][Why are all packages unavailable?]] + - [[OS X][OS X]] + - [[Why are the powerline colors not correct on OS X?][Why are the powerline colors not correct on OS X?]] + +* Common +** Which version of Spacemacs am I running? The version is displayed on the upper right corner of the loading screen. You may also just type ~SPC f e v~. -*** What is the official pronunciation of Spacemacs? +** What is the official pronunciation of Spacemacs? As it is written, that is _space_ then _macs_. -*** Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots? +** Why are packages installed with =package-install= automatically deleted by Spacemacs when it boots? To declare new packages you have to create a new configuration layer, see the [[file:QUICK_START.org][quick start guide]]. -*** The Spacemacs banner is ugly, what should I do? +** The Spacemacs banner is ugly, what should I do? Install the default font supported by Spacemacs or choose a fixed width font. More information in the font section of the [[file:DOCUMENTATION.org][documentation]]. -*** The powerline separators are ugly, how can I fix them? +** The powerline separators are ugly, how can I fix them? Use the property =:powerline-scale= of the variable =dotspacemacs-default-font=. See font section of the [[file:DOCUMENTATION.org][documentation]] for more details. -*** The powerline separators have no anti-aliasing, what can I do? +** The powerline separators have no anti-aliasing, what can I do? Emacs powerline uses XMP images to draw the separators in a graphical environment. You can have anti-aliasing if you use the =utf8= separator. Note that by default the =utf8= separator is used in a terminal. See the powerline section in the font section of the [[file:DOCUMENTATION.org][documentation]]. -*** Why is after-init-hook not executed? +** Why is after-init-hook not executed? Don't launch Spacemacs with =emacs -q -l init.el= command. This command will run the hooked function in =after-init-hook= before the evaluation of the passed =-l init.el= file. -*** What is the difference between =spacemacs-base= and =spacemacs= distributions? +** What is the difference between =spacemacs-base= and =spacemacs= distributions? The =distribution= concept was introduced in 0.104.x. You can now choose between two distributions =spacemacs= or =spacemacs-base=. =spacemacs-base= contains only a minimal set of packages; whereas =spacemacs= @@ -68,7 +70,7 @@ Set the distribution with =dotspacemacs-distribution= variable. The default is check out the =packages.el= file in the respective folders in the =+distribution= folder of the =layers/= directory. -*** How can I change or define an alias for an =evil-leader= prefix? +** How can I change or define an alias for an =evil-leader= prefix? It is possible to change an =evil-leader= prefix by binding its keymap to another sequence. For instance, if you want to switch ~SPC l~ (=evil-avy-goto-line=) with ~SPC L~ (=perspectives= layer) to make the later @@ -80,21 +82,21 @@ easier to reach, you can use: "L" 'evil-avy-goto-line) #+end_src -*** Should I place my settings in =user-init= or =user-config=? +** Should I place my settings in =user-init= or =user-config=? Any variable that layer configuration code will *read* and *act on* must be set in =user-init=, and any variable that Spacemacs explicitly sets but you wish to *override* must be set in =user-config=. Anything that isn't just setting a variable should 99% be in =user-config=. -*** Why do some of my =org=-related settings cause problems? +** Why do some of my =org=-related settings cause problems? Since version 0.104, spacemacs uses the `org` version from the org ELPA repository instead of the one shipped with emacs. Then, any `org` related code should not be loaded before `dotspacemacs/user-config`, otherwise both versions will be loaded and will conflict. -** How do I -*** Disable a package completely? +* How do I... +** Disable a package completely? To completely disable a package and effectively uninstalling it even if it is part of your used layers, look for the variable =dotspacemacs-excluded-packages= in your dotfile and add the package @@ -104,7 +106,7 @@ name to it: (setq-default dotspacemacs-excluded-packages '(package1 package2 ...)) #+end_src -*** Disable a package only for a specific major-mode? +** Disable a package only for a specific major-mode? This is done by removing the hook added by Spacemacs. For example to remove =flycheck= support in python buffers, look for the function =dotspacemacs/user-config= in your dotfile and add the following code: @@ -116,7 +118,7 @@ remove =flycheck= support in python buffers, look for the function *Hint* to know the name of the major-mode of the current buffer press: ~SPC h d v major-mode RET~ -*** Disable company for a specific major-mode? +** Disable company for a specific major-mode? It may be handy to disable =company= for a given mode if you plan on configuring =auto-complete= instead. On easy way to do it is to use the macro =spacemacs|disable-company= in the function =dotspacemacs/user-config= @@ -127,7 +129,7 @@ of your dotfile. The following snippet disables company for (spacemacs|disable-company python-mode) #+end_src -*** Change special buffer rules? +** Change special buffer rules? To change the way spacemacs marks buffers as useless, you can customize =spacemacs-useless-buffers-regexp= which marks buffers matching the regexp as useless. The variable =spacemacs-useful-buffers-regexp= marks @@ -143,7 +145,7 @@ Examples: (push "\\*Messages\\*" spacemacs-useful-buffers-regexp) #+end_src -*** Enable navigation by visual lines? +** Enable navigation by visual lines? Add the following snippet to your =dostpacemacs/config= function: #+begin_src emacs-lisp @@ -155,7 +157,7 @@ Add the following snippet to your =dostpacemacs/config= function: (define-key evil-visual-state-map "k" 'evil-previous-visual-line) #+end_src -*** Disable evilification of a mode? +** Disable evilification of a mode? You can ensure a mode opens in emacs state by using =evil-set-initial-state=. #+begin_src emacs-lisp @@ -179,7 +181,7 @@ binding in the mode's map, e.g. for =magit-status-mode=, (kbd dotspacemacs-leader-key) evil-leader--default-map)) #+end_src -*** Include underscores in word motions? +** Include underscores in word motions? You can modify the syntax table of the mode in question. For example, for Python mode: @@ -188,7 +190,7 @@ mode: (modify-syntax-entry ?_ "w" python-mode-syntax-table)) #+end_src -*** Setup =$PATH=? +** Setup =$PATH=? Some layers require certain tools to be available on your =$PATH=. This means that your =$PATH= must contain the installation paths for those tools. For example, if you have installed some tools to =~/.local/bin= and want them to be @@ -206,7 +208,7 @@ Users of =fish= should add following line to their =config.fish= file (should be in =$XDG_CONFIG_HOME= or its default value - =~/.config/fish=). Note that =-x= part is very important. -#+BEGIN_SRC +#+BEGIN_SRC fish set -x PATH ~/.local/bin $PATH #+END_SRC @@ -236,17 +238,17 @@ In that case you have the option of updating the value of =exec-path= in the (add-to-list 'exec-path "~/.local/bin/") #+END_SRC -** Windows -*** Why do the fonts look crappy on Windows? +* Windows +** Why do the fonts look crappy on Windows? You can install [[https://code.google.com/p/mactype/][MacType]] on Windows to get very nice looking fonts. It is also recommended to disable smooth scrolling on Windows. -*** Why is there no Spacemacs logo in the startup buffer? +** Why is there no Spacemacs logo in the startup buffer? A GUI build of emacs supporting image display is required. You can follow the instructions [[http://stackoverflow.com/questions/2650041/emacs-under-windows-and-png-files][here]]. Alternatively you can download binaries of emacs with image support included such as [[http://emacsbinw64.sourceforge.net/][this one]]. -*** Why are all packages unavailable? +** Why are all packages unavailable? Check if your Emacs has HTTPS capabilities by doing =M-:= and then: #+begin_src emacs-lisp @@ -256,8 +258,8 @@ Check if your Emacs has HTTPS capabilities by doing =M-:= and then: If this returns =nil=, you need to install the GnuTLS DDL file in the same directory as Emacs. See [[https://www.gnu.org/software/emacs/manual/html_mono/emacs-gnutls.html#Help-For-Users][here]] for instructions. -** OS X -*** Why are the powerline colors not correct on OS X? +* OS X +** Why are the powerline colors not correct on OS X? This is a [[https://github.com/milkypostman/powerline/issues/54][known issue]] as of Emacs 24.4 due to =ns-use-srgb-colorspace= -defaulting to true. It is recommended to use the [[github.com/railwaycat/homebrew-emacsmacport][emacs-mac-port]] build. See the +defaulting to true. It is recommended to use the [[http://github.com/railwaycat/homebrew-emacsmacport][emacs-mac-port]] build. See the install section in the [[file:../README.md][README]] for more details. diff --git a/doc/LAYERS.org b/doc/LAYERS.org index 4f839fbd1..f639595b0 100644 --- a/doc/LAYERS.org +++ b/doc/LAYERS.org @@ -1,31 +1,31 @@ -* Configuration Layers :TOC@4: - - [[#introduction][Introduction]] - - [[#nomenclature][Nomenclature]] - - [[#the-emacs-loading-process][The Emacs loading process]] - - [[#emacs-lisp-files][Emacs Lisp files]] - - [[#loading-a-file][Loading a file]] - - [[#features][Features]] - - [[#the-load-path][The load path]] - - [[#auto-loading][Auto-loading]] - - [[#eval-after-load][Eval after load]] - - [[#use-package][Use-package]] - - [[#anatomy-of-a-layer][Anatomy of a layer]] - - [[#packagesel][packages.el]] - - [[#configel-funcsel-and-keybindingsel][config.el, funcs.el and keybindings.el]] - - [[#the-spacemacs-loading-process][The Spacemacs loading process]] - - [[#case-study-auto-completion][Case study: auto-completion]] - - [[#layer-tips-and-tricks][Layer tips and tricks]] - - [[#cross-dependencies][Cross-dependencies]] - - [[#use-package][Use-package]] - - [[#use-package-hooks][Use-package hooks]] - - [[#best-practices][Best practices]] - - [[#package-ownership][Package ownership]] - - [[#localize-your-configuration][Localize your configuration]] - - [[#load-ordering][Load ordering]] - - [[#no-require][No require]] - - [[#auto-load-everything][Auto-load everything]] - - [[#how-do-i--idiomatically][How do I ... idiomatically?]] - - [[#setup-auto-completion-for-a-major-mode][Setup auto-completion for a major mode]] +* Configuration Layers :TOC_4_org:noexport: + - [[Introduction][Introduction]] + - [[Nomenclature][Nomenclature]] + - [[The Emacs loading process][The Emacs loading process]] + - [[Emacs Lisp files][Emacs Lisp files]] + - [[Loading a file][Loading a file]] + - [[Features][Features]] + - [[The load path][The load path]] + - [[Auto-loading][Auto-loading]] + - [[Eval after load][Eval after load]] + - [[Use-package][Use-package]] + - [[Anatomy of a layer][Anatomy of a layer]] + - [[packages.el][packages.el]] + - [[config.el, funcs.el and keybindings.el][config.el, funcs.el and keybindings.el]] + - [[The Spacemacs loading process][The Spacemacs loading process]] + - [[Case study: auto-completion][Case study: auto-completion]] + - [[Layer tips and tricks][Layer tips and tricks]] + - [[Cross-dependencies][Cross-dependencies]] + - [[Use-package][Use-package]] + - [[Use-package hooks][Use-package hooks]] + - [[Best practices][Best practices]] + - [[Package ownership][Package ownership]] + - [[Localize your configuration][Localize your configuration]] + - [[Load ordering][Load ordering]] + - [[No require][No require]] + - [[Auto-load everything][Auto-load everything]] + - [[How do I ... idiomatically?][How do I ... idiomatically?]] + - [[Setup auto-completion for a major mode][Setup auto-completion for a major mode]] * Introduction This document is intended as a tutorial for users who are interested in writing diff --git a/doc/QUICK_START.org b/doc/QUICK_START.org index b8f417f58..9ded727d1 100644 --- a/doc/QUICK_START.org +++ b/doc/QUICK_START.org @@ -1,18 +1,18 @@ -* Configuration :TOC@4: - - [[#configuration-layers][Configuration layers]] - - [[#dotfile-spacemacs][Dotfile (.spacemacs)]] - - [[#dotdirectory-spacemacsd][Dotdirectory (~/.spacemacs.d)]] - - [[#learning-spacemacs][Learning Spacemacs]] - - [[#editing-styles][Editing Styles]] - - [[#the-leader-keys][The leader keys]] - - [[#evil-tutor][Evil-tutor]] - - [[#universal-argument][Universal argument]] - - [[#configuration-layers-and-package-discovery][Configuration layers and Package discovery]] - - [[#key-bindings-discovery][Key bindings discovery]] - - [[#describe-functions][Describe functions]] - - [[#how-tos][How-To's]] +* Configuration :TOC_4_org:noexport: + - [[Configuration layers][Configuration layers]] + - [[Dotfile (.spacemacs)][Dotfile (.spacemacs)]] + - [[Dotdirectory (~/.spacemacs.d)][Dotdirectory (~/.spacemacs.d)]] + - [[Learning Spacemacs][Learning Spacemacs]] + - [[Editing Styles][Editing Styles]] + - [[The leader keys][The leader keys]] + - [[Evil-tutor][Evil-tutor]] + - [[Universal argument][Universal argument]] + - [[Configuration layers and Package discovery][Configuration layers and Package discovery]] + - [[Key bindings discovery][Key bindings discovery]] + - [[Describe functions][Describe functions]] + - [[How-To's][How-To's]] -** Configuration layers +* Configuration layers Spacemacs divides its configuration into self-contained units called =configuration layers=. These layers are stacked on top of each other to achieve a custom configuration. @@ -29,9 +29,9 @@ own layer. The following command creates a layer in the =private= directory: -#+BEGIN_SRC +#+BEGIN_EXAMPLE : configuration-layer/create-layer RET -#+END_SRC +#+END_EXAMPLE Any configuration layers you create must be explicitly loaded in =~/.spacemacs=. @@ -39,7 +39,7 @@ Note: For your privacy, the contents of the =private= directory are not under source control. See the section on private configuration management in the [[file:DOCUMENTATION.org][documentation]]. -** Dotfile (.spacemacs) +* Dotfile (.spacemacs) As mentioned =.spacemacs= controls which configuration layers to load and is also a means to customizing Spacemacs. @@ -82,18 +82,18 @@ The [[file:../core/templates/.spacemacs.template][dotfile template]] contain fur Spacemacs. See the dotfile configuration section of the [[file:DOCUMENTATION.org][documentation]] for more details. -** Dotdirectory (~/.spacemacs.d) +* Dotdirectory (~/.spacemacs.d) Like =Emacs=, Spacemacs initialization can also be contained in an =init.el= file in a special directory =~/.spacemacs.d=. The contents of the dotfile should be then copied in the =init.el= file. -** Learning Spacemacs -*** Editing Styles +* Learning Spacemacs +** Editing Styles Spacemacs can be used by Vim users or Emacs users by setting the =dotspacemacs-editing-style= variable to =vim=, =emacs= or even =hybrid= in the dotfile =~/.spacemacs=. -*** The leader keys +** The leader keys Spacemacs key bindings use a leader key which is by default bound to ~SPC~ (space bar) in =vim= or =hybrid= editing styles and ~M-m~ in =emacs= style. @@ -109,23 +109,23 @@ There is secondary leader key called the major-mode leader key which is set to ~,~ by default. This key is a shortcut for ~SPC m~ where all the major-mode specific commands are bound. -*** Evil-tutor +** Evil-tutor If you are willing to learn the Vim key bindings (highly recommended since you can benefit from them even in =emacs= style), press ~SPC h T~ to begin an Evil-adapted Vimtutor. -*** Universal argument +** Universal argument In =vim= editing style the universal argument defaults to ~SPC u~ instead of ~C-u~ because the latter is used to scroll up as in Vim. -*** Configuration layers and Package discovery +** Configuration layers and Package discovery By using =helm-spacemacs= with ~SPC f e h~ you can quickly search for a package and get the name of the layers using it. You can also easily go to the =README.org= of a layer or go to the initialization function of a package. -*** Key bindings discovery +** Key bindings discovery Thanks to [[https://github.com/justbur/emacs-which-key][which-key]], whenever a prefix command is pressed (like ~SPC~) a buffer appears after one second listing the possible keys for this prefix. @@ -144,7 +144,7 @@ type a pattern like this regular expression: which would list all =buffer= related bindings. -*** Describe functions +** Describe functions =Describe functions= are powerful Emacs introspection commands to get information about functions, variables, modes etc. These commands are bound thusly: @@ -155,5 +155,5 @@ about functions, variables, modes etc. These commands are bound thusly: | ~SPC h d m~ | describe-mode | | ~SPC h d v~ | describe-variable | -** How-To's +* How-To's Some quick =how-to's= are compiled in the [[file:HOWTOs.org][HOWTOs.org]] file. diff --git a/doc/VIMUSERS.org b/doc/VIMUSERS.org index 03fa9323e..7126fd827 100644 --- a/doc/VIMUSERS.org +++ b/doc/VIMUSERS.org @@ -1,37 +1,40 @@ -* Migrating from vim :TOC@4: - - [[#purpose-of-this-document][Purpose of this document]] - - [[#philosophy][Philosophy]] - - [[#basic-orientation][Basic orientation]] - - [[#terms][Terms]] - - [[#modes-vs-states][Modes vs. States]] - - [[#layers][Layers]] - - [[#micro-states][Micro-states]] - - [[#keybinding-conventions][Keybinding conventions]] - - [[#running-commands][Running commands]] - - [[#buffer-and-window-management][Buffer and window management]] - - [[#buffers][Buffers]] - - [[#windows][Windows]] - - [[#files][Files]] - - [[#the-help-system][The Help System]] - - [[#exploring][Exploring]] - - [[#customization][Customization]] - - [[#the-spacemacs-file][The .spacemacs file]] - - [[#emacs-lisp][Emacs Lisp]] - - [[#variables][Variables]] - - [[#keybindings][Keybindings]] - - [[#functions][Functions]] - - [[#activating-a-layer][Activating a Layer]] - - [[#creating-a-layer][Creating a Layer]] - - [[#installing-a-single-package][Installing a single package]] - - [[#loading-packages][Loading packages]] - - [[#uninstalling-a-package][Uninstalling a package]] - - [[#common-tweaks][Common tweaks]] - - [[#changing-the-escape-key][Changing the escape key]] - - [[#changing-the-colorscheme][Changing the colorscheme]] - - [[#nohlsearch][Nohlsearch]] - - [[#sessions][Sessions]] - - [[#navigating-using-visual-lines][Navigating using visual lines]] - - [[#other-useful-links][Other useful links]] +#+SETUPFILE: theme-readtheorg.setup + +* Migrating from vim :TOC_4_org:noexport: + - [[Purpose of this document][Purpose of this document]] + - [[Philosophy][Philosophy]] + - [[Basic orientation][Basic orientation]] + - [[Terms][Terms]] + - [[Modes vs. States][Modes vs. States]] + - [[Layers][Layers]] + - [[Micro-states][Micro-states]] + - [[Keybinding conventions][Keybinding conventions]] + - [[Running commands][Running commands]] + - [[Buffer and window management][Buffer and window management]] + - [[Buffers][Buffers]] + - [[Special buffers][Special buffers]] + - [[Windows][Windows]] + - [[Files][Files]] + - [[The Help System][The Help System]] + - [[Exploring][Exploring]] + - [[Customization][Customization]] + - [[The .spacemacs file][The .spacemacs file]] + - [[Emacs Lisp][Emacs Lisp]] + - [[Variables][Variables]] + - [[Keybindings][Keybindings]] + - [[Functions][Functions]] + - [[Activating a Layer][Activating a Layer]] + - [[Creating a Layer][Creating a Layer]] + - [[Installing a single package][Installing a single package]] + - [[Loading packages][Loading packages]] + - [[Uninstalling a package][Uninstalling a package]] + - [[Common tweaks][Common tweaks]] + - [[Changing the escape key][Changing the escape key]] + - [[Changing the colorscheme][Changing the colorscheme]] + - [[Nohlsearch][Nohlsearch]] + - [[Sessions][Sessions]] + - [[Navigating using visual lines][Navigating using visual lines]] + - [[Other useful links][Other useful links]] * Purpose of this document This document is intended to supplement the Spacemacs documentation by bridging @@ -51,11 +54,11 @@ read both files to fully understand Spacemacs. vim and the nicer configuration language of Emacs. * Basic orientation -*** Terms +** Terms Spacemacs uses some different terminology than vim, which can cause confusion for new users. This section attempts to clear up any confusion. -**** Modes vs. States +*** Modes vs. States In vim you have various editing modes like =insert mode= and =visual mode= to manipulate text. In Emacs, we have [[./DOCUMENTATION.org#states][states]]. These are equivalent to vim modes. For example, =evil-insert-state= is the same as =insert-mode= in vim. @@ -69,7 +72,7 @@ generally a corresponding =major-mode= per filetype. An example of a =major-mode =python-mode=, which provides python specific settings in python files. There is only one =major-mode= per buffer. -**** Layers +*** Layers Spacemacs has the concept of layers. Layers are similar to vim plugins. They provide new features to use in Spacemacs. However, layers are often comprised of several packages that integrate well with each other. For example, the =python= @@ -77,9 +80,9 @@ layer includes support for auto-completion, documentation look-up, tests, and much more by using several different packages. This keeps you from thinking about what packages to install, and instead worry about what features you want. More information on layers can be found in the [[./VIMUSERS.org#customization][customization]] section and in the -[[./DOCUMENTATION.org#configuration-layers][documentation]]. There is also a more in-depth guide on writing layers [[LAYERS.org][here]]. +[[./DOCUMENTATION.org#configuration-layers][documentation]]. There is also a more in-depth guide on writing layers [[file:LAYERS.org][here]]. -**** Micro-states +*** Micro-states Spacemacs provides a special functionality called micro-states. Micro-states allow similar commands to be run in succession without repeatedly pressing the ~~ key. Micro-states are usually triggered by using a keybinding with the @@ -91,7 +94,7 @@ bottom of your window. To exit a micro-state press ~q~. [[file:img/spacemacs-scale-micro-state.png]] -*** Keybinding conventions +** Keybinding conventions Spacemacs uses ~SPC~ as its ~~ key. This document will use ~SPC~ to refer to the ~~ key. All keybindings are mnemonic and are organized under the ~~ key. For example, the keybindings for language-specific commands are @@ -104,7 +107,7 @@ Spacemacs uses [[https://github.com/justbur/emacs-which-key][which-key]] to show [[file:img/which-key.png]] -*** Running commands +** Running commands Emacs commands can be run using ~SPC :~. This will pop up a buffer using [[https://github.com/emacs-helm/helm][Helm]] which can be used to run any Emacs command. You can also run many ex commands using ~:~, just like in vim. @@ -112,8 +115,8 @@ using ~:~, just like in vim. Note: You can run Emacs interactive commands using ~:~, but you cannot run ex commands using ~SPC :~. -*** Buffer and window management -**** Buffers +** Buffer and window management +*** Buffers Buffers in Emacs and vim are essentially the same. The keybindings for buffers are located under the ~SPC b~ prefix. @@ -128,12 +131,12 @@ are located under the ~SPC b~ prefix. | ~SPC b K~ | Kill all buffers except the current buffer. | | ~SPC b .~ | Buffer micro-state. | -***** Special buffers +**** Special buffers By default Emacs creates a lot of buffers that most people will never need, like =*Messages*=. Spacemacs automatically ignores these when using these key bindings. More information can be found [[./DOCUMENTATION.org#special-buffers][here]]. -**** Windows +*** Windows Windows are like splits in vim. They are useful for editing multiple files at once. All window keybindings are under the ~SPC w~ prefix. @@ -145,7 +148,7 @@ once. All window keybindings are under the ~SPC w~ prefix. | ~SPC w H/J/K/L~ | Move the current window. | | ~SPC w .~ | Window micro-state. | -*** Files +** Files All file commands in Spacemacs are available under the ~SPC f~ prefix. | Keybinding | Function | @@ -156,7 +159,7 @@ All file commands in Spacemacs are available under the ~SPC f~ prefix. | ~:x~ | Save the current file and quit. | | ~:e ~ | Open == | -*** The Help System +** The Help System Emacs has an extensive help system. All keybindings under the ~SPC h d~ prefix allow convenient access to the help system. The most important of these keybindings are ~SPC h d f~ , ~SPC h d k~ , and ~SPC h d v~. There is also the @@ -172,7 +175,7 @@ keybindings are ~SPC h d f~ , ~SPC h d k~ , and ~SPC h d v~. There is also the Whenever, you see weird behavior or want to know what something does, these functions are the first thing you should refer to. -*** Exploring +** Exploring There are a few ways to explore the functionality of Spacemacs. One is to read the [[https://github.com/syl20bnr/spacemacs][source code]] on Github. You can begin to feel your way around Emacs Lisp and how Spacemacs works this way. You can also use the following keybindings to @@ -360,7 +363,7 @@ to override the configuration of a package in another layer, use a If a package is not available on MELPA, you must use a local package or a package recipe. For more details see [[file:LAYERS.org#anatomy-of-a-layer][anatomy of a layer]]. -Make sure you [[#activating-a-layer][add]] your layer to your =.spacemacs= file and restart to +Make sure you [[Activating a Layer][add]] your layer to your =.spacemacs= file and restart to activate it. A detailed description of the loading process and how layers work can be found in @@ -372,7 +375,7 @@ and don't want to maintain a whole layer. Spacemacs provides a variable in the =dotspacemacs/layers= function in =.spacemacs= called =dotspacemacs-additional-packages=. Just add a package name to the list and it will be installed when you restart. Loading the package is covered in the next -[[#loading-packages][section]]. +[[Loading packages][section]]. ** Loading packages Ever wonder how Spacemacs can load over a 100 packages in just a few seconds? @@ -455,7 +458,7 @@ when you are not navigating between them. You can use ~SPC s c~ or ~:nohlsearch~ to disable search result highlighting. To disable the result highlighting when it is not needed anymore automatically, -you can [[#uninstalling-a-package][uninstall]] the =evil-search-highlight-persist= package. +you can [[Uninstalling a package][uninstall]] the =evil-search-highlight-persist= package. *** Sessions Spacemacs does not automatically restore your windows and buffers when you diff --git a/doc/theme-readtheorg.setup b/doc/theme-readtheorg.setup new file mode 100644 index 000000000..b201faee2 --- /dev/null +++ b/doc/theme-readtheorg.setup @@ -0,0 +1,9 @@ +# -*- mode: org; -*- + +#+HTML_HEAD: +#+HTML_HEAD: + +#+HTML_HEAD: +#+HTML_HEAD: +#+HTML_HEAD: +#+HTML_HEAD: diff --git a/layers/+config-files/ansible/README.org b/layers/+config-files/ansible/README.org index ea3812acf..13358cdca 100644 --- a/layers/+config-files/ansible/README.org +++ b/layers/+config-files/ansible/README.org @@ -2,17 +2,15 @@ [[file:img/ansible.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description - This layer adds support for Ansible-flavored YAML buffers. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -21,6 +19,6 @@ To use this contribution add it to your =~/.spacemacs= * Key bindings -| Key Binding | Description | -|---------------+------------------------------------------| -| ~SPC m a ?~ | looks up documentation using [[https://github.com/lunaryorn/ansible-doc.el][ansible-doc]] | +| Key Binding | Description | +|-------------+------------------------------------------| +| ~SPC m a ?~ | looks up documentation using [[https://github.com/lunaryorn/ansible-doc.el][ansible-doc]] | diff --git a/layers/+config-files/dockerfile/README.org b/layers/+config-files/dockerfile/README.org index 8f2494dec..3837e5bdf 100644 --- a/layers/+config-files/dockerfile/README.org +++ b/layers/+config-files/dockerfile/README.org @@ -2,17 +2,15 @@ [[file:img/docker.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description - This layer provides syntax highlighting and build functionality for Docker files. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -21,6 +19,6 @@ To use this contribution add it to your =~/.spacemacs= * Key bindings -| Key Binding | Description | -|---------------+----------------------------------------------------| -| ~SPC m c b~ | build current buffer via =dockerfile-build-buffer= | +| Key Binding | Description | +|-------------+----------------------------------------------------| +| ~SPC m c b~ | build current buffer via =dockerfile-build-buffer= | diff --git a/layers/+config-files/puppet/README.org b/layers/+config-files/puppet/README.org index eccfb554b..a6716c568 100644 --- a/layers/+config-files/puppet/README.org +++ b/layers/+config-files/puppet/README.org @@ -2,21 +2,19 @@ [[file:img/puppet.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description - This layer aims at providing support for the Puppet DSL using [[https://github.com/lunaryorn/puppet-mode][puppet-mode]]. * Features - Puppetfile support via [[http://melpa.org/#/puppetfile-mode][puppetfile-mode]] * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -24,7 +22,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key bindings - The following key bindings are available in Puppet Mode: | Key Binding | Description | diff --git a/layers/+config-files/salt/README.org b/layers/+config-files/salt/README.org index b1fdc4985..326bffc65 100644 --- a/layers/+config-files/salt/README.org +++ b/layers/+config-files/salt/README.org @@ -2,9 +2,10 @@ [[file:img/saltstack.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description This layer provides syntax highlighting for Saltstack files. @@ -18,6 +19,6 @@ To use this contribution add it to your =~/.spacemacs= * Key bindings -| Key Binding | Description | -|---------------+----------------------------------------------| -| ~SPC m p b~ | mmm-mode parse buffer via =mmm-parse-buffer= | +| Key Binding | Description | +|-------------+----------------------------------------------| +| ~SPC m p b~ | mmm-mode parse buffer via =mmm-parse-buffer= | diff --git a/layers/+config-files/terraform/README.org b/layers/+config-files/terraform/README.org index d5bf58585..ffdcb02d7 100644 --- a/layers/+config-files/terraform/README.org +++ b/layers/+config-files/terraform/README.org @@ -3,17 +3,15 @@ [[file:img/terraform.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description - This layer provides syntax support for Terraform `.tf` files using [terraform-mode](https://github.com/syohex/emacs-terraform-mode). * Install - To use this layer add it to your `~/.spacemacs` #+BEGIN_SRC emacs-lisp diff --git a/layers/+email/gnus/README.org b/layers/+email/gnus/README.org index 307de10db..92230d25d 100644 --- a/layers/+email/gnus/README.org +++ b/layers/+email/gnus/README.org @@ -2,13 +2,13 @@ [[file:img/gnus.gif]] -* Table of Contents :TOC@4: - - [[#install][Install]] - - [[#basic-concepts][Basic Concepts]] - - [[#adding-news-sources][Adding news sources]] - - [[#configuring-gmail][Configuring gmail]] - - [[#org-mime-in-org-layer][Org MIME in Org layer]] - - [[#keybindings][Keybindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Install][Install]] + - [[Basic Concepts][Basic Concepts]] + - [[Adding news sources][Adding news sources]] + - [[Configuring gmail][Configuring gmail]] + - [[Org MIME in Org layer][Org MIME in Org layer]] + - [[Keybindings][Keybindings]] * Install @@ -44,7 +44,7 @@ following: )) #+END_SRC -For adding RSS Feeds please see the [[#Keybindings][keybindings section]]. +For adding RSS Feeds please see the [[Keybindings][keybindings section]]. * Configuring gmail @@ -85,10 +85,10 @@ To configure Gnus with gmail support you can add the following to your Authentication for your gmail account is best stored in an =authinfo= or =authinfo.pgp= file. It must be of the form: -#+BEGIN_SRC +#+BEGIN_EXAMPLE machine smtp.gmail.com login name@gmail.com password SUPER_SECRET_PASS machine imap.gmail.com login name@gmail.com port 993 password SUPER_SECRET_PASS -#+END_SRC +#+END_EXAMPLE If you use two-step verification the password has to be an [[https://support.google.com/accounts/answer/185833?hl=en][application specific password]]. @@ -108,15 +108,15 @@ Please see the [[http://www.gnus.org/manual.html][manual]] for a complete list. Basic and Spacemacs specific keybindings can be found in the following table. -| Key Binding | Gnus mode - Description | -|-------------+----------------------------------------------------------| -| ~SPC a g~ | Starts Gnus | -| ~m~ | New Message | -| ~G R~ | Group Buffer - Add RSS feed | -| ~^~ | Open Server Buffer. Browse Newsgroups. | -| ~T n~ | Group Buffer - new Topic | -| ~T m~ | Group Buffer - Move Group to Topic | -| ~K~ | Article Buffer - Previous article | -| ~J~ | Article Buffer - Next article | -| ~RET~ | Summary Buffer(RSS) - Open article Link in browser | -| ~TAB~ | Summary Buffer(RSS) - Open article and switch to it | +| Key Binding | Gnus mode - Description | +|-------------+-----------------------------------------------------| +| ~SPC a g~ | Starts Gnus | +| ~m~ | New Message | +| ~G R~ | Group Buffer - Add RSS feed | +| ~^~ | Open Server Buffer. Browse Newsgroups. | +| ~T n~ | Group Buffer - new Topic | +| ~T m~ | Group Buffer - Move Group to Topic | +| ~K~ | Article Buffer - Previous article | +| ~J~ | Article Buffer - Next article | +| ~RET~ | Summary Buffer(RSS) - Open article Link in browser | +| ~TAB~ | Summary Buffer(RSS) - Open article and switch to it | diff --git a/layers/+frameworks/django/README.org b/layers/+frameworks/django/README.org index 700485a5f..baf81f68e 100644 --- a/layers/+frameworks/django/README.org +++ b/layers/+frameworks/django/README.org @@ -1,23 +1,21 @@ #+TITLE: Python contribution layer for Spacemacs [[file:img/django.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#fabric][Fabric]] - - [[#files][Files]] - - [[#interactive][Interactive]] - - [[#server][Server]] - - [[#southsyncdb][South/Syncdb]] - - [[#test][Test]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Fabric][Fabric]] + - [[Files][Files]] + - [[Interactive][Interactive]] + - [[Server][Server]] + - [[South/Syncdb][South/Syncdb]] + - [[Test][Test]] * Description - This layer adds support for the Python [[https://www.djangoproject.com/][Django]] framework via [[https://github.com/davidmiller/pony-mode][pony-mode]]. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -25,7 +23,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key Bindings - Django related key bindings uses [[https://github.com/davidmiller/pony-mode][pony-mode]] and are behind the prefix ~SPC m j~. Configuration options for pony-mode are documented at diff --git a/layers/+frameworks/react/README.org b/layers/+frameworks/react/README.org index 2f7b2ffcc..7a99ee2a2 100644 --- a/layers/+frameworks/react/README.org +++ b/layers/+frameworks/react/README.org @@ -1,30 +1,27 @@ -* React contribution layer for Spacemacs +#+TITLE: React contribution layer for Spacemacs -#+CAPTION: logo +[[file:img/react.png]] -[[img/react.png]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Optional Configuration][Optional Configuration]] + - [[Key Bindings][Key Bindings]] + - [[js2-mode][js2-mode]] + - [[Folding (js2-mode)][Folding (js2-mode)]] + - [[Refactoring (js2-refactor)][Refactoring (js2-refactor)]] + - [[Formatting (web-beautify)][Formatting (web-beautify)]] + - [[Documentation (js-doc)][Documentation (js-doc)]] + - [[Auto-complete and documentation (tern)][Auto-complete and documentation (tern)]] + - [[JSON][JSON]] -** Table of Contents :TOC@4: - - [[#react-contribution-layer-for-spacemacs][React contribution layer for Spacemacs]] - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#optional-configuration][Optional Configuration]] - - [[#key-bindings][Key Bindings]] - - [[#js2-mode][js2-mode]] - - [[#folding-js2-mode][Folding (js2-mode)]] - - [[#refactoring-js2-refactor][Refactoring (js2-refactor)]] - - [[#formatting-web-beautify][Formatting (web-beautify)]] - - [[#documentation-js-doc][Documentation (js-doc)]] - - [[#auto-complete-and-documentation-tern][Auto-complete and documentation (tern)]] - - [[#json][JSON]] - -** Description +* Description ES6 and JSX ready configuration layer for React It will automatically recognize =.jsx= and =.react.js= files -*** Features +** Features - on-the-fly syntax checking - proper syntax highlight and indentation with jsx - ternjs turbocharged autocompletion as in js2-mode @@ -32,7 +29,7 @@ It will automatically recognize =.jsx= and =.react.js= files - js2-refactor - js-doc -** TODO Install +* Install To use this contribution add it to your =~/.spacemacs= @@ -86,7 +83,7 @@ Be sure to have the ~e4x~ option set to ~true~ on your ~.jsbeautifyrc~ here it i } #+END_SRC -** Optional Configuration +* Optional Configuration You may refer to the =web-mode= configuration for fine tuning the indenting behaviour. diff --git a/layers/+frameworks/ruby-on-rails/README.org b/layers/+frameworks/ruby-on-rails/README.org index ad210f0dd..e1f51e788 100644 --- a/layers/+frameworks/ruby-on-rails/README.org +++ b/layers/+frameworks/ruby-on-rails/README.org @@ -2,21 +2,19 @@ [[file:img/ror.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#code-navigation][Code Navigation]] - - [[#refactoring][Refactoring]] - - [[#run-commands][RUN commands]] - - [[#ex-commands][Ex-commands]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Code Navigation][Code Navigation]] + - [[Refactoring][Refactoring]] + - [[RUN commands][RUN commands]] + - [[Ex-commands][Ex-commands]] * Description - This layer aims at providing support for the Ruby on Rails framework. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -24,7 +22,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key bindings - ** Code Navigation | Key binding | Description | diff --git a/layers/+fun/emoji/README.org b/layers/+fun/emoji/README.org index eead5ce00..93a99f6d6 100644 --- a/layers/+fun/emoji/README.org +++ b/layers/+fun/emoji/README.org @@ -2,15 +2,14 @@ #+HTML: :blue_heart::green_heart::heart::gift_heart::heartbeat::heartpulse::purple_heart::sparkling_heart::yellow_heart: -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#emoji-dedicated-buffer][Emoji dedicated buffer]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Emoji dedicated buffer][Emoji dedicated buffer]] * Description - This layer adds support for Emoji emoticons from [[http://www.emoji-cheat-sheet.com/][emoji-cheat-sheet.com]]. ** Features: @@ -20,7 +19,6 @@ This layer adds support for Emoji emoticons from [[http://www.emoji-cheat-sheet. - Completion of Emojis using [[https://github.com/dunn/company-emoji][company-emoji]] * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp diff --git a/layers/+fun/games/README.org b/layers/+fun/games/README.org index 080245216..02963970e 100644 --- a/layers/+fun/games/README.org +++ b/layers/+fun/games/README.org @@ -2,15 +2,15 @@ [[file:img/games.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#2048][2048]] - - [[#tetris][Tetris]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[2048][2048]] + - [[Pacmacs][Pacmacs]] + - [[Tetris][Tetris]] * Description - This layer allows you to play evilified games in spacemacs. The games available now are: @@ -19,7 +19,6 @@ The games available now are: - Tetris * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -27,7 +26,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key bindings - To run a game: | Key Binding | Description | @@ -50,13 +48,13 @@ Possible helm actions: ** Pacmacs -| Key Binding | Description | -|-------------+-------------------| -| ~h~ | Move left | -| ~j~ | Move down | -| ~k~ | Move up | -| ~l~ | Move right | -| | | +| Key Binding | Description | +|-------------+-------------| +| ~h~ | Move left | +| ~j~ | Move down | +| ~k~ | Move up | +| ~l~ | Move right | +| | | ** Tetris | Key Binding | Description | diff --git a/layers/+fun/xkcd/README.org b/layers/+fun/xkcd/README.org index 52c65b1c5..a17ec2514 100644 --- a/layers/+fun/xkcd/README.org +++ b/layers/+fun/xkcd/README.org @@ -2,15 +2,14 @@ [[file:img/xkcd.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#tell-me-how-to-spawn-the-xkcd-greatness][Tell me how to spawn the xkcd greatness!!]] - - [[#okay-what-now][Okay, what now]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Tell me how to spawn the xkcd greatness!!][Tell me how to spawn the xkcd greatness!!]] + - [[Okay, what now][Okay, what now]] * Description - This layer adds a [[http://xkcd.com/][xkcd]] navigation mode using [[https://github.com/vibhavp/emacs-xkcd][emacs-xkcd]]. Features: @@ -20,7 +19,6 @@ Features: - Cache the comics in =.cache/xkcd= * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -28,7 +26,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key Bindings - ** Tell me how to spawn the xkcd greatness!! | Key Binding | Description | @@ -36,7 +33,6 @@ To use this contribution add it to your =~/.spacemacs= | ~SPC a x~ | Open xkcd mode | ** Okay, what now - You can now move through the comics with these | Key Binding | Description | diff --git a/layers/+irc/erc/README.org b/layers/+irc/erc/README.org index a459733a5..cbb8695e3 100644 --- a/layers/+irc/erc/README.org +++ b/layers/+irc/erc/README.org @@ -1,20 +1,18 @@ #+TITLE: ERC contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#os-x][OS X]] - - [[#social-graph][Social graph]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[OS X][OS X]] + - [[Social graph][Social graph]] + - [[Key bindings][Key bindings]] * Description - Layer for [[http://www.emacswiki.org/emacs/ERC][ERC IRC chat]]. * Features - - Highlight nicks (using [[https://github.com/leathekd/erc-hl-nicks][erc-hl-nicks]]) - Image inline support (using [[https://github.com/kidd/erc-image.el][erc-image]]) - Logging to ~/.emacs.d/.cache/erc-logs and ViewLogMode for viewing logs @@ -32,9 +30,7 @@ Layer for [[http://www.emacswiki.org/emacs/ERC][ERC IRC chat]]. using the =emoji= layer or having a proper font) :clap: * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -42,29 +38,27 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC ** OS X - It's recommended to install the [[https://github.com/alloy/terminal-notifier][terminal-notifier gem]] so that you get notifications via the OS X Notification Center. ** Social graph - [[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] needs graphviz to be installed on your system. * Key bindings -| Key Binding | Description | -|---------------+-------------------------------------------------------| -| ~SPC a i e~ | Starts ERC | -| ~SPC a i E~ | Starts ERC via TLS/SSL | -| ~SPC a i i~ | Switch to next active ERC buffer | -| ~SPC m b~ | Switch between ERC buffers | -| ~SPC m d~ | Interactively input a user action and send it to IRC. | -| ~SPC m D~ | Draw Social Graph using [[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] | -| ~SPC m j~ | Join a channel, executes the /join command | -| ~SPC m n~ | Run "/names #channel" in the current channel. | -| ~SPC m l~ | Run the /list command | -| ~SPC m p~ | Part from the channel | -| ~SPC m q~ | Quit server | +| Key Binding | Description | +|-------------+-------------------------------------------------------| +| ~SPC a i e~ | Starts ERC | +| ~SPC a i E~ | Starts ERC via TLS/SSL | +| ~SPC a i i~ | Switch to next active ERC buffer | +| ~SPC m b~ | Switch between ERC buffers | +| ~SPC m d~ | Interactively input a user action and send it to IRC. | +| ~SPC m D~ | Draw Social Graph using [[https://github.com/vibhavp/erc-social-graph][erc-social-graph]] | +| ~SPC m j~ | Join a channel, executes the /join command | +| ~SPC m n~ | Run "/names #channel" in the current channel. | +| ~SPC m l~ | Run the /list command | +| ~SPC m p~ | Part from the channel | +| ~SPC m q~ | Quit server | *Note:* If you want to connect securely to an IRC server, you must run =erc-tls= command on ~SPC a i E~ instead of the =erc= command. diff --git a/layers/+irc/rcirc/README.org b/layers/+irc/rcirc/README.org index a5ef4250d..004b1249b 100644 --- a/layers/+irc/rcirc/README.org +++ b/layers/+irc/rcirc/README.org @@ -2,30 +2,28 @@ [[file:img/irc.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#storing-the-credentials-in-your-dotfile][Storing the credentials in your dotfile]] - - [[#example][Example:]] - - [[#storing-the-credentials-in-your-dropbox][Storing the credentials in your Dropbox]] - - [[#example][Example:]] - - [[#storing-the-credentials-in-authinfo][Storing the credentials in authinfo]] - - [[#connecting-behind-a-znc-bouncer-and-storing-the-credentials-in-authinfo][Connecting behind a ZNC bouncer and storing the credentials in authinfo]] - - [[#disclaimer][Disclaimer]] - - [[#note][Note]] - - [[#key-bindings][Key Bindings]] - - [[#rcirc-documentation][Rcirc documentation]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Configuration][Configuration]] + - [[Storing the credentials in your dotfile][Storing the credentials in your dotfile]] + - [[Example:][Example:]] + - [[Storing the credentials in your Dropbox][Storing the credentials in your Dropbox]] + - [[Example:][Example:]] + - [[Storing the credentials in authinfo][Storing the credentials in authinfo]] + - [[Connecting behind a ZNC bouncer and storing the credentials in authinfo][Connecting behind a ZNC bouncer and storing the credentials in authinfo]] + - [[Disclaimer][Disclaimer]] + - [[Note][Note]] + - [[Key Bindings][Key Bindings]] + - [[Rcirc documentation][Rcirc documentation]] * Description - This layer provide support for [[http://www.gnu.org/software/emacs/manual/html_mono/rcirc.html][rcirc]] with optional support for authinfo and ZNC. * Features - - Store channel logs into =~/.emacs.d/.cache/rcirc-logs/= - Support for credentials stored in =~/.authinfo.gpg= (need to have gnutls) - Support ZNC support (with optional =~/.authinfo.gpg=) @@ -35,9 +33,7 @@ and ZNC. using the =emoji= layer or having a proper font) :clap: * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -45,7 +41,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC ** Configuration - There are several ways to configure rcirc supported by the layer: - By storing your credentials in =rcirc-server-alist= in your dotfile (not secured) @@ -55,7 +50,6 @@ There are several ways to configure rcirc supported by the layer: - By using a ZNC bouncer _and_ storing your credentials (secured) *** Storing the credentials in your dotfile - You can store your servers configuration along with your credentials in the =dotspacemacs/user-config= of your dotfile. @@ -64,7 +58,6 @@ your dotfile is often stored in a public repository and is not crypted. This is convenient but not recommended. **** Example: - #+BEGIN_SRC emacs-lisp (setq rcirc-server-alist '(("irc.freenode.net" @@ -75,7 +68,6 @@ is convenient but not recommended. #+END_SRC *** Storing the credentials in your Dropbox - You can store your servers configuration along with your credentials in your dropbox in the file =~/Dropbox/emacs/pinit-rcirc.el=. @@ -86,7 +78,6 @@ of the file containing your credentials. This is convenient but not recommended. **** Example: - #+BEGIN_SRC emacs-lisp (setq rcirc-server-alist '(("irc.freenode.net" @@ -97,7 +88,6 @@ recommended. #+END_SRC *** Storing the credentials in authinfo - This method is considered secured and is the recommended way to configure rcirc. @@ -110,9 +100,10 @@ rcirc. #+END_SRC 2) In your =~/.authinfo.gpg= file store your credentials like this: - #+BEGIN_SRC + + #+BEGIN_EXAMPLE machine irc.freenode.net port nickserv user password - #+END_SRC + #+END_EXAMPLE 3) At last you need to provide your servers configuration in the =dotspacemacs/user-config= function of your dotfile: @@ -126,7 +117,6 @@ rcirc. #+END_SRC *** Connecting behind a ZNC bouncer and storing the credentials in authinfo - This methods is also secured since it uses authinfo _but_ you must secure your ZNC server configuration as well! @@ -152,11 +142,11 @@ For now authinfo is mandatory to use the ZNC configuration. #+END_SRC 2) In your =~/.authinfo.gpg= file store your credentials like this: - - #+BEGIN_SRC + + #+BEGIN_EXAMPLE machine freenode.spacemacsserver.me port irc user spacemacs_user/freenode password ZNC_PASSWORD machine geekshed.spacemacsserver.me port irc user spacemacs_user/geekshed password ZNC_PASSWORD - #+END_SRC + #+END_EXAMPLE *Important* =port= must be set to =irc=. This is a convention of the layer to retrieve the credentials for the ZNC configuration. @@ -195,5 +185,4 @@ In normal state: | ~C-k~ | previous item in history | * Rcirc documentation - The rcirc documentation can be found [[http://www.gnu.org/software/emacs/manual/html_mono/rcirc.html][here]]. diff --git a/layers/+keyboard-layouts/bepo/README.org b/layers/+keyboard-layouts/bepo/README.org index 43fc91d9f..4610dbe5d 100644 --- a/layers/+keyboard-layouts/bepo/README.org +++ b/layers/+keyboard-layouts/bepo/README.org @@ -1,31 +1,30 @@ -* bepo contribution layer for Spacemacs +#+TITLE: bepo contribution layer for Spacemacs #+CAPTION: logo [[file:img/bepo.png]] -** Table of Contents :TOC@4: - - [[#bepo-contribution-layer-for-spacemacs][bepo contribution layer for Spacemacs]] - - [[#description][Description]] - - [[#mapping][Mapping]] - - [[#supported-modespackageslayer][Supported modes/packages/layer]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#company][company]] - - [[#evil][evil]] - - [[#evil-escape][evil-escape]] - - [[#evil-surround][evil-surround]] - - [[#evil-window][evil-window]] - - [[#helm][helm]] - - [[#magit][magit]] - - [[#neotree][neotree]] - - [[#org][org]] - - [[#ranger][ranger]] - - [[#spacemacs-specific][spacemacs-specific]] - - [[#contributors][Contributors]] - - [[#sources][Sources]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Mapping][Mapping]] + - [[Supported modes/packages/layer][Supported modes/packages/layer]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[company][company]] + - [[evil][evil]] + - [[evil-escape][evil-escape]] + - [[evil-surround][evil-surround]] + - [[evil-window][evil-window]] + - [[helm][helm]] + - [[magit][magit]] + - [[neotree][neotree]] + - [[org][org]] + - [[ranger][ranger]] + - [[spacemacs-specific][spacemacs-specific]] + - [[Contributors][Contributors]] + - [[Sources][Sources]] -** Description +* Description This layer change the key bindings in spacemacs to be compatible with the [[http://bepo.fr/][bepo]] keyboard layout. =bepo= is a keyboard layout optimized for the French language. This package first switch traditional ~hjkl~ movement keys with ~ctsr~, and then @@ -33,7 +32,7 @@ try to correct the bugs induced by these changes in other modes/packages. [[file:img/keymap.png]] -** Mapping +* Mapping The mapping correction is the one proposed for vim on the bepo's official [[http://bepo.fr/wiki/Vim#Principe][wiki]]. This layer tries to do the following changes when the following characters are used for *doing a movement*: @@ -95,7 +94,7 @@ Note: One difference exists with the wiki version: the ~w~ is *not* remapped to ~C-w~ to avoid having to change its meaning in other modes. Spacemacs provides already a ~SPC w~ key binding for working with windows. -** Supported modes/packages/layer +* Supported modes/packages/layer - avy - company - evil @@ -109,18 +108,18 @@ already a ~SPC w~ key binding for working with windows. - ranger - spacemacs -** Install +* Install To use this contribution add it to your =~/.spacemacs= #+begin_src emacs-lisp (setq-default dotspacemacs-configuration-layers '(bepo)) #+end_src -** Key bindings +* Key bindings Thanks to `wich-keys`, you shouldn't probably have to go through this list, the keys being shown after a small delay following a keypress. -*** company +** company |-------------+----------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+----------------------------+--------------------| @@ -129,7 +128,7 @@ keys being shown after a small delay following a keypress. | ~C-r~ | Company complete selection | ~C-l~ | |-------------+----------------------------+--------------------| -*** evil +** evil |-------------+----------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+----------------------------+--------------------| @@ -160,21 +159,21 @@ keys being shown after a small delay following a keypress. | ~«~ | Unindent | ~<~ | |-------------+----------------------------+--------------------| -*** evil-escape +** evil-escape |-------------+-------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+-------------+--------------------| | ~gq~ | Escape | ~fd~ | |-------------+-------------+--------------------| -*** evil-surround +** evil-surround |-------------+-------------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+-------------------------------+--------------------| | ~k~ | Evil-surround functionnalites | ~s~ | |-------------+-------------------------------+--------------------| -*** evil-window +** evil-window |-------------+------------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+------------------------------+--------------------| @@ -200,7 +199,7 @@ keys being shown after a small delay following a keypress. | ~SPC é~ | Alias for ~SPC w~ | ~SPC w~ | |-------------+------------------------------+--------------------| -*** helm +** helm |-------------+---------------------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+---------------------------------------+--------------------| @@ -211,7 +210,7 @@ keys being shown after a small delay following a keypress. | ~C-k~ | Helm find files run grep | ~C-s~ | |-------------+---------------------------------------+--------------------| -*** magit +** magit |-------------+----------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+----------------+--------------------| @@ -223,7 +222,7 @@ keys being shown after a small delay following a keypress. | ~h~ | Discard change | ~k~ | |-------------+----------------+--------------------| -*** neotree +** neotree |-------------+--------------------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+--------------------------------------+--------------------| @@ -243,7 +242,7 @@ keys being shown after a small delay following a keypress. |-------------+--------------------------------------+--------------------| | ~H~ | Neotree change root | ~R~ | |-------------+--------------------------------------+--------------------| -*** org +** org |---------------+--------------------------------------| | Key Binding | Description | |---------------+--------------------------------------| @@ -310,7 +309,7 @@ keys being shown after a small delay following a keypress. | ~SPC »~ | Org metaright | |---------------+--------------------------------------| -*** ranger +** ranger |-------------+---------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+---------------------+--------------------| @@ -328,7 +327,7 @@ keys being shown after a small delay following a keypress. | ~K~ | Eshell | ~S~ | |-------------+---------------------+--------------------| -*** spacemacs-specific +** spacemacs-specific |-------------+--------------------------------------+--------------------| | Key Binding | Description | Replace/equivalent | |-------------+--------------------------------------+--------------------| @@ -348,9 +347,9 @@ keys being shown after a small delay following a keypress. | ~SPC i Yw~ | Auto yasnippet persist snippet | ~SPC i Sw~ | |-------------+--------------------------------------+--------------------| -** Contributors +* Contributors - Fabien Dubosson -** Sources +* Sources The bepo logo and the keymap image come from the [[http://bepo.fr/][bepo]] official website. They are licensed under the [[http://creativecommons.org/licenses/by-sa/3.0/deed.en][CC-BY-SA]]. diff --git a/layers/+lang/agda/README.org b/layers/+lang/agda/README.org index 36921af77..e267fdff8 100644 --- a/layers/+lang/agda/README.org +++ b/layers/+lang/agda/README.org @@ -1,12 +1,12 @@ #+TITLE: Agda contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#some-features][Some features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#agda][Agda]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Some features:][Some features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Agda][Agda]] + - [[Key bindings][Key bindings]] * Description This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php][Agda]] programming language. diff --git a/layers/+lang/asciidoc/README.org b/layers/+lang/asciidoc/README.org index e2d7579c2..856bbac9c 100644 --- a/layers/+lang/asciidoc/README.org +++ b/layers/+lang/asciidoc/README.org @@ -1,12 +1,12 @@ #+TITLE: Asciidoc contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#feature][Feature]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#element-insertion][Element insertion]] - - [[#promotion-demotion][Promotion, Demotion]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Feature][Feature]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Element insertion][Element insertion]] + - [[Promotion, Demotion][Promotion, Demotion]] * Description This layer adds [[https://asciidoctor.org][AsciiDoc]] markup language support to Spacemacs. @@ -23,7 +23,6 @@ To use this contribution add it to your `~/.spacemacs` #+END_SRC * Key bindings - ** Element insertion | Key Binding | Description | diff --git a/layers/+lang/autohotkey/README.org b/layers/+lang/autohotkey/README.org index 8f3b04a5a..94430c835 100644 --- a/layers/+lang/autohotkey/README.org +++ b/layers/+lang/autohotkey/README.org @@ -2,11 +2,11 @@ [[file:img/ahk.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] * Description diff --git a/layers/+lang/c-c++/README.org b/layers/+lang/c-c++/README.org index c9ef2000f..75ed61dbc 100644 --- a/layers/+lang/c-c++/README.org +++ b/layers/+lang/c-c++/README.org @@ -3,24 +3,22 @@ [[file:img/ccpp.jpg]] [[file:img/cmake.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#default-mode-for-header-files][Default mode for header files]] - - [[#enable-clang-support][Enable Clang support]] - - [[#clang-format][clang-format]] - - [[#company-clang-and-flycheck][Company-clang and flycheck]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Default mode for header files][Default mode for header files]] + - [[Enable Clang support][Enable Clang support]] + - [[clang-format][clang-format]] + - [[Company-clang and flycheck][Company-clang and flycheck]] + - [[Key Bindings][Key Bindings]] * Description - This layer adds configuration for C/C++ language as well support for [[http://www.cmake.org/][CMake]] scripts. * Features - - Support syntax checking via flycheck with Clang. - Support for disassembly of code with [[https://github.com/jart/disaster][disaster]]. - Support code reformatting with [[http://clang.llvm.org/docs/ClangFormat.html][clang-format]]. @@ -31,9 +29,7 @@ scripts. demonstration of refactoring features. (when =semantic= layer is included) * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -43,7 +39,6 @@ To use this contribution add it to your =~/.spacemacs= *Note:* [[https://github.com/tuhdo/semantic-refactor][semantic-refactor]] is only available for Emacs 24.4+ ** Default mode for header files - By default header files are opened in =c-mode=, you can open them in =c++-mode= by setting the variable =c-c++-default-mode-for-headers= to =c++-mode=. @@ -58,7 +53,6 @@ variable at the root of your project. More info on directory local variables can be found in the [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Directory-Local-Variables.html][dir-locals]]. ** Enable Clang support - To enable Clang support set the layer variable =c-c++-enable-clang-support= to =t= in the dotfile: @@ -68,7 +62,6 @@ to =t= in the dotfile: #+END_SRC *** clang-format - [[http://clang.llvm.org/docs/ClangFormat.html][clang-format]] allows reformatting either a selected region of code (=clang-format-region=) or a whole buffer (=clang-format-buffer=) to make it conform to a style defined in a =.clang-format= file. This file is either @@ -89,7 +82,6 @@ particular mode or all modes in your =dotspacemacs/user-config= (within your #+END_SRC *** Company-clang and flycheck - This layer adds some fancy improvements to =company-clang=. It includes a hook to load a projects =.clang_complete= file, which is just a text file with one clang flag per line, a format also used by diff --git a/layers/+lang/clojure/README.org b/layers/+lang/clojure/README.org index b3bf7005b..840a67832 100644 --- a/layers/+lang/clojure/README.org +++ b/layers/+lang/clojure/README.org @@ -2,32 +2,32 @@ [[file:img/clojure.png]] [[file:img/cider.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#pretty-symbols][Pretty Symbols]] - - [[#cider-and-clj-refactor][CIDER and clj-refactor]] - - [[#quick-start-with-boot][Quick Start with boot]] - - [[#quick-start-with-lein][Quick Start with lein]] - - [[#more-details][More details]] - - [[#key-bindings][Key Bindings]] - - [[#working-with-clojure-files-barfage-slurpage--more][Working with clojure files (barfage, slurpage & more)]] - - [[#leader][Leader]] - - [[#documentation][Documentation]] - - [[#evaluation][Evaluation]] - - [[#goto][Goto]] - - [[#repl][REPL]] - - [[#tests][Tests]] - - [[#toggles][Toggles]] - - [[#debugging][Debugging]] - - [[#refactoring][Refactoring]] - - [[#reformatting][Reformatting]] - - [[#cider-buffers][CIDER Buffers]] - - [[#stacktrace-mode][stacktrace-mode]] - - [[#inspector-mode][inspector-mode]] - - [[#test-report-mode][test-report-mode]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Pretty Symbols][Pretty Symbols]] + - [[CIDER and clj-refactor][CIDER and clj-refactor]] + - [[Quick Start with boot][Quick Start with boot]] + - [[Quick Start with lein][Quick Start with lein]] + - [[More details][More details]] + - [[Key Bindings][Key Bindings]] + - [[Working with clojure files (barfage, slurpage & more)][Working with clojure files (barfage, slurpage & more)]] + - [[Leader][Leader]] + - [[Documentation][Documentation]] + - [[Evaluation][Evaluation]] + - [[Goto][Goto]] + - [[REPL][REPL]] + - [[Tests][Tests]] + - [[Toggles][Toggles]] + - [[Debugging][Debugging]] + - [[Refactoring][Refactoring]] + - [[Reformatting][Reformatting]] + - [[CIDER Buffers][CIDER Buffers]] + - [[stacktrace-mode][stacktrace-mode]] + - [[inspector-mode][inspector-mode]] + - [[test-report-mode][test-report-mode]] * Description diff --git a/layers/+lang/common-lisp/README.org b/layers/+lang/common-lisp/README.org index 899b5bf28..d0f8c7bf2 100644 --- a/layers/+lang/common-lisp/README.org +++ b/layers/+lang/common-lisp/README.org @@ -2,18 +2,18 @@ [[file:img/slime.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#working-with-lisp-files-barfage-slurpage--more][Working with lisp files (barfage, slurpage & more)]] - - [[#leader][Leader]] - - [[#help][Help]] - - [[#evaluation][Evaluation]] - - [[#repl][REPL]] - - [[#compile][Compile]] - - [[#navigation][Navigation]] - - [[#macroexpansion][Macroexpansion]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Working with lisp files (barfage, slurpage & more)][Working with lisp files (barfage, slurpage & more)]] + - [[Leader][Leader]] + - [[Help][Help]] + - [[Evaluation][Evaluation]] + - [[REPL][REPL]] + - [[Compile][Compile]] + - [[Navigation][Navigation]] + - [[Macroexpansion][Macroexpansion]] * Description A Spacemacs contribution layer providing Common Lisp support via [[https://github.com/slime/slime][SLIME]]. diff --git a/layers/+lang/csharp/README.org b/layers/+lang/csharp/README.org index 59aefe515..1228b5351 100644 --- a/layers/+lang/csharp/README.org +++ b/layers/+lang/csharp/README.org @@ -2,24 +2,24 @@ [[file:img/csharp.png]] [[file:img/dotnet.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#packages-included][Packages Included]] - - [[#install][Install]] - - [[#prerequisites][Prerequisites]] - - [[#aspnet-5][ASP.NET 5]] - - [[#curl][curl]] - - [[#omnisharp-server][Omnisharp server]] - - [[#caveats][Caveats]] - - [[#key-bindings][Key Bindings]] - - [[#compilation][Compilation]] - - [[#filesolutionproject-manipulation][File/Solution/Project manipulation]] - - [[#navigation][Navigation]] - - [[#helpers-documentation-info][Helpers (documentation, info)]] - - [[#refactoring][Refactoring]] - - [[#omnisharp-server-interaction][OmniSharp server interaction]] - - [[#tests][Tests]] - - [[#code-manipulation][Code manipulation]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Packages Included][Packages Included]] + - [[Install][Install]] + - [[Prerequisites][Prerequisites]] + - [[ASP.NET 5][ASP.NET 5]] + - [[curl][curl]] + - [[Omnisharp server][Omnisharp server]] + - [[Caveats][Caveats]] + - [[Key Bindings][Key Bindings]] + - [[Compilation][Compilation]] + - [[File/Solution/Project manipulation][File/Solution/Project manipulation]] + - [[Navigation][Navigation]] + - [[Helpers (documentation, info)][Helpers (documentation, info)]] + - [[Refactoring][Refactoring]] + - [[OmniSharp server interaction][OmniSharp server interaction]] + - [[Tests][Tests]] + - [[Code manipulation][Code manipulation]] * Description diff --git a/layers/+lang/d/README.org b/layers/+lang/d/README.org index 06510c2c4..f4917424f 100644 --- a/layers/+lang/d/README.org +++ b/layers/+lang/d/README.org @@ -2,24 +2,17 @@ [[file:img/dlogo.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description - This simple layer adds support for the [[http://dlang.org/][D language]]. It adds =d-mode= as well as integrating it with =auto-completion= and =syntax-checking=. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp (setq-default dotspacemacs-configuration-layers '(d)) #+END_SRC - -* Key Bindings - -None for now. diff --git a/layers/+lang/elixir/README.org b/layers/+lang/elixir/README.org index f30fa1561..673d8f8e9 100644 --- a/layers/+lang/elixir/README.org +++ b/layers/+lang/elixir/README.org @@ -2,20 +2,20 @@ [[file:img/elixir.png]] with [[file:img/alchemist.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#refcard][Refcard]] - - [[#help][Help]] - - [[#mix][Mix]] - - [[#project][Project]] - - [[#evaluation-in-place][Evaluation in place]] - - [[#repl-interactions][REPL interactions]] - - [[#tests][Tests]] - - [[#compile][Compile]] - - [[#execute][Execute]] - - [[#code-definition-jump][Code Definition Jump]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Refcard][Refcard]] + - [[Help][Help]] + - [[Mix][Mix]] + - [[Project][Project]] + - [[Evaluation in place][Evaluation in place]] + - [[REPL interactions][REPL interactions]] + - [[Tests][Tests]] + - [[Compile][Compile]] + - [[Execute][Execute]] + - [[Code Definition Jump][Code Definition Jump]] * Description diff --git a/layers/+lang/elm/README.org b/layers/+lang/elm/README.org index 6365a965e..9e9773ad3 100644 --- a/layers/+lang/elm/README.org +++ b/layers/+lang/elm/README.org @@ -2,25 +2,25 @@ [[file:img/elm.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#elm-platform][Elm Platform]] - - [[#os-x-and-windows-installers][OS X and Windows installers]] - - [[#universal-installer-using-npm][Universal installer using npm]] - - [[#source-code][Source code]] - - [[#elm-mode][elm-mode]] - - [[#elm-oracle][elm-oracle]] - - [[#basic-usage-tips][Basic usage tips]] - - [[#compilation][Compilation]] - - [[#reactor][Reactor]] - - [[#key-bindings][Key bindings]] - - [[#elm-make][elm-make]] - - [[#elm-repl][elm-repl]] - - [[#elm-reactor][elm-reactor]] - - [[#elm-package][elm-package]] - - [[#package-list-buffer][package list buffer]] - - [[#elm-oracle][elm-oracle]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Elm Platform][Elm Platform]] + - [[OS X and Windows installers][OS X and Windows installers]] + - [[Universal installer using npm][Universal installer using npm]] + - [[Source code][Source code]] + - [[elm-mode][elm-mode]] + - [[elm-oracle][elm-oracle]] + - [[Basic usage tips][Basic usage tips]] + - [[Compilation][Compilation]] + - [[Reactor][Reactor]] + - [[Key bindings][Key bindings]] + - [[elm-make][elm-make]] + - [[elm-repl][elm-repl]] + - [[elm-reactor][elm-reactor]] + - [[elm-package][elm-package]] + - [[package list buffer][package list buffer]] + - [[elm-oracle][elm-oracle]] * Description This layer adds support for [[http://elm-lang.org][Elm]]. diff --git a/layers/+lang/emacs-lisp/README.org b/layers/+lang/emacs-lisp/README.org index 6299e58c3..6747d9016 100644 --- a/layers/+lang/emacs-lisp/README.org +++ b/layers/+lang/emacs-lisp/README.org @@ -2,14 +2,14 @@ [[file:img/emacs-lisp.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#auto-compile][Auto-compile]] - - [[#key-bindings][Key bindings]] - - [[#working-with-lisp-files-barfage-slurpage--more][Working with lisp files (barfage, slurpage & more)]] - - [[#leader][Leader]] - - [[#srefactor][srefactor]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Auto-compile][Auto-compile]] + - [[Key bindings][Key bindings]] + - [[Working with lisp files (barfage, slurpage & more)][Working with lisp files (barfage, slurpage & more)]] + - [[Leader][Leader]] + - [[srefactor][srefactor]] * Description This layer gathers all the configuration related to emacs-lisp. This should diff --git a/layers/+lang/erlang/README.org b/layers/+lang/erlang/README.org index 71dec62c8..edd621f0f 100644 --- a/layers/+lang/erlang/README.org +++ b/layers/+lang/erlang/README.org @@ -2,9 +2,9 @@ [[file:img/erlang.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description diff --git a/layers/+lang/ess/README.org b/layers/+lang/ess/README.org index a461b63ae..3117bde34 100644 --- a/layers/+lang/ess/README.org +++ b/layers/+lang/ess/README.org @@ -2,12 +2,12 @@ [[file:img/r.jpg]] -* Table of Contents :TOC@4: - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#inferior-repl-process][Inferior REPL process]] - - [[#helpers][Helpers]] - - [[#options][Options]] +* Table of Contents :TOC_4_org:noexport: + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Inferior REPL process][Inferior REPL process]] + - [[Helpers][Helpers]] + - [[Options][Options]] * Install To use this contribution add it to your =~/.spacemacs= diff --git a/layers/+lang/fsharp/README.org b/layers/+lang/fsharp/README.org index 840218f22..1a4bccffb 100644 --- a/layers/+lang/fsharp/README.org +++ b/layers/+lang/fsharp/README.org @@ -2,12 +2,12 @@ [[file:img/fsharp.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#packages-included][Packages Included]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#repl][REPL]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Packages Included][Packages Included]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[REPL][REPL]] * Description diff --git a/layers/+lang/go/README.org b/layers/+lang/go/README.org index 9c8885869..0869caaab 100644 --- a/layers/+lang/go/README.org +++ b/layers/+lang/go/README.org @@ -2,17 +2,17 @@ [[file:img/go.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#pre-requisites][Pre-requisites]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#formatting][Formatting]] - - [[#working-with-go][Working with Go]] - - [[#go-commands-start-with-m][Go commands (start with =m=):]] - - [[#go-oracle][Go Oracle]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Pre-requisites][Pre-requisites]] + - [[Layer][Layer]] + - [[Configuration][Configuration]] + - [[Formatting][Formatting]] + - [[Working with Go][Working with Go]] + - [[Go commands (start with =m=):][Go commands (start with =m=):]] + - [[Go Oracle][Go Oracle]] * Description This layer adds extensive support for go. @@ -23,7 +23,6 @@ This layer adds extensive support for go. - Source analysis using [[http://golang.org/s/oracle-user-manual][go-oracle]] * Install - ** Pre-requisites You will need =gocode= and =godef=: @@ -48,22 +47,27 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Configuration - ** Formatting By default, go buffers are run through =gofmt= on save. To use a different formatter, set the value of =gofmt-command=, e.g. #+begin_src emacs-lisp (setq gofmt-command "goimports") - or +#+end_src + +or + +#+begin_src emacs-lisp (go :variables gofmt-command "goimports") #+end_src -# -If you're using =gocheck= in your project you can use the =go-use-gocheck-for-testing= variable to enable suite testing and to get single function testing to work. + +If you're using =gocheck= in your project you can use the +=go-use-gocheck-for-testing= variable to enable suite testing and to get single +function testing to work. * Working with Go - ** Go commands (start with =m=): + | Key Binding | Description | |-------------+---------------------------------------------------------------------------------------| | ~SPC m h h~ | godoc at point | diff --git a/layers/+lang/haskell/README.org b/layers/+lang/haskell/README.org index f34b30f44..3dee39a94 100644 --- a/layers/+lang/haskell/README.org +++ b/layers/+lang/haskell/README.org @@ -2,32 +2,32 @@ [[file:img/haskell.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#dependencies][Dependencies]] - - [[#setup-path][Setup PATH]] - - [[#ghc-mod-support][ghc-mod support]] - - [[#stack-users][Stack users]] - - [[#optional-extras][Optional extras]] - - [[#ghci-ng-support][GHCi-ng support]] - - [[#stack-users][Stack users]] - - [[#ghc-mod-users][ghc-mod users]] - - [[#structured-haskell-mode][structured-haskell-mode]] - - [[#hindent][hindent]] - - [[#key-bindings][Key bindings]] - - [[#documentation][Documentation]] - - [[#debug][Debug]] - - [[#repl][REPL]] - - [[#cabal-commands][Cabal commands]] - - [[#cabal-files][Cabal files]] - - [[#faq][FAQ]] - - [[#repl-doesnt-work][REPL doesn't work]] - - [[#repl-is-stuck][REPL is stuck]] - - [[#i-am-using-stack-and-ghc-mod-but-ghc-mod-doesnt-work][I am using =stack= and =ghc-mod=, but =ghc-mod= doesn't work]] - - [[#indentation-doesnt-reset-when-pressing-return-after-empty-line][Indentation doesn't reset when pressing return after empty line]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Dependencies][Dependencies]] + - [[Setup PATH][Setup PATH]] + - [[ghc-mod support][ghc-mod support]] + - [[Stack users][Stack users]] + - [[Optional extras][Optional extras]] + - [[GHCi-ng support][GHCi-ng support]] + - [[Stack users][Stack users]] + - [[ghc-mod users][ghc-mod users]] + - [[structured-haskell-mode][structured-haskell-mode]] + - [[hindent][hindent]] + - [[Key bindings][Key bindings]] + - [[Documentation][Documentation]] + - [[Debug][Debug]] + - [[REPL][REPL]] + - [[Cabal commands][Cabal commands]] + - [[Cabal files][Cabal files]] + - [[FAQ][FAQ]] + - [[REPL doesn't work][REPL doesn't work]] + - [[REPL is stuck][REPL is stuck]] + - [[I am using =stack= and =ghc-mod=, but =ghc-mod= doesn't work][I am using =stack= and =ghc-mod=, but =ghc-mod= doesn't work]] + - [[Indentation doesn't reset when pressing return after empty line][Indentation doesn't reset when pressing return after empty line]] * Description This layer adds support for the [[https://www.haskell.org/][Haskell]] language. diff --git a/layers/+lang/html/README.org b/layers/+lang/html/README.org index 3f19f7383..66d4d33fd 100644 --- a/layers/+lang/html/README.org +++ b/layers/+lang/html/README.org @@ -2,13 +2,13 @@ [[file:img/html.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#web-mode][Web mode]] - - [[#cssscss][CSS/SCSS]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Web mode][Web mode]] + - [[CSS/SCSS][CSS/SCSS]] * Description This layer adds support for editing HTML and CSS. @@ -27,7 +27,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key Bindings - ** Web mode | Key Binding | Description | diff --git a/layers/+lang/idris/README.org b/layers/+lang/idris/README.org index 4b52ee4d4..087262687 100644 --- a/layers/+lang/idris/README.org +++ b/layers/+lang/idris/README.org @@ -2,18 +2,18 @@ [[file:img/idris.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#idris][Idris]] - - [[#key-bindings][Key bindings]] - - [[#shorthands][Shorthands]] - - [[#interactive-editing][Interactive editing]] - - [[#documentation][Documentation]] - - [[#repl][REPL]] - - [[#active-term-manipulations][Active term manipulations]] - - [[#build-system][Build system]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Idris][Idris]] + - [[Key bindings][Key bindings]] + - [[Shorthands][Shorthands]] + - [[Interactive editing][Interactive editing]] + - [[Documentation][Documentation]] + - [[REPL][REPL]] + - [[Active term manipulations][Active term manipulations]] + - [[Build system][Build system]] * Description This layer adds support for the [[http://www.idris-lang.org/][Idris]] language. diff --git a/layers/+lang/ipython-notebook/README.org b/layers/+lang/ipython-notebook/README.org index 66a8fcc15..c334d4289 100644 --- a/layers/+lang/ipython-notebook/README.org +++ b/layers/+lang/ipython-notebook/README.org @@ -1,27 +1,27 @@ #+TITLE: IPython Notebook contribution layer for Spacemacs (WIP) -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#list-of-todos][List of TODOS]] - - [[#maybe-itd-be-better-if-there-was-a-state-for-this][Maybe it'd be better if there was a state for this]] - - [[#make-more-keybinding-to-connect-to-a-python-buffer][Make more keybinding to =connect= to a python buffer.]] - - [[#deleting-visual-regions-dont-work-find-out-why][Deleting visual regions don't work, find out why.]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#dependencies][Dependencies]] - - [[#what-needs-to-be-run][What needs to be run]] - - [[#using-the-ipython-notebook][Using the IPython notebook]] - - [[#open-notebook-list][Open Notebook List]] - - [[#key-bindings][Key Bindings]] - - [[#micro-state-ipython-notebook][Micro-state: =ipython-notebook=]] - - [[#normal-mode][Normal mode]] - - [[#insert-mode][Insert mode]] - - [[#traceback-mode][Traceback mode]] - - [[#screenshots][Screenshots]] - - [[#light][Light]] - - [[#dark][Dark]] - - [[#bonus][Bonus]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[List of TODOS][List of TODOS]] + - [[Maybe it'd be better if there was a state for this][Maybe it'd be better if there was a state for this]] + - [[Make more keybinding to =connect= to a python buffer.][Make more keybinding to =connect= to a python buffer.]] + - [[Deleting visual regions don't work, find out why.][Deleting visual regions don't work, find out why.]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Dependencies][Dependencies]] + - [[What needs to be run][What needs to be run]] + - [[Using the IPython notebook][Using the IPython notebook]] + - [[Open Notebook List][Open Notebook List]] + - [[Key Bindings][Key Bindings]] + - [[Micro-state: =ipython-notebook=][Micro-state: =ipython-notebook=]] + - [[Normal mode][Normal mode]] + - [[Insert mode][Insert mode]] + - [[Traceback mode][Traceback mode]] + - [[Screenshots][Screenshots]] + - [[Light][Light]] + - [[Dark][Dark]] + - [[Bonus][Bonus]] * Description This layer adds support for the package =emacs-ipython-notebook=. diff --git a/layers/+lang/java/README.org b/layers/+lang/java/README.org index 6c830a2bf..70941fb64 100644 --- a/layers/+lang/java/README.org +++ b/layers/+lang/java/README.org @@ -2,24 +2,24 @@ [[file:img/java.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#layer-installation][Layer Installation]] - - [[#layer][Layer]] - - [[#eclim][Eclim]] - - [[#installation][Installation]] - - [[#usage][Usage]] - - [[#key-bindings][Key bindings]] - - [[#java-mode][Java-mode]] - - [[#project-management][Project management]] - - [[#maven][Maven]] - - [[#goto][Goto]] - - [[#refactoring][Refactoring]] - - [[#documentation-find][Documentation, Find]] - - [[#problems][Problems]] - - [[#tests][Tests]] - - [[#problems-buffer][Problems buffer]] - - [[#projects-buffer][Projects buffer]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Layer Installation][Layer Installation]] + - [[Layer][Layer]] + - [[Eclim][Eclim]] + - [[Installation][Installation]] + - [[Usage][Usage]] + - [[Key bindings][Key bindings]] + - [[Java-mode][Java-mode]] + - [[Project management][Project management]] + - [[Maven][Maven]] + - [[Goto][Goto]] + - [[Refactoring][Refactoring]] + - [[Documentation, Find][Documentation, Find]] + - [[Problems][Problems]] + - [[Tests][Tests]] + - [[Problems buffer][Problems buffer]] + - [[Projects buffer][Projects buffer]] * Description This layer adds support for the Java language using the [[http://eclim.org][Eclim]] client/server. diff --git a/layers/+lang/javascript/README.org b/layers/+lang/javascript/README.org index 82aa7b6ff..b28728b43 100644 --- a/layers/+lang/javascript/README.org +++ b/layers/+lang/javascript/README.org @@ -2,19 +2,19 @@ [[file:img/javascript.png]] [[file:img/coffee.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#configuration][Configuration]] - - [[#key-bindings][Key Bindings]] - - [[#js2-mode][js2-mode]] - - [[#folding-js2-mode][Folding (js2-mode)]] - - [[#refactoring-js2-refactor][Refactoring (js2-refactor)]] - - [[#formatting-web-beautify][Formatting (web-beautify)]] - - [[#documentation-js-doc][Documentation (js-doc)]] - - [[#auto-complete-and-documentation-tern][Auto-complete and documentation (tern)]] - - [[#json][JSON]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Configuration][Configuration]] + - [[Key Bindings][Key Bindings]] + - [[js2-mode][js2-mode]] + - [[Folding (js2-mode)][Folding (js2-mode)]] + - [[Refactoring (js2-refactor)][Refactoring (js2-refactor)]] + - [[Formatting (web-beautify)][Formatting (web-beautify)]] + - [[Documentation (js-doc)][Documentation (js-doc)]] + - [[Auto-complete and documentation (tern)][Auto-complete and documentation (tern)]] + - [[JSON][JSON]] * Description diff --git a/layers/+lang/latex/README.org b/layers/+lang/latex/README.org index 1daae791f..6cac745fe 100644 --- a/layers/+lang/latex/README.org +++ b/layers/+lang/latex/README.org @@ -2,18 +2,18 @@ [[file:img/latex.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#auto-completion][Auto-completion]] - - [[#previewing][Previewing]] - - [[#build-command][Build command]] - - [[#auto-fill][Auto-fill]] - - [[#keybindings][Keybindings]] - - [[#reftex][RefTeX]] - - [[#maintainer][Maintainer]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Auto-completion][Auto-completion]] + - [[Previewing][Previewing]] + - [[Build command][Build command]] + - [[Auto-fill][Auto-fill]] + - [[Keybindings][Keybindings]] + - [[RefTeX][RefTeX]] + - [[Maintainer][Maintainer]] * Description @@ -79,7 +79,7 @@ The variable =latex-nofill-env= provide the list of environment names where * Keybindings | Key Binding | Description | -|-------------+---------------------------------------------------------+ +|-------------+---------------------------------------------------------| | ~SPC m *~ | TeX documentation, can be very slow | | ~SPC m b~ | build | | ~SPC m c~ | close LaTeX environment | diff --git a/layers/+lang/lua/README.org b/layers/+lang/lua/README.org index 1092e8376..0259a4ebb 100644 --- a/layers/+lang/lua/README.org +++ b/layers/+lang/lua/README.org @@ -2,12 +2,12 @@ [[file:img/lua.gif]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#commands][Commands]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Commands][Commands]] * Description diff --git a/layers/+lang/markdown/README.org b/layers/+lang/markdown/README.org index 6041ac972..5ed512c0a 100644 --- a/layers/+lang/markdown/README.org +++ b/layers/+lang/markdown/README.org @@ -2,22 +2,22 @@ [[file:img/markdown.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#usage][Usage]] - - [[#key-bindings][Key bindings]] - - [[#element-insertion][Element insertion]] - - [[#element-removal][Element removal]] - - [[#completion-and-cycling][Completion, and Cycling]] - - [[#following-and-jumping][Following and Jumping]] - - [[#indentation][Indentation]] - - [[#header-navigation][Header navigation]] - - [[#buffer-wide-commands][Buffer-wide commands]] - - [[#list-editing][List editing]] - - [[#movement][Movement]] - - [[#promotion-demotion][Promotion, Demotion]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Usage][Usage]] + - [[Key bindings][Key bindings]] + - [[Element insertion][Element insertion]] + - [[Element removal][Element removal]] + - [[Completion, and Cycling][Completion, and Cycling]] + - [[Following and Jumping][Following and Jumping]] + - [[Indentation][Indentation]] + - [[Header navigation][Header navigation]] + - [[Buffer-wide commands][Buffer-wide commands]] + - [[List editing][List editing]] + - [[Movement][Movement]] + - [[Promotion, Demotion][Promotion, Demotion]] * Description diff --git a/layers/+lang/nim/README.org b/layers/+lang/nim/README.org index 88ec48d36..5d8324d2f 100644 --- a/layers/+lang/nim/README.org +++ b/layers/+lang/nim/README.org @@ -2,12 +2,12 @@ [[file:img/logo.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#working-with-nim][Working with Nim]] - - [[#nim-commands-start-with-m][Nim commands (start with =m=):]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Working with Nim][Working with Nim]] + - [[Nim commands (start with =m=):][Nim commands (start with =m=):]] * Description @@ -26,6 +26,6 @@ To use this contribution add it to your =~/.spacemacs= * Working with Nim ** Nim commands (start with =m=): -| Key Binding | Description | -|-------------+-----------------------------------------------------------| -| ~SPC m c r~ | nim compile --run main.nim +| Key Binding | Description | +|-------------+----------------------------| +| ~SPC m c r~ | nim compile --run main.nim | diff --git a/layers/+lang/ocaml/README.org b/layers/+lang/ocaml/README.org index 7a333721f..0bb473c9b 100644 --- a/layers/+lang/ocaml/README.org +++ b/layers/+lang/ocaml/README.org @@ -2,18 +2,18 @@ [[file:img/ocaml.png]] -* Table of Content :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#opam-packages][OPAM packages]] - - [[#key-bindings][Key Bindings]] - - [[#repl-utop][REPL (utop)]] - - [[#todos][TODOS]] - - [[#add-more-proper-spacemacs-key-bindings-for-basic-merlin-tasks][Add more proper spacemacs key-bindings for basic merlin tasks]] - - [[#add-proper-keybindings-for-ocamldebug][Add proper keybindings for ocamldebug]] - - [[#add-more-keybindings-for-tuareg-mode][Add more keybindings for tuareg-mode]] +* Table of Content :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[OPAM packages][OPAM packages]] + - [[Key Bindings][Key Bindings]] + - [[REPL (utop)][REPL (utop)]] + - [[TODOS][TODOS]] + - [[Add more proper spacemacs key-bindings for basic merlin tasks][Add more proper spacemacs key-bindings for basic merlin tasks]] + - [[Add proper keybindings for ocamldebug][Add proper keybindings for ocamldebug]] + - [[Add more keybindings for tuareg-mode][Add more keybindings for tuareg-mode]] * Description This is a very basic layer for editing ocaml files. diff --git a/layers/+lang/php/README.org b/layers/+lang/php/README.org index d21442860..ae216e537 100644 --- a/layers/+lang/php/README.org +++ b/layers/+lang/php/README.org @@ -2,11 +2,11 @@ [[file:img/php.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/+lang/purescript/README.org b/layers/+lang/purescript/README.org index 977bfa9de..de32f0f5a 100644 --- a/layers/+lang/purescript/README.org +++ b/layers/+lang/purescript/README.org @@ -2,13 +2,13 @@ [[file:img/purescript-logo.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#purescript][Purescript]] - - [[#imports][Imports]] - - [[#repl][REPL]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Purescript][Purescript]] + - [[Imports][Imports]] + - [[REPL][REPL]] * Description diff --git a/layers/+lang/python/README.org b/layers/+lang/python/README.org index 30d1e865b..b8dc02ba3 100644 --- a/layers/+lang/python/README.org +++ b/layers/+lang/python/README.org @@ -2,24 +2,24 @@ [[file:img/python.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#test-runner][Test runner]] - - [[#anaconda-dependencies][Anaconda dependencies]] - - [[#automatic-buffer-formatting-on-save][Automatic buffer formatting on save]] - - [[#autoflake][autoflake]] - - [[#pylookup][pylookup]] - - [[#key-bindings][Key Bindings]] - - [[#inferior-repl-process][Inferior REPL process]] - - [[#running-python-script-in-shell][Running Python Script in shell]] - - [[#testing][Testing]] - - [[#refactoring][Refactoring]] - - [[#other-python-commands][Other Python commands]] - - [[#configuration][Configuration]] - - [[#fill-column][Fill column]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Test runner][Test runner]] + - [[Anaconda dependencies][Anaconda dependencies]] + - [[Automatic buffer formatting on save][Automatic buffer formatting on save]] + - [[autoflake][autoflake]] + - [[pylookup][pylookup]] + - [[Key Bindings][Key Bindings]] + - [[Inferior REPL process][Inferior REPL process]] + - [[Running Python Script in shell][Running Python Script in shell]] + - [[Testing][Testing]] + - [[Refactoring][Refactoring]] + - [[Other Python commands][Other Python commands]] + - [[Configuration][Configuration]] + - [[Fill column][Fill column]] * Description This layer adds support for the Python language. @@ -34,8 +34,8 @@ This layer adds support for the Python language. - PEP8 compliant formatting via [[https://github.com/google/yapf][YAPF]] - Suppression of unused import with [[https://github.com/myint/autoflake][autoflake]] - Use the ~%~ key to jump between blocks with [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] -* Install +* Install ** Layer To use this contribution add it to your =~/.spacemacs= @@ -59,9 +59,10 @@ The root of the project is detected with a =.git= directory or a =setup.cfg= fil =anaconda-mode= tries to install the dependencies itself but sometimes it does not work and you may encounter the following message when opening a python buffer: -#+begin_src + +#+begin_example Blocking call to accept-process-output with quit inhibited!! -#+end_src +#+end_example To fix this, install the =anaconda-mode= [[https://github.com/proofit404/anaconda-mode/blob/master/requirements.txt][anaconda-deps]] by hand: diff --git a/layers/+lang/racket/README.org b/layers/+lang/racket/README.org index 6711ed164..e998b1647 100644 --- a/layers/+lang/racket/README.org +++ b/layers/+lang/racket/README.org @@ -2,15 +2,15 @@ [[file:img/racket.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#navigation][Navigation]] - - [[#documentation][Documentation]] - - [[#tests][Tests]] - - [[#repl][REPL]] - - [[#other-key-bindings][Other key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Navigation][Navigation]] + - [[Documentation][Documentation]] + - [[Tests][Tests]] + - [[REPL][REPL]] + - [[Other key bindings][Other key bindings]] * Description diff --git a/layers/+lang/ruby/README.org b/layers/+lang/ruby/README.org index cb5bbf2a1..73a89d9ab 100644 --- a/layers/+lang/ruby/README.org +++ b/layers/+lang/ruby/README.org @@ -2,22 +2,20 @@ [[file:img/ruby.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#prerequisites][Prerequisites]] - - [[#ruby-version-management][Ruby version management]] - - [[#key-bindings][Key bindings]] - - [[#ruby-enh-ruby-mode-robe-inf-ruby-ruby-tools][Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)]] - - [[#ruby-test-mode][ruby-test-mode]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Prerequisites][Prerequisites]] + - [[Ruby version management][Ruby version management]] + - [[Key bindings][Key bindings]] + - [[Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)][Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools)]] + - [[ruby-test-mode][ruby-test-mode]] * Description - This layer provides support for the Ruby language with [[https://github.com/zenspider/enhanced-ruby-mode][enh-ruby-mode]] and [[https://github.com/dgutov/robe][robe-mode]]. Optionally Enh Ruby Mode can be replaced with the built-in Emacs Ruby Mode. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -34,7 +32,6 @@ This layer supports two different Ruby modes: Emacs' built-in Ruby Mode and #+END_SRC ** Prerequisites - Some of the advanced features supported by this layer depend on external gems that need to be installed in the context of your project (see below for guidance based on your version manager): @@ -57,7 +54,6 @@ specific documentation for details and caveats): #+END_SRC ** Ruby version management - This layer supports the use of [[https://rvm.io/][RVM]] and [[https://github.com/sstephenson/rbenv][Rbenv]]. To enable it, set the =ruby-version-manager= var in your =~/.spacemacs=: @@ -70,7 +66,6 @@ To enable it, set the =ruby-version-manager= var in your =~/.spacemacs=: Possible values are =rbenv= and =rvm=. * Key bindings - ** Ruby (enh-ruby-mode, robe, inf-ruby, ruby-tools) | Key binding | Description | @@ -91,7 +86,6 @@ Possible values are =rbenv= and =rvm=. | ~%~ | [[https://github.com/redguardtoo/evil-matchit][evil-matchit]] jumps between blocks | ** ruby-test-mode - ruby-test-mode comes bundled with spacemacs, but this contribution adds a couple of useful keybindings: diff --git a/layers/+lang/rust/README.org b/layers/+lang/rust/README.org index 06a34787f..80888c02f 100644 --- a/layers/+lang/rust/README.org +++ b/layers/+lang/rust/README.org @@ -2,12 +2,12 @@ [[file:img/rust.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#cargo][Cargo]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Cargo][Cargo]] + - [[Key bindings][Key bindings]] * Description This layer aims to support [[http://www.rust-lang.org/][Rust]] development in Spacemacs. @@ -16,7 +16,6 @@ It supports [[http://doc.crates.io/index.html][Cargo]], and has some basic auto- though Racer needs some additional configurations as described on their page. * Install - ** Layer To use this layer, add it to your =~/.spacemacs= diff --git a/layers/+lang/scala/README.org b/layers/+lang/scala/README.org index 0f7d9671f..67d1eabe3 100644 --- a/layers/+lang/scala/README.org +++ b/layers/+lang/scala/README.org @@ -2,26 +2,26 @@ [[file:img/scala.png]] with [[file:img/ensime.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#layer-installation][Layer Installation]] - - [[#ensime][Ensime]] - - [[#installation][Installation]] - - [[#usage][Usage]] - - [[#scalastyle][Scalastyle]] - - [[#key-bindings][Key bindings]] - - [[#ensime-key-bindings][Ensime key bindings]] - - [[#search][Search]] - - [[#sbt][sbt]] - - [[#typecheck][Typecheck]] - - [[#debug][Debug]] - - [[#errors][Errors]] - - [[#goto][Goto]] - - [[#documentation-inspect][Documentation, Inspect]] - - [[#server][Server]] - - [[#refactoring][Refactoring]] - - [[#tests][Tests]] - - [[#repl][REPL]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Layer Installation][Layer Installation]] + - [[Ensime][Ensime]] + - [[Installation][Installation]] + - [[Usage][Usage]] + - [[Scalastyle][Scalastyle]] + - [[Key bindings][Key bindings]] + - [[Ensime key bindings][Ensime key bindings]] + - [[Search][Search]] + - [[sbt][sbt]] + - [[Typecheck][Typecheck]] + - [[Debug][Debug]] + - [[Errors][Errors]] + - [[Goto][Goto]] + - [[Documentation, Inspect][Documentation, Inspect]] + - [[Server][Server]] + - [[Refactoring][Refactoring]] + - [[Tests][Tests]] + - [[REPL][REPL]] * Description diff --git a/layers/+lang/scheme/README.org b/layers/+lang/scheme/README.org index 95a8ed7f9..30d8bb96f 100644 --- a/layers/+lang/scheme/README.org +++ b/layers/+lang/scheme/README.org @@ -1,15 +1,15 @@ #+TITLE: Scheme contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#compiling-][Compiling ]] - - [[#navigation][Navigation]] - - [[#documentation][Documentation]] - - [[#insertion][Insertion]] - - [[#macroexpansion][Macroexpansion]] - - [[#repl][REPL]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Compiling ][Compiling ]] + - [[Navigation][Navigation]] + - [[Documentation][Documentation]] + - [[Insertion][Insertion]] + - [[Macroexpansion][Macroexpansion]] + - [[REPL][REPL]] * Description diff --git a/layers/+lang/shell-scripts/README.org b/layers/+lang/shell-scripts/README.org index 6c2ddb9cd..8dfc4ca61 100644 --- a/layers/+lang/shell-scripts/README.org +++ b/layers/+lang/shell-scripts/README.org @@ -2,10 +2,10 @@ [[file:img/fish.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] * Description diff --git a/layers/+lang/sml/README.org b/layers/+lang/sml/README.org index 1e65c0d24..50378c3c5 100644 --- a/layers/+lang/sml/README.org +++ b/layers/+lang/sml/README.org @@ -2,12 +2,12 @@ [[file:img/sml.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#form-completion][Form Completion]] - - [[#repl][REPL]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Form Completion][Form Completion]] + - [[REPL][REPL]] * Description diff --git a/layers/+lang/sql/README.org b/layers/+lang/sql/README.org index eb88b2ed6..a4c13e927 100644 --- a/layers/+lang/sql/README.org +++ b/layers/+lang/sql/README.org @@ -2,14 +2,14 @@ [[file:img/sql.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#highlighting][Highlighting]] - - [[#inferior-process-interactions-sqli][Inferior Process Interactions (SQLi)]] - - [[#send-sql-queries-to-sqli][Send SQL queries to SQLi:]] - - [[#sqli-buffer][SQLi buffer]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Highlighting][Highlighting]] + - [[Inferior Process Interactions (SQLi)][Inferior Process Interactions (SQLi)]] + - [[Send SQL queries to SQLi:][Send SQL queries to SQLi:]] + - [[SQLi buffer][SQLi buffer]] * Description diff --git a/layers/+lang/typescript/README.org b/layers/+lang/typescript/README.org index 64ef968d2..65f81770c 100644 --- a/layers/+lang/typescript/README.org +++ b/layers/+lang/typescript/README.org @@ -2,12 +2,12 @@ [[file:img/TypeScript.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#prerequisites][Prerequisites]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Prerequisites][Prerequisites]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/+lang/vimscript/README.org b/layers/+lang/vimscript/README.org index d37d64558..5c3723ef1 100644 --- a/layers/+lang/vimscript/README.org +++ b/layers/+lang/vimscript/README.org @@ -1,8 +1,8 @@ #+TITLE: Vimscript language contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description diff --git a/layers/+lang/windows-scripts/README.org b/layers/+lang/windows-scripts/README.org index 0f4de266b..d590feb96 100644 --- a/layers/+lang/windows-scripts/README.org +++ b/layers/+lang/windows-scripts/README.org @@ -2,15 +2,14 @@ [[file:img/ps.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#powershell][Powershell]] - - [[#batch-dosel][Batch (dos.el)]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Powershell][Powershell]] + - [[Batch (dos.el)][Batch (dos.el)]] * Description - This simple layer adds support for the Powershell scripting language as well as support for batch files. @@ -19,7 +18,6 @@ Incuded packages for extensions: - =.bat=: [[http://www.emacswiki.org/emacs/dos.el][dos.el]] * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -27,9 +25,7 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Key Bindings - ** Powershell - No useful bindings. ** Batch (dos.el) diff --git a/layers/+lang/yaml/README.org b/layers/+lang/yaml/README.org index c3fbeb90a..a079f0a01 100644 --- a/layers/+lang/yaml/README.org +++ b/layers/+lang/yaml/README.org @@ -1,15 +1,13 @@ #+TITLE: YAML contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description - This layer provides syntax highlighting for YAML files. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp diff --git a/layers/+source-control/git/README.org b/layers/+source-control/git/README.org index 89b8b4a00..ead4dfd80 100644 --- a/layers/+source-control/git/README.org +++ b/layers/+source-control/git/README.org @@ -2,25 +2,25 @@ [[file:img/git.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#recommended-settings][Recommended Settings]] - - [[#magit-status-fullscreen][Magit status fullscreen]] - - [[#magit-auto-complete][Magit auto-complete]] - - [[#magit-svn-plugin][Magit SVN plugin]] - - [[#git][Git]] - - [[#git-flow][Git-Flow]] - - [[#working-with-git][Working with Git]] - - [[#magit][Magit]] - - [[#staging-lines][Staging lines]] - - [[#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][Git-Flow]] - - [[#git-time-machine][Git time machine]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Recommended Settings][Recommended Settings]] + - [[Magit status fullscreen][Magit status fullscreen]] + - [[Magit auto-complete][Magit auto-complete]] + - [[Magit SVN plugin][Magit SVN plugin]] + - [[Git][Git]] + - [[Git-Flow][Git-Flow]] + - [[Working with Git][Working with Git]] + - [[Magit][Magit]] + - [[Staging lines][Staging lines]] + - [[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][Git-Flow]] + - [[Git time machine][Git time machine]] * Description This layers adds extensive support for [[http://git-scm.com/][git]]. @@ -140,34 +140,34 @@ Here are the often used bindings inside a =status buffer=: | Key Binding | Description | |-------------+-----------------------------------------------------| -| ~/~ | evil-search | -| ~$~ | open =command output buffer= | -| ~c c~ | open a =commit message buffer= | -| ~b b~ | checkout a branch | -| ~b c~ | create a branch | -| ~f f~ | fetch changes | -| ~F -r F~ | pull and rebase | -| ~gr~ | refresh | -| ~j~ | goto next magit section | -| ~C-j~ | next visual line | -| ~k~ | goto previous magit section | -| ~C-k~ | previous visual line | -| ~l l~ | open =log buffer= | -| ~n~ | next search occurrence | -| ~N~ | previous search occurrence | -| ~o~ | revert item at point | -| ~P P~ | push | -| ~q~ | quit | -| ~s~ | on a file or hunk in a diff: stage the file or hunk | -| ~x~ | discard changes | -| ~+~ | on a hunk: increase hunk size | -| ~-~ | on a hunk: decrease hunk size | -| ~S~ | stage all | -| ~TAB~ | on a file: expand/collapse diff | -| ~u~ | on a staged file: unstage | -| ~U~ | unstage all staged files | -| ~v or V~ | select multiple lines | -| ~z z~ | stash changes | +| ~/~ | evil-search | +| ~$~ | open =command output buffer= | +| ~c c~ | open a =commit message buffer= | +| ~b b~ | checkout a branch | +| ~b c~ | create a branch | +| ~f f~ | fetch changes | +| ~F -r F~ | pull and rebase | +| ~gr~ | refresh | +| ~j~ | goto next magit section | +| ~C-j~ | next visual line | +| ~k~ | goto previous magit section | +| ~C-k~ | previous visual line | +| ~l l~ | open =log buffer= | +| ~n~ | next search occurrence | +| ~N~ | previous search occurrence | +| ~o~ | revert item at point | +| ~P P~ | push | +| ~q~ | quit | +| ~s~ | on a file or hunk in a diff: stage the file or hunk | +| ~x~ | discard changes | +| ~+~ | on a hunk: increase hunk size | +| ~-~ | on a hunk: decrease hunk size | +| ~S~ | stage all | +| ~TAB~ | on a file: expand/collapse diff | +| ~u~ | on a staged file: unstage | +| ~U~ | unstage all staged files | +| ~v or V~ | select multiple lines | +| ~z z~ | stash changes | ** Staging lines Magit allows you to stage specific lines by selecting them in a diff and hitting @@ -192,19 +192,19 @@ will discard the commit message. | Key Binding | Description | |-------------+----------------| -| ~c~ or ~p~ | pick | -| ~e~ | edit | -| ~f~ | fixup | -| ~j~ | go down | -| ~gj~ | move line down | -| ~k~ | go up | -| ~gk~ | move line up | -| ~d~ or ~x~ | kill line | -| ~r~ | reword | -| ~s~ | squash | -| ~u~ | undo | -| ~y~ | insert | -| ~!~ | execute | +| ~c~ or ~p~ | pick | +| ~e~ | edit | +| ~f~ | fixup | +| ~j~ | go down | +| ~gj~ | move line down | +| ~k~ | go up | +| ~gk~ | move line up | +| ~d~ or ~x~ | kill line | +| ~r~ | reword | +| ~s~ | squash | +| ~u~ | undo | +| ~y~ | insert | +| ~!~ | execute | ** Quick guide for recurring use cases in Magit diff --git a/layers/+source-control/github/README.org b/layers/+source-control/github/README.org index c886c11c5..77971611a 100644 --- a/layers/+source-control/github/README.org +++ b/layers/+source-control/github/README.org @@ -2,15 +2,15 @@ [[file:img/github.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#key-bindings][Key Bindings]] - - [[#magit-gh-pulls][magit-gh-pulls]] - - [[#gistel][gist.el]] - - [[#browse-files][Browse files]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Key Bindings][Key Bindings]] + - [[magit-gh-pulls][magit-gh-pulls]] + - [[gist.el][gist.el]] + - [[Browse files][Browse files]] * Description diff --git a/layers/+source-control/perforce/README.org b/layers/+source-control/perforce/README.org index a30366cf7..44649f01d 100644 --- a/layers/+source-control/perforce/README.org +++ b/layers/+source-control/perforce/README.org @@ -2,10 +2,10 @@ [[file:img/p4.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/+source-control/version-control/README.org b/layers/+source-control/version-control/README.org index 8ff4bfa1c..34befa6bf 100644 --- a/layers/+source-control/version-control/README.org +++ b/layers/+source-control/version-control/README.org @@ -1,11 +1,11 @@ #+TITLE: Version-Control contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Key Bindings][Key Bindings]] * Description @@ -29,7 +29,7 @@ To use this contribution add it to your =~/.spacemacs= | Key Binding | Description | |-------------+---------------| -| ~SPC g h g~ | Go to hunk | -| ~SPC g h N~ | Previous hunk | -| ~SPC g h n~ | Next hunk | -| ~SPC g h r~ | Revert hunk | +| ~SPC g h g~ | Go to hunk | +| ~SPC g h N~ | Previous hunk | +| ~SPC g h n~ | Next hunk | +| ~SPC g h r~ | Revert hunk | diff --git a/layers/+tools/dash/README.org b/layers/+tools/dash/README.org index ae86642b4..6c4cb5713 100644 --- a/layers/+tools/dash/README.org +++ b/layers/+tools/dash/README.org @@ -3,17 +3,17 @@ [[file:img/zeal.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#dash-os-x][Dash (OS X)]] - - [[#zeal-linux--windows][Zeal (Linux & Windows)]] - - [[#check-documentation-for-x-at-point][Check Documentation for x-at-point]] - - [[#key-bindings][Key bindings]] - - [[#helm-dash][helm-dash]] - - [[#todos][TODOs]] - - [[#done-check-zeal][DONE Check zeal]] - - [[#todo-make-helm-dash-use-zeal-or-dash-docsets-by-default][TODO Make helm-dash use zeal or dash docsets by default.]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Dash (OS X)][Dash (OS X)]] + - [[Zeal (Linux & Windows)][Zeal (Linux & Windows)]] + - [[Check Documentation for x-at-point][Check Documentation for x-at-point]] + - [[Key bindings][Key bindings]] + - [[helm-dash][helm-dash]] + - [[TODOs][TODOs]] + - [[Check zeal][Check zeal]] + - [[Make helm-dash use zeal or dash docsets by default.][Make helm-dash use zeal or dash docsets by default.]] * Description +*This layer works only on OS X for the moment*+ diff --git a/layers/+tools/evernote/README.org b/layers/+tools/evernote/README.org index 2064a55bd..4bcba8315 100644 --- a/layers/+tools/evernote/README.org +++ b/layers/+tools/evernote/README.org @@ -2,13 +2,13 @@ [[file:img/evernote.png]] with [[file:img/geeknote.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#geeknote][geeknote]] - - [[#geeknoteel][geeknote.el]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[geeknote][geeknote]] + - [[geeknote.el][geeknote.el]] + - [[Key Bindings][Key Bindings]] * Description This layer groups together packages to work with [[https://evernote.com/][Evernote]]. diff --git a/layers/+tools/fasd/README.org b/layers/+tools/fasd/README.org index 3a7ece9c7..d5041f36b 100644 --- a/layers/+tools/fasd/README.org +++ b/layers/+tools/fasd/README.org @@ -1,11 +1,11 @@ #+TITLE: fasd contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#fasd][fasd]] - - [[#keybindings][Keybindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[fasd][fasd]] + - [[Keybindings][Keybindings]] * Description diff --git a/layers/+tools/pandoc/README.org b/layers/+tools/pandoc/README.org index fa0ab3f18..b8b6504fe 100644 --- a/layers/+tools/pandoc/README.org +++ b/layers/+tools/pandoc/README.org @@ -1,12 +1,12 @@ #+TITLE: Pandoc contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#pandoc][Pandoc]] - - [[#usage][Usage]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Pandoc][Pandoc]] + - [[Usage][Usage]] + - [[Key Bindings][Key Bindings]] * Description diff --git a/layers/+tools/ranger/README.org b/layers/+tools/ranger/README.org index 3d5ecb9cc..9345414ca 100644 --- a/layers/+tools/ranger/README.org +++ b/layers/+tools/ranger/README.org @@ -1,13 +1,13 @@ #+TITLE: Ranger contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#configuration][Configuration]] - - [[#customizing][Customizing]] - - [[#parent-options][Parent options]] - - [[#preview-options][Preview options]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Configuration][Configuration]] + - [[Customizing][Customizing]] + - [[Parent options][Parent options]] + - [[Preview options][Preview options]] + - [[Key Bindings][Key Bindings]] * Description @@ -111,27 +111,27 @@ To set the max files size (in MB), set the following parameter: | Key Binding | Description | |-------------+------------------------------------------------------| -| ~SPC a r~ | launch ranger | +| ~SPC a r~ | launch ranger | | SPC a d | deer (minimal ranger window in current directory) | -| ~C-p~ | (ranger) toggle ranger in dired buffer | -| ~j~ | (ranger) navigate down | -| ~k~ | (ranger) navigate up | -| ~C-j~ | (ranger) scroll preview window down | -| ~C-k~ | (ranger) scroll preview window up | -| ~f~ | (ranger) search for file names | -| ~i~ | (ranger) show preview of current file | -| ~zi~ | (ranger) toggle showing literal / full-text previews | -| ~zh~ | (ranger) toggle showing dotfiles | -| ~o~ | (ranger) sort options | -| ~H~ | (ranger) search through history | -| ~h~ | (ranger) go up directory | -| ~l~ | (ranger) find file / enter directory | -| ~RET~ | (ranger) find file / enter directory | -| ~q~ | (ranger) quit | -| ~r~ | (ranger) revert buffer | -| ~z-~ | (ranger) reduce number of parents | -| ~z+~ | (ranger) increment number of parents | -| ~v~ | (ranger) toggle all marks | -| ~V~ | (ranger) visually select lines | -| ~S~ | (ranger) enter shell | -| ~C-SPC~ | (ranger) mark current file | +| ~C-p~ | (ranger) toggle ranger in dired buffer | +| ~j~ | (ranger) navigate down | +| ~k~ | (ranger) navigate up | +| ~C-j~ | (ranger) scroll preview window down | +| ~C-k~ | (ranger) scroll preview window up | +| ~f~ | (ranger) search for file names | +| ~i~ | (ranger) show preview of current file | +| ~zi~ | (ranger) toggle showing literal / full-text previews | +| ~zh~ | (ranger) toggle showing dotfiles | +| ~o~ | (ranger) sort options | +| ~H~ | (ranger) search through history | +| ~h~ | (ranger) go up directory | +| ~l~ | (ranger) find file / enter directory | +| ~RET~ | (ranger) find file / enter directory | +| ~q~ | (ranger) quit | +| ~r~ | (ranger) revert buffer | +| ~z-~ | (ranger) reduce number of parents | +| ~z+~ | (ranger) increment number of parents | +| ~v~ | (ranger) toggle all marks | +| ~V~ | (ranger) visually select lines | +| ~S~ | (ranger) enter shell | +| ~C-SPC~ | (ranger) mark current file | diff --git a/layers/+tools/tmux/README.org b/layers/+tools/tmux/README.org index 33514a0eb..1cca19db1 100644 --- a/layers/+tools/tmux/README.org +++ b/layers/+tools/tmux/README.org @@ -1,10 +1,9 @@ #+TITLE: Tmux contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#what-is-this][What is this]] +* Table of Contents :TOC_4_org:noexport: + - [[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 configuration for tmux, so check the upstream documentation. diff --git a/layers/+tools/vagrant/README.org b/layers/+tools/vagrant/README.org index b004791db..88d2669c5 100644 --- a/layers/+tools/vagrant/README.org +++ b/layers/+tools/vagrant/README.org @@ -2,14 +2,14 @@ [[file:img/vagrant.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#vagrant][Vagrant]] - - [[#testing][Testing]] - - [[#keybindings][Keybindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Vagrant][Vagrant]] + - [[Testing][Testing]] + - [[Keybindings][Keybindings]] * Description diff --git a/layers/+tools/wakatime/README.org b/layers/+tools/wakatime/README.org index 480a4267b..a69d1466f 100644 --- a/layers/+tools/wakatime/README.org +++ b/layers/+tools/wakatime/README.org @@ -2,13 +2,13 @@ [[file:img/wakatime.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#wakatime-program][Wakatime Program]] - - [[#layer][Layer]] - - [[#api-keys][API Keys]] - - [[#note-to-venv-workon-users][Note to =venv-workon= users:]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Wakatime Program][Wakatime Program]] + - [[Layer][Layer]] + - [[API Keys][API Keys]] + - [[Note to =venv-workon= users:][Note to =venv-workon= users:]] * Description This layer adds support for Wakatime. diff --git a/layers/+tools/ycmd/README.org b/layers/+tools/ycmd/README.org index e9d2c1481..668fefce6 100644 --- a/layers/+tools/ycmd/README.org +++ b/layers/+tools/ycmd/README.org @@ -1,13 +1,13 @@ #+TITLE: YCMD contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#ycmd][YCMD]] - - [[#other-requirements][Other Requirements]] - - [[#configuration][Configuration]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[YCMD][YCMD]] + - [[Other Requirements][Other Requirements]] + - [[Configuration][Configuration]] + - [[Key Bindings][Key Bindings]] * Description diff --git a/layers/+vim/evil-commentary/README.org b/layers/+vim/evil-commentary/README.org index c7fadd175..4c000b0f5 100644 --- a/layers/+vim/evil-commentary/README.org +++ b/layers/+vim/evil-commentary/README.org @@ -1,9 +1,9 @@ #+TITLE: Evil-commentary contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description This layer replaces [[https://github.com/redguardtoo/evil-nerd-commenter][evil-nerd-commenter]] with [[https://github.com/linktohack/evil-commentary][evil-commentary]] for those diff --git a/layers/+vim/evil-snipe/README.org b/layers/+vim/evil-snipe/README.org index c5e87b649..b0c2af0de 100644 --- a/layers/+vim/evil-snipe/README.org +++ b/layers/+vim/evil-snipe/README.org @@ -2,15 +2,15 @@ [[file:img/Cat_With_Rifle.jpg]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#improved-f-and-t-search-behavior][Improved f and t search behavior]] - - [[#two-character-search-with-s][Two-character search with s]] - - [[#more-scopes][More scopes]] - - [[#symbol-groups][Symbol groups]] - - [[#todo-key-bindings][TODO Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Improved f and t search behavior][Improved f and t search behavior]] + - [[Two-character search with s][Two-character search with s]] + - [[More scopes][More scopes]] + - [[Symbol groups][Symbol groups]] + - [[Key bindings][Key bindings]] * Description The package [[https://github.com/hlissner/evil-snipe][evil-snipe]] diff --git a/layers/+vim/unimpaired/README.org b/layers/+vim/unimpaired/README.org index 3f9c57beb..c0a703e95 100644 --- a/layers/+vim/unimpaired/README.org +++ b/layers/+vim/unimpaired/README.org @@ -1,8 +1,8 @@ #+TITLE: Unimpaired port contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/+vim/vim-empty-lines/README.org b/layers/+vim/vim-empty-lines/README.org index 5c5b98073..49996e592 100644 --- a/layers/+vim/vim-empty-lines/README.org +++ b/layers/+vim/vim-empty-lines/README.org @@ -1,8 +1,8 @@ #+TITLE: Vim-empty-lines contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description diff --git a/layers/+vim/vim-powerline/README.org b/layers/+vim/vim-powerline/README.org index a743edc38..cfe382ec1 100644 --- a/layers/+vim/vim-powerline/README.org +++ b/layers/+vim/vim-powerline/README.org @@ -1,8 +1,8 @@ #+TITLE: vim-powerline contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] * Description A powerline theme modeled after the vim powerline theme. diff --git a/layers/+vim/vinegar/README.org b/layers/+vim/vinegar/README.org index 01b013101..6783544fc 100644 --- a/layers/+vim/vinegar/README.org +++ b/layers/+vim/vinegar/README.org @@ -1,10 +1,10 @@ #+TITLE: Vinegar contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#mouse-bindings][Mouse bindings]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Mouse bindings][Mouse bindings]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/+window-management/eyebrowse/README.org b/layers/+window-management/eyebrowse/README.org index 2d2353493..b13156e52 100644 --- a/layers/+window-management/eyebrowse/README.org +++ b/layers/+window-management/eyebrowse/README.org @@ -2,15 +2,14 @@ [[file:img/eyebrowse.gif]] [[file:img/i3wm.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#removing-additional-help][Removing additional help]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Removing additional help][Removing additional help]] + - [[Key bindings][Key bindings]] * Description - This layer adds [[https://i3wm.org/][i3wm]] like workspaces thanks to the [[https://github.com/wasamasa/eyebrowse][eyebrowse]] package. Once the layer is activated a new number is added to the right side of the @@ -31,9 +30,7 @@ It is also possible to give a label to a the current workspace by pressing ~r~ in the micro-state. * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -41,7 +38,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC ** Removing additional help - Once you know the key bindings to navigate between the workspaces you may want to disable the exhaustive help in the workspace micro-state. Set the variable =eyebrowse-display-help= to =nil= diff --git a/layers/+window-management/perspectives/README.org b/layers/+window-management/perspectives/README.org index 0d3b47a7f..ccdc0c9f0 100644 --- a/layers/+window-management/perspectives/README.org +++ b/layers/+window-management/perspectives/README.org @@ -1,26 +1,23 @@ #+TITLE: Perspectives contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#custom-perspective-macro][Custom Perspective Macro]] - - [[#predefined-custom-perspectives][Predefined custom perspectives]] - - [[#per-project-custom-perpsective][Per project custom perpsective]] - - [[#org-agenda-custom-perspective][Org-agenda custom perspective]] - - [[#rcirc-custom-perspective][RCIRC custom perspective]] - - [[#key-bindings][Key Bindings]] - - [[#custom-perspectives-key-bindings][Custom Perspectives Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Custom Perspective Macro][Custom Perspective Macro]] + - [[Predefined custom perspectives][Predefined custom perspectives]] + - [[Per project custom perpsective][Per project custom perpsective]] + - [[Org-agenda custom perspective][Org-agenda custom perspective]] + - [[RCIRC custom perspective][RCIRC custom perspective]] + - [[Key Bindings][Key Bindings]] + - [[Custom Perspectives Key Bindings][Custom Perspectives Key Bindings]] * Description - This contrib layer sets up perspective-mode. And also defines custom perspectives with a macro so that you don't have to do more steps. * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -28,7 +25,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC ** Custom Perspective Macro - If you want to add a new custom-persp (for example if you want to have IRC on its own perspective or maybe calendar or gnus) you have to use the macro =custom-persp= as follows: @@ -64,9 +60,7 @@ Then you just need to add a keybinding to your custom persp, we use #+END_SRC * Predefined custom perspectives - *** Per project custom perpsective - As the name suggests, this persp-projectile mode creates a new perspective once you switch to a new project with ~SPC p p~. It must be said that in the current implementation in order for this to work you must first open a @@ -79,7 +73,6 @@ custom-perspective like ~SPC L o e~ to go to the init.el in the spacemacs. #+END_SRC *** Org-agenda custom perspective - Here we define a custom perspective that adds items to your org-agenda. If you do not know what that is check the [[https://www.gnu.org/software/emacs/manual/html_node/org/Agenda-commands.html][docs]]. @@ -88,7 +81,6 @@ with one simple command you can gather all the todos from all the agenda files you have and show them in a single buffer. (in evil the command starts with ~;a~) *** RCIRC custom perspective - Now you can also open rcirc in a new layer to keep all the chat buffers in one perspective isolated from your work buffers. @@ -100,7 +92,6 @@ You will have to use the perspective layer as well as the rcirc layer: #+END_SRC * Key Bindings - Prefix command for perspective commands is ~SPC L~ (for Layout). | Key Binding | Description | diff --git a/layers/auto-completion/README.org b/layers/auto-completion/README.org index 40df06563..a1473364c 100644 --- a/layers/auto-completion/README.org +++ b/layers/auto-completion/README.org @@ -1,26 +1,25 @@ -#+TITLE: Auto-Completion configuration layer for Spacemacs +#+TITLE: Auto-completion layer -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#configuration][Configuration]] - - [[#key-bindings][Key bindings]] - - [[#tooltips][Tooltips]] - - [[#sort-results-by-usage][Sort results by usage]] - - [[#show-snippets-in-auto-completion-popup][Show snippets in auto-completion popup]] - - [[#enable-company-or-auto-complete-globally][Enable company or auto-complete globally]] - - [[#replacing-company-by-auto-complete][Replacing company by auto-complete]] - - [[#add-auto-completion-in-a-layer][Add auto-completion in a layer]] - - [[#in-configel][In =config.el=]] - - [[#in-packagesel][In =packages.el=]] - - [[#key-bindings][Key Bindings]] - - [[#company][Company]] - - [[#auto-complete][Auto-complete]] - - [[#yasnippet][Yasnippet]] - - [[#auto-yasnippet][Auto-yasnippet]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Configuration][Configuration]] + - [[Key bindings][Key bindings]] + - [[Tooltips][Tooltips]] + - [[Sort results by usage][Sort results by usage]] + - [[Show snippets in auto-completion popup][Show snippets in auto-completion popup]] + - [[Enable company or auto-complete globally][Enable company or auto-complete globally]] + - [[Replacing company by auto-complete][Replacing company by auto-complete]] + - [[Add auto-completion in a layer][Add auto-completion in a layer]] + - [[In =config.el=][In =config.el=]] + - [[In =packages.el=][In =packages.el=]] + - [[Key Bindings][Key Bindings]] + - [[Company][Company]] + - [[Auto-complete][Auto-complete]] + - [[Yasnippet][Yasnippet]] + - [[Auto-yasnippet][Auto-yasnippet]] * Description - This layer provides auto-completion to Spacemacs. The following completion engines are supported: @@ -32,7 +31,6 @@ Snippets are supported via [[https://github.com/capitaomorte/yasnippet][yasnippe This layer also configures =hippie-expand=. * Install - To use this configuration layer add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -40,9 +38,7 @@ To use this configuration layer add it to your =~/.spacemacs= #+END_SRC * Configuration - ** Key bindings - You can customize the user experience of auto-completion with the following layer variables: @@ -81,7 +77,6 @@ The default configuration of the layer is: you don't use it already. ** Tooltips - To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t= #+BEGIN_SRC emacs-lisp @@ -91,7 +86,6 @@ To enable docstring tooltips set =auto-completion-enable-help-tooltip= to =t= #+END_SRC ** Sort results by usage - To enable sorting auto-completion results by their usage frequency set =auto-completion-enable-sort-by-usage= to =t=. This feature is provided by the [[https://github.com/company-mode/company-statistics][company-statistics]] package when =company= @@ -105,7 +99,6 @@ The variable has no effect when =auto-complete= is used. #+END_SRC ** Show snippets in auto-completion popup - By default, snippets are not shown in the auto-completion popup. To show them in the popup, set the variable =auto-completion-enable-snippets-in-popup= to =t=. @@ -116,7 +109,6 @@ the popup, set the variable =auto-completion-enable-snippets-in-popup= to =t=. #+END_SRC ** Enable company or auto-complete globally - By default Spacemacs enables auto-completion explicitly for each supported major-mode, it means that =company= and =auto-complete= are not enabled globally, it allows more flexibility to choose an auto-completion engine @@ -131,23 +123,19 @@ Note that if you want to enable =auto-complete= globally you will have to disable =company= first, see the next section to do so. ** Replacing company by auto-complete - You can disable =company= by adding it to the =dotspacemacs-excluded-packages= variable, then you are free to enable =auto-complete= globally. ** Add auto-completion in a layer - Here is an example to add =company= auto-completion to python buffer: *** In =config.el= - #+BEGIN_SRC emacs-lisp ;; Define the buffer local company backend variable (spacemacs|defvar-company-backends python-mode) #+END_SRC *** In =packages.el= - #+BEGIN_SRC emacs-lisp ;; Add the relevant packages to the layer (setq python-packages @@ -172,7 +160,6 @@ Here is an example to add =company= auto-completion to python buffer: #+END_SRC * Key Bindings - ** Company | Key Binding | Description | diff --git a/layers/better-defaults/README.org b/layers/better-defaults/README.org index 8b6232a96..fc5dbf00c 100644 --- a/layers/better-defaults/README.org +++ b/layers/better-defaults/README.org @@ -1,17 +1,16 @@ -#+TITLE: Better Defaults contribution layer for Spacemacs +#+TITLE: Better Defaults layer [[file:img/emacs.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#functions][Functions]] - - [[#spacemacssmart-move-beginning-of-line][spacemacs/smart-move-beginning-of-line]] - - [[#spacemacsbackward-kill-word-or-region][spacemacs/backward-kill-word-or-region]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Functions][Functions]] + - [[=spacemacs/smart-move-beginning-of-line=][=spacemacs/smart-move-beginning-of-line=]] + - [[=spacemacs/backward-kill-word-or-region=][=spacemacs/backward-kill-word-or-region=]] + - [[Key bindings][Key bindings]] * Description - This layer enhances the default commands of Emacs and is primarily intended to be used with the =emacs= editing style as it does not change anything in the Vim key bindings. @@ -23,7 +22,6 @@ style. The commands defined in this layer are taken from various sources like [[https://github.com/bbatsov/prelude][Prelude]]. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -31,14 +29,11 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC * Functions - -** spacemacs/smart-move-beginning-of-line - +** =spacemacs/smart-move-beginning-of-line= Pressed one time, go to the first non-whitespace character of the line, pressed again, go to the beginning of the line. -** spacemacs/backward-kill-word-or-region - +** =spacemacs/backward-kill-word-or-region= A combination of =kill-region= and =backward-kill-word=, depending on whether there is an active region. If there's an active region kill that. If not kill the preceding word. diff --git a/layers/chinese/README.org b/layers/chinese/README.org index 393e3615f..798de2939 100644 --- a/layers/chinese/README.org +++ b/layers/chinese/README.org @@ -2,18 +2,18 @@ [[file:img/China.png]] [[file:img/Chinese.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#configure-the-default-input-method配置默认中文输入法][Configure the Default Input Method(配置默认中文输入法)]] - - [[#configure-the-chinese-pyim-input-method配置中文拼音输入法][Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)]] - - [[#enable-youdao有道-dictionary激活有道字典][Enable YouDao(有道) Dictionary(激活有道字典)]] - - [[#set-monospaced-font-size设置等宽字体）][Set monospaced font size(设置等宽字体）]] - - [[#key-bindings][Key Bindings]] - - [[#youdao-dictionary][Youdao Dictionary]] - - [[#find-by-pinyin-dired][Find-by-pinyin-dired]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Configuration][Configuration]] + - [[Configure the Default Input Method(配置默认中文输入法)][Configure the Default Input Method(配置默认中文输入法)]] + - [[Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)][Configure the =Chinese-pyim= Input Method(配置中文拼音输入法)]] + - [[Enable YouDao(有道) Dictionary(激活有道字典)][Enable YouDao(有道) Dictionary(激活有道字典)]] + - [[Set monospaced font size(设置等宽字体）][Set monospaced font size(设置等宽字体）]] + - [[Key Bindings][Key Bindings]] + - [[Youdao Dictionary][Youdao Dictionary]] + - [[Find-by-pinyin-dired][Find-by-pinyin-dired]] * Description This Layer adds Chinese related packages: diff --git a/layers/chrome/README.org b/layers/chrome/README.org index f47ed9196..466515c07 100644 --- a/layers/chrome/README.org +++ b/layers/chrome/README.org @@ -2,13 +2,13 @@ [[file:img/chrome.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#feature][Feature:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#chrome-extension][Chrome extension]] - - [[#configuration][Configuration]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Feature:][Feature:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Chrome extension][Chrome extension]] + - [[Configuration][Configuration]] * Description diff --git a/layers/colors/README.org b/layers/colors/README.org index e7e690c42..e2dc27327 100644 --- a/layers/colors/README.org +++ b/layers/colors/README.org @@ -2,15 +2,15 @@ [[file:img/rainbow_dash.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#enable-rainbow-identifiers][Enable rainbow-identifiers]] - - [[#enable-nyan-cat][Enable Nyan cat]] - - [[#key-bindings][Key bindings]] - - [[#rainbow-identifiers][Rainbow Identifiers]] - - [[#rainbow-mode][Rainbow Mode]] - - [[#nyan-mode][Nyan Mode]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Enable rainbow-identifiers][Enable rainbow-identifiers]] + - [[Enable Nyan cat][Enable Nyan cat]] + - [[Key bindings][Key bindings]] + - [[Rainbow Identifiers][Rainbow Identifiers]] + - [[Rainbow Mode][Rainbow Mode]] + - [[Nyan Mode][Nyan Mode]] * Description diff --git a/layers/cscope/README.org b/layers/cscope/README.org index 51927ae9a..0ee27429d 100644 --- a/layers/cscope/README.org +++ b/layers/cscope/README.org @@ -2,14 +2,14 @@ [[file:img/cscope.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#cscope][Cscope]] - - [[#pycscope][PyCscope]] - - [[#usage][Usage]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Cscope][Cscope]] + - [[PyCscope][PyCscope]] + - [[Usage][Usage]] + - [[Key bindings][Key bindings]] * Description This layer provides bindings for using [[http://cscope.sourceforge.net][Cscope]] and [[https://github.com/portante/pycscope][PyCscope]] in Spacemacs. @@ -54,7 +54,6 @@ pip install pycscope #+END_SRC * Usage - Before using any helm-cscope commands, remember to create a Cscope index file. Do it by running the command =cscope-index-files= for C and C++ projects, or the command =cscope/run-pycscope= for Python projects, bound to ~SPC m g i~. diff --git a/layers/deft/README.org b/layers/deft/README.org index 1371144f3..d0fd9b764 100644 --- a/layers/deft/README.org +++ b/layers/deft/README.org @@ -1,12 +1,12 @@ #+TITLE: Deft configuration layer for Spacemacs -* Table of Content :TOC@4: - - [[#description][Description]] - - [[#differences-from-default][Differences from default]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#key-bindings][Key Bindings]] +* Table of Content :TOC_4_org:noexport: + - [[Description][Description]] + - [[Differences from default][Differences from default]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Configuration][Configuration]] + - [[Key Bindings][Key Bindings]] * Description diff --git a/layers/finance/README.org b/layers/finance/README.org index ad642c157..c2d8daf97 100644 --- a/layers/finance/README.org +++ b/layers/finance/README.org @@ -1,13 +1,13 @@ #+TITLE: Finance contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#configuration][Configuration]] - - [[#ledger][Ledger]] - - [[#key-bindings][Key bindings]] - - [[#ledger][Ledger]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Configuration][Configuration]] + - [[Ledger][Ledger]] + - [[Key bindings][Key bindings]] + - [[Ledger][Ledger]] * Description diff --git a/layers/floobits/README.org b/layers/floobits/README.org index c919ee4ca..16af8d29f 100644 --- a/layers/floobits/README.org +++ b/layers/floobits/README.org @@ -2,20 +2,17 @@ [[file:img/floobits.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Key Bindings][Key Bindings]] * Description - This layer adds support for peer programming tool [[https://github.com/Floobits/floobits-emacs][floobits]]. * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp diff --git a/layers/geolocation/README.org b/layers/geolocation/README.org index 9fbfa74a9..f203c4536 100644 --- a/layers/geolocation/README.org +++ b/layers/geolocation/README.org @@ -1,16 +1,16 @@ #+TITLE: Geolocation contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#supported-packages-in-this-layer][Supported packages in this layer]] - - [[#install][Install]] - - [[#configuration][Configuration]] - - [[#location][Location]] - - [[#theme-changer][theme-changer]] - - [[#sunshine-weather-forecast][sunshine (weather forecast)]] - - [[#osx-location][osx-location]] - - [[#key-bindings][Key Bindings]] - - [[#weather][Weather]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Supported packages in this layer][Supported packages in this layer]] + - [[Install][Install]] + - [[Configuration][Configuration]] + - [[Location][Location]] + - [[theme-changer][theme-changer]] + - [[sunshine (weather forecast)][sunshine (weather forecast)]] + - [[osx-location][osx-location]] + - [[Key Bindings][Key Bindings]] + - [[Weather][Weather]] * Description This layer offers few location sensitive adjustment to Emacs, such as diff --git a/layers/gtags/README.org b/layers/gtags/README.org index d0697b982..01656cb23 100644 --- a/layers/gtags/README.org +++ b/layers/gtags/README.org @@ -1,13 +1,13 @@ #+TITLE: Helm Gtags contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features]] - - [[#install][Install]] - - [[#gnu-global][GNU Global]] - - [[#usage][Usage]] - - [[#eldoc-integration][Eldoc integration]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features][Features]] + - [[Install][Install]] + - [[GNU Global][GNU Global]] + - [[Usage][Usage]] + - [[Eldoc integration][Eldoc integration]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/ibuffer/README.org b/layers/ibuffer/README.org index 939a3ba2f..567ef5608 100644 --- a/layers/ibuffer/README.org +++ b/layers/ibuffer/README.org @@ -1,11 +1,11 @@ #+TITLE: ibuffer contribution layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#grouping-buffers][Grouping buffers]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Grouping buffers][Grouping buffers]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/jabber/README.org b/layers/jabber/README.org index 74a89c147..225aa2963 100644 --- a/layers/jabber/README.org +++ b/layers/jabber/README.org @@ -2,14 +2,14 @@ [[file:img/jabber-logo.gif]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] - - [[#jabber-roster][Jabber Roster]] - - [[#hipchat][HipChat]] - - [[#authentication][Authentication]] - - [[#joining-rooms][Joining rooms]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] + - [[Jabber Roster][Jabber Roster]] + - [[HipChat][HipChat]] + - [[Authentication][Authentication]] + - [[Joining rooms][Joining rooms]] * Description This layer adds keybindings for jabber.el. jabber.el is a Jabber (XMPP) client for Emacs diff --git a/layers/nixos/README.org b/layers/nixos/README.org index 436ee487c..83600228e 100644 --- a/layers/nixos/README.org +++ b/layers/nixos/README.org @@ -2,13 +2,13 @@ [[file:img/nixos.jpg]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#key-bindings][Key Bindings]] - - [[#nixos-options][NixOS Options]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Key Bindings][Key Bindings]] + - [[NixOS Options][NixOS Options]] * Description diff --git a/layers/org/README.org b/layers/org/README.org index 78d6d80fa..020706060 100644 --- a/layers/org/README.org +++ b/layers/org/README.org @@ -2,31 +2,30 @@ [[file:img/org.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#features][Features:]] - - [[#note][Note]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#github-support][Github support]] - - [[#gnuplot-support][Gnuplot support]] - - [[#different-bullets][Different bullets]] - - [[#key-bindings][Key bindings]] - - [[#org][Org]] - - [[#org-with-evil-org-mode][Org with evil-org-mode]] - - [[#tables][Tables]] - - [[#tree-][Tree ]] - - [[#element-insertion][Element insertion]] - - [[#links][Links]] - - [[#emphasis][Emphasis]] - - [[#tagging][Tagging]] - - [[#pomodoro][Pomodoro]] - - [[#presentation][Presentation]] - - [[#org-repo-todo][Org-repo-todo]] - - [[#org-mime][Org-MIME]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Features:][Features:]] + - [[Note][Note]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Github support][Github support]] + - [[Gnuplot support][Gnuplot support]] + - [[Different bullets][Different bullets]] + - [[Key bindings][Key bindings]] + - [[Org][Org]] + - [[Org with evil-org-mode][Org with evil-org-mode]] + - [[Tables][Tables]] + - [[Tree ][Tree ]] + - [[Element insertion][Element insertion]] + - [[Links][Links]] + - [[Emphasis][Emphasis]] + - [[Tagging][Tagging]] + - [[Pomodoro][Pomodoro]] + - [[Presentation][Presentation]] + - [[Org-repo-todo][Org-repo-todo]] + - [[Org-MIME][Org-MIME]] * Description - This layer enables [[http://orgmode.org/][org mode]] for Spacemacs. ** Features: @@ -78,6 +77,7 @@ You can tweak the bullets displayed in the org buffer in the function * Key bindings ** Org + | Key Binding | Description | |-------------+--------------------------------| | ~SPC a o #~ | org agenda list stuck projects | @@ -96,6 +96,7 @@ You can tweak the bullets displayed in the org buffer in the function | ~SPC C T~ | ort/capture-checkitem | ** Org with evil-org-mode + | Key Binding | Description | |----------------------------------------------+----------------------------------------------| | ~SPC m '~ | org-edit-special | @@ -129,6 +130,7 @@ You can tweak the bullets displayed in the org buffer in the function | ~SPC s l~ | spacemacs/jump-in-buffer (jump to a heading) | *** Tables + | Key Binding | Description | |---------------+----------------------------------------------------------------------------| | ~SPC m t a~ | Align the table at point by aligning all vertical bars | @@ -160,6 +162,7 @@ You can tweak the bullets displayed in the org buffer in the function | ~SPC m t w~ | Wrap several fields in a column like a paragraph | *** Tree + | Key Binding | Description | |-------------+-----------------------| | ~SPC m S l~ | org-demote-subtree | @@ -199,6 +202,7 @@ You can tweak the bullets displayed in the org buffer in the function | ~M-t~ | org-insert-todo-heading nil+ org-metaright | *** Element insertion + | Key Binding | Description | |-------------+----------------------------------| | ~SPC m h i~ | org-insert-heading-after-current | @@ -207,11 +211,13 @@ You can tweak the bullets displayed in the org buffer in the function | ~SPC m i l~ | org-insert-link | *** Links + | Key Binding | Description | |-------------+-------------------| | ~RET~ | org-open-at-point | *** Emphasis + | Key Binding | Description | |-------------+----------------------------| | ~SPC m x b~ | make region bold | @@ -223,11 +229,13 @@ You can tweak the bullets displayed in the org buffer in the function | ~SPC m x v~ | make region verbose | *** Tagging + | Key Binding | Description | |-------------+--------------| | ~SPC m :~ | org-set-tags | ** Pomodoro + | Key Binding | Description | |-------------+-------------------| | ~SPC m p~ | starts a pomodoro | @@ -242,11 +250,13 @@ org-present must be activated explicitly by typing: ~SPC : org-present~ | ~q~ | quit | ** Org-repo-todo + | Key Binding | Description | |-------------+----------------| | ~SPC m g t~ | ort/goto-todos | ** Org-MIME + | Key Binding | Description | |-------------+---------------------------------------------------| | ~SPC m M~ | in =message-mode= buffers convert into html email | diff --git a/layers/osx/README.org b/layers/osx/README.org index a62bddc94..4f5c1947b 100644 --- a/layers/osx/README.org +++ b/layers/osx/README.org @@ -2,14 +2,15 @@ [[file:img/apple.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#philosophy][Philosophy]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#coreutils][Coreutils]] - - [[#key-bindings][Key Bindings]] - - [[#future-work][Future Work]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Philosophy][Philosophy]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Use with non-US keyboard layouts][Use with non-US keyboard layouts]] + - [[Coreutils][Coreutils]] + - [[Key Bindings][Key Bindings]] + - [[Future Work][Future Work]] * Description diff --git a/layers/prodigy/README.org b/layers/prodigy/README.org index 5c4973ebf..e6a21b86f 100644 --- a/layers/prodigy/README.org +++ b/layers/prodigy/README.org @@ -2,12 +2,12 @@ [[file:img/prodigy.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#spawn-prodigy][Spawn prodigy]] - - [[#navigate-through-it][Navigate through it]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Spawn prodigy][Spawn prodigy]] + - [[Navigate through it][Navigate through it]] * Description diff --git a/layers/restclient/README.org b/layers/restclient/README.org index 99ea746a8..e264df645 100644 --- a/layers/restclient/README.org +++ b/layers/restclient/README.org @@ -1,8 +1,8 @@ #+TITLE: Restclient contribution layer -* Table of Contents :TOC@4: - - [[#what-is-this][What is this?]] - - [[#keybindings][Keybindings]] +* Table of Contents :TOC_4_org:noexport: + - [[What is this?][What is this?]] + - [[Keybindings][Keybindings]] * What is this? This is a package that lets you have a REPL-like interface diff --git a/layers/search-engine/README.org b/layers/search-engine/README.org index 64d3f9f6c..305d157bd 100644 --- a/layers/search-engine/README.org +++ b/layers/search-engine/README.org @@ -2,12 +2,12 @@ [[file:img/searchengine.jpg]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#supported-search-engines][Supported search engines]] - - [[#install][Install]] - - [[#key-bindings][Key Bindings]] - - [[#customize-it][Customize it!]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Supported search engines][Supported search engines]] + - [[Install][Install]] + - [[Key Bindings][Key Bindings]] + - [[Customize it!][Customize it!]] * Description diff --git a/layers/shell/README.org b/layers/shell/README.org index 022b29a45..3835cd96d 100644 --- a/layers/shell/README.org +++ b/layers/shell/README.org @@ -2,28 +2,25 @@ [[file:img/shell.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#default-shell][Default shell]] - - [[#default-shell-position-and-height][Default shell position and height]] - - [[#set-shell-for-term-and-ansi-term][Set shell for term and ansi-term]] - - [[#enable-em-smart-in-eshell][Enable em-smart in Eshell]] - - [[#protect-your-eshell-prompt][Protect your Eshell prompt]] - - [[#eshell][Eshell]] - - [[#key-bindings][Key bindings]] - - [[#multi-term][Multi-term]] - - [[#eshell][Eshell]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Default shell][Default shell]] + - [[Default shell position and height][Default shell position and height]] + - [[Set shell for term and ansi-term][Set shell for term and ansi-term]] + - [[Enable em-smart in Eshell][Enable em-smart in Eshell]] + - [[Protect your Eshell prompt][Protect your Eshell prompt]] + - [[Eshell][Eshell]] + - [[Key bindings][Key bindings]] + - [[Multi-term][Multi-term]] + - [[Eshell][Eshell]] * Description - This layer configures the various shells available in Emacs. * Install - ** Layer - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp @@ -31,7 +28,6 @@ To use this contribution add it to your =~/.spacemacs= #+END_SRC ** Default shell - Emacs supports three types of shell: - the Emacs shell - the inferior shell @@ -56,7 +52,6 @@ to the following variables: The default shell is quickly accessible via a the default shortcut key ~SPC '~. ** Default shell position and height - It is possible to choose where the shell should pop up by setting the variable =shell-default-position= to either =top=, =bottom= or =full=. It is not possible to show it on the side for now. Default value is =bottom=. It is also possible @@ -71,7 +66,6 @@ Default value is =30=. #+END_SRC ** Set shell for term and ansi-term - The default shell can be set by setting the variable =shell-default-term-shell=. Default value is =/bin/bash=. @@ -81,7 +75,6 @@ Default value is =/bin/bash=. #+END_SRC ** Enable em-smart in Eshell - From the =em-smart= documentation: #+BEGIN_QUOTE @@ -106,7 +99,6 @@ To enable =em-smart= put the following layer variable to non-nil: #+END_SRC ** Protect your Eshell prompt - Comint mode (Shell mode) has good support for Evil mode as it inhibits movement commands over the prompt. This has the added benefit that Evil mode functions work sensibly. E.g. you can press ~cc~ in normal state i.e. @@ -123,7 +115,6 @@ to nil. #+END_SRC * Eshell - Some advanced configuration is setup for =eshell= in this layer: - some elisp functions aliases for quick access - =s= for =magit-status= in the current directory (when the =git= layer is diff --git a/layers/smex/README.org b/layers/smex/README.org index 8d78e21c8..b3b939b6b 100644 --- a/layers/smex/README.org +++ b/layers/smex/README.org @@ -2,19 +2,17 @@ [[file:img/smex.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description - This layer replaces =helm-M-x= by [[https://github.com/nonsequitur/smex][smex]] which is built on top of =ido=. =ido= can perform flex matching with the [[https://github.com/lewang/flx][flx-ido]] mode which is already activated in the Spacemacs layer. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp diff --git a/layers/spell-checking/README.org b/layers/spell-checking/README.org index affdd0d65..bf615be77 100644 --- a/layers/spell-checking/README.org +++ b/layers/spell-checking/README.org @@ -1,12 +1,12 @@ #+TITLE: Spell Checking configuration layer for Spacemacs -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#spell-checker-configuration][Spell Checker Configuration]] - - [[#disabling-by-default][Disabling by default]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Spell Checker Configuration][Spell Checker Configuration]] + - [[Disabling by default][Disabling by default]] + - [[Key Bindings][Key Bindings]] * Description This layer provides spell checking using [[http://www-sop.inria.fr/members/Manuel.Serrano/flyspell/flyspell.html][Flyspell]] and =[[https://github.com/nschum/auto-dictionary-mode][auto-dictionary-mode]]=. diff --git a/layers/spotify/README.org b/layers/spotify/README.org index b4c79f28f..934dcb280 100644 --- a/layers/spotify/README.org +++ b/layers/spotify/README.org @@ -2,10 +2,10 @@ [[file:img/spotify.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#key-bindings][Key bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Key bindings][Key bindings]] * Description diff --git a/layers/syntax-checking/README.org b/layers/syntax-checking/README.org index 53cec486a..64eb8558a 100644 --- a/layers/syntax-checking/README.org +++ b/layers/syntax-checking/README.org @@ -1,14 +1,14 @@ -#+TITLE: Syntax Checking configuration layer for Spacemacs +#+TITLE: Syntax Checking layer [[file:img/flycheck.png]] -* Table of Contents :TOC@4: - - [[#description][Description]] - - [[#install][Install]] - - [[#layer][Layer]] - - [[#enablingdisabling-tooltips][Enabling/Disabling tooltips]] - - [[#disabling-by-default][Disabling by default]] - - [[#key-bindings][Key Bindings]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Layer][Layer]] + - [[Enabling/Disabling tooltips][Enabling/Disabling tooltips]] + - [[Disabling by default][Disabling by default]] + - [[Key Bindings][Key Bindings]] * Description This layer provides on the fly syntax checking using [[http://www.flycheck.org/][Flycheck]]. diff --git a/layers/themes-megapack/README.org b/layers/themes-megapack/README.org index ac56c1c35..f2769a4b9 100644 --- a/layers/themes-megapack/README.org +++ b/layers/themes-megapack/README.org @@ -1,18 +1,16 @@ -#+TITLE: Themes Megapack contribution layer for Spacemacs +#+TITLE: Themes Megapack layer -* Table of Contents :TOC@4: - - [[#what-is-this][What is this?]] - - [[#install][Install]] +* Table of Contents :TOC_4_org:noexport: + - [[What is this?][What is this?]] + - [[Install][Install]] * What is this? - This simple contribution layer is an example. It installs around 100 themes for Emacs. You can try them easily by invoking helm-themes with: ~ T h~. You can see samples of all included themes in this [[http://themegallery.robdor.com][theme gallery]] from [[http://www.twitter.com/robmerrell][Rob Merrell]]. * Install - To use this contribution add it to your =~/.spacemacs= #+BEGIN_SRC emacs-lisp diff --git a/layers/theming/README.org b/layers/theming/README.org index 06ee07e2a..7cb172201 100644 --- a/layers/theming/README.org +++ b/layers/theming/README.org @@ -1,25 +1,24 @@ -* Theming contribution layer for Spacemacs +#+TITLE: Theming layer -** Table of Contents :TOC@4: - - [[#theming-contribution-layer-for-spacemacs][Theming contribution layer for Spacemacs]] - - [[#description][Description]] - - [[#install][Install]] - - [[#usage][Usage]] - - [[#attributes][Attributes]] - - [[#faces][Faces]] - - [[#headers][Headers]] +* Table of Contents :TOC_4_org:noexport: + - [[Description][Description]] + - [[Install][Install]] + - [[Usage][Usage]] + - [[Attributes][Attributes]] + - [[Faces][Faces]] + - [[Headers][Headers]] -** Description +* Description This layer allows for a simple way of modifying themes. -** Install +* Install To use this contribution add it to your =~/.spacemacs= #+begin_src emacs-lisp (setq-default dotspacemacs-configuration-layers '(theming)) #+end_src -** Usage +* Usage To use this layer, set the value of =theming-modifications=. It should be a list of the following form: @@ -37,7 +36,7 @@ This will apply the given attributes to the relevant faces whenever the appropriate theme is loaded. To update without changing the theme, use ~SPC : spacemacs/update-theme~. -** Attributes +* Attributes See [[http://www.gnu.org/software/emacs/manual/html_node/elisp/Face-Attributes.html#Face-Attributes][face attributes]] in the Emacs manual for more information. Some of the more common attributes you might want to tweak are the following: @@ -50,7 +49,7 @@ common attributes you might want to tweak are the following: - =:slant= :: typically =oblique=, =italic= or =normal= - =:box= :: set to =t= to draw a box around characters in the foreground -** Faces +* Faces To see a list over all loaded faces and what they look like, use ~SPC : list-faces-display~. You can also use ~SPC h d c~ (describe character) on a character to see its face. @@ -77,7 +76,7 @@ As well as the mode-line faces for the active and inactive windows: - =mode-line= - =mode-line-inactive= -** Headers +* Headers This layer includes three additional layer variables for tweaking headings. Allowed values are a list of themes in which the given effect should happen, or the symbol =all= to apply it on all themes.