Update docs for which-key
This commit is contained in:
justbur
syl20bnr
parent
93d227b73f
commit
d1bb779340
|
|
@ -25,7 +25,8 @@
|
|||
(thanks to nashamri)
|
||||
- Add support for dotdirectory =~/.spacemacs.d= which behaves like the Emacs
|
||||
dotdirectory (i.e. =~/.spacemacs.d/init.el= is evaluated instead of
|
||||
=~/.spacemacs= (thanks to justbur)
|
||||
=~/.spacemacs= if the former exists and the latter does not) (thanks to
|
||||
justbur)
|
||||
- Guide-key is replaced by =which-key= which is now the preferred live help
|
||||
package for key bindings (thanks to justbur)
|
||||
- Whole new API to manage the =powerline= mode-line. It is now possible to
|
||||
|
|
|
|||
|
|
@ -455,7 +455,7 @@ function of a package.
|
|||
|
||||
## Key bindings discovery
|
||||
|
||||
Thanks to [guide-key][], whenever a prefix command is pressed (like `SPC`)
|
||||
Thanks to [which-key][], whenever a prefix command is pressed (like `SPC`)
|
||||
a buffer appears after one second listing the possible keys for this prefix.
|
||||
|
||||
It is also possible to search for specific key bindings by pressing:
|
||||
|
|
@ -598,8 +598,7 @@ details.
|
|||
[dotfile template]: ./core/templates/.spacemacs.template
|
||||
[install OSX section]: https://github.com/syl20bnr/spacemacs#os-x
|
||||
[osx layer]: contrib/osx/README.org
|
||||
[guide-key]: https://github.com/kai2nenobu/guide-key
|
||||
[guide-key-tip]: https://github.com/aki2o/guide-key-tip
|
||||
[which-key]: https://github.com/justbur/emacs-which-key
|
||||
[evil-nerd-commenter]: https://github.com/redguardtoo/evil-nerd-commenter
|
||||
[Gitter Chat]: https://gitter.im/syl20bnr/spacemacs
|
||||
[Gitter Chat IRC server]: https://irc.gitter.im/
|
||||
|
|
|
|||
|
|
@ -1,168 +1,168 @@
|
|||
* Spacemacs Documentation :TOC@4:
|
||||
- [[#core-pillars][Core Pillars]]
|
||||
- [[#mnemonic][Mnemonic]]
|
||||
- [[#discoverability][Discoverability]]
|
||||
- [[#consistency][Consistency]]
|
||||
- [[#crowd-configured][Crowd-Configured]]
|
||||
- [[#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]]
|
||||
- [[#update-packages][Update packages]]
|
||||
- [[#update-spacemacs-repository][Update Spacemacs repository]]
|
||||
- [[#update-packages][Update packages]]
|
||||
- [[#configuration-layers][Configuration layers]]
|
||||
- [[#structure][Structure]]
|
||||
- [[#extensions-and-packages][Extensions and 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]]
|
||||
- [[#structure][Structure]]
|
||||
- [[#extensions-and-packages][Extensions and 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]]
|
||||
- [[#dotfile-configuration][Dotfile Configuration]]
|
||||
- [[#installation][Installation]]
|
||||
- [[#synchronization-of-dotfile-changes][Synchronization of dotfile changes]]
|
||||
- [[#content][Content]]
|
||||
- [[#using-configuration-layers][Using configuration layers]]
|
||||
- [[#setting-configuration-layers-variables][Setting configuration layers variables]]
|
||||
- [[#excluding-packages][Excluding packages]]
|
||||
- [[#hooks][Hooks]]
|
||||
- [[#custom-variables][Custom variables]]
|
||||
- [[#installation][Installation]]
|
||||
- [[#synchronization-of-dotfile-changes][Synchronization of dotfile changes]]
|
||||
- [[#content][Content]]
|
||||
- [[#using-configuration-layers][Using configuration layers]]
|
||||
- [[#setting-configuration-layers-variables][Setting configuration layers variables]]
|
||||
- [[#excluding-packages][Excluding packages]]
|
||||
- [[#hooks][Hooks]]
|
||||
- [[#custom-variables][Custom variables]]
|
||||
- [[#main-principles][Main principles]]
|
||||
- [[#evil][Evil]]
|
||||
- [[#holy][Holy]]
|
||||
- [[#states][States]]
|
||||
- [[#evil-leader][Evil leader]]
|
||||
- [[#universal-argument][Universal argument]]
|
||||
- [[#micro-states][Micro-states]]
|
||||
- [[#evil][Evil]]
|
||||
- [[#holy][Holy]]
|
||||
- [[#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]]
|
||||
- [[#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]]
|
||||
- [[#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]]
|
||||
- [[#graphical-ui][Graphical UI]]
|
||||
- [[#color-themes][Color themes]]
|
||||
- [[#font][Font]]
|
||||
- [[#graphical-ui-toggles][Graphical UI Toggles]]
|
||||
- [[#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]]
|
||||
- [[#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]]
|
||||
- [[#reserved-prefix-command-for-user][Reserved prefix command for user]]
|
||||
- [[#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]]
|
||||
- [[#reserved-prefix-command-for-user][Reserved prefix command for user]]
|
||||
- [[#helm][Helm]]
|
||||
- [[#c-z-and-tab-switch][C-z and Tab switch]]
|
||||
- [[#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-manipulation-micro-state][Buffers manipulation manipulation micro-state]]
|
||||
- [[#special-buffers][Special Buffers]]
|
||||
- [[#files-manipulations-key-bindings][Files manipulations key bindings]]
|
||||
- [[#emacs-and-spacemacs-files][Emacs and Spacemacs files]]
|
||||
- [[#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-for-files-in-an-arbitrary-directory][Searching for 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]]
|
||||
- [[#c-z-and-tab-switch][C-z and Tab switch]]
|
||||
- [[#helm-micro-state][Helm micro-state]]
|
||||
- [[#discovering][Discovering]]
|
||||
- [[#key-bindings][Key bindings]]
|
||||
- [[#guide-key][Guide-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-manipulation-micro-state][Buffers manipulation manipulation micro-state]]
|
||||
- [[#special-buffers][Special Buffers]]
|
||||
- [[#files-manipulations-key-bindings][Files manipulations key bindings]]
|
||||
- [[#emacs-and-spacemacs-files][Emacs and Spacemacs files]]
|
||||
- [[#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-for-files-in-an-arbitrary-directory][Searching for 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]]
|
||||
- [[#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]]
|
||||
- [[#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
|
||||
|
|
@ -182,7 +182,7 @@ useful feedbacks and easily perform maintenance tasks.
|
|||
It also comes with dedicated [[https://github.com/emacs-helm/helm][helm]] sources to quickly find layers, packages and
|
||||
more.
|
||||
|
||||
[[https://github.com/kai2nenobu/guide-key][guide-key]] is enabled by default, it will display all the available key bindings
|
||||
[[https://github.com/justbur/emacs-which-key][which-key]] is enabled by default, it will display all the available key bindings
|
||||
in a dedicated popup buffer.
|
||||
|
||||
** Consistency
|
||||
|
|
@ -644,7 +644,7 @@ your =~/.spacemacs=):
|
|||
enjoyable:
|
||||
- dedicated startup page with a mode aimed at easily managing =Spacemacs=
|
||||
- dedicated helm source via =helm-spacemacs=
|
||||
- a [[https://github.com/kai2nenobu/guide-key][guide-key]] buffer
|
||||
- a [[https://github.com/justbur/emacs-which-key][which-key]] buffer
|
||||
|
||||
** Graphical UI
|
||||
=Spacemacs= has a minimalistic and distraction free graphical UI:
|
||||
|
|
@ -919,12 +919,12 @@ can be reached using the =control= key.
|
|||
| ~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 G~ | =Ⓖ= | G | guide-key mode |
|
||||
| ~SPC t h i~ | =ⓗi= | h | 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) |
|
||||
|
|
@ -1051,13 +1051,13 @@ Initiate the micro-state with ~M-SPC~ or ~s-M-SPC~ while in a =Helm= buffer.
|
|||
|
||||
** Discovering
|
||||
*** Key bindings
|
||||
**** Guide-key
|
||||
**** Which-key
|
||||
An help buffer is displayed each time the ~SPC~ key is pressed in normal mode.
|
||||
It lists the available key bindings and their associated commands.
|
||||
|
||||
By default the [[https://github.com/kai2nenobu/guide-key][guide-key]] buffer will be displayed quickly after the key has been
|
||||
By default the [[https://github.com/justbur/emacs-which-key][which-key]] buffer will be displayed quickly after the key has been
|
||||
pressed. You can change the delay by setting the variable
|
||||
=dotspacemacs-guide-key-delay= to your liking (the value is in second).
|
||||
=dotspacemacs-which-key-delay= to your liking (the value is in second).
|
||||
|
||||
**** Helm describe key bindings
|
||||
It is possible to search for specific key bindings by pressing ~SPC ?~.
|
||||
|
|
|
|||
|
|
@ -2,35 +2,35 @@
|
|||
- [[#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]]
|
||||
- [[#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]]
|
||||
- [[#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
|
||||
|
|
@ -98,11 +98,11 @@ the ~<Leader>~ key. All keybindings are mnemonic and are organized under the
|
|||
always under the ~SPC m~ prefix. A full list of conventions used in Spacemacs is
|
||||
[[./CONVENTIONS.org][here]]. Note that all keybindings can be changed.
|
||||
|
||||
Spacemacs uses [[https://github.com/kai2nenobu/guide-key][guide-key]] to show available keybindings after a delay:
|
||||
Spacemacs uses [[https://github.com/justbur/emacs-which-key][which-key]] to show available keybindings after a delay:
|
||||
|
||||
#+CAPTION: Guide-key window
|
||||
#+CAPTION: Which-key window
|
||||
|
||||
[[file:img/guide-key.png]]
|
||||
[[file:img/which-key.png]]
|
||||
|
||||
*** Running commands
|
||||
Emacs commands can be run using ~SPC :~. This will pop up a buffer using [[https://github.com/emacs-helm/helm][Helm]]
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 196 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Loading…
Reference in New Issue