Skip to content

Commit 402bba5

Browse files
committed
format .org TOCs with toc-org
1 parent b2c62e2 commit 402bba5

File tree

125 files changed

+1279
-1279
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+1279
-1279
lines changed

doc/CONVENTIONS.org

+36-36
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
#+TITLE: Spacemacs Conventions
22

33
* Spacemacs conventions :TOC_4_gh:noexport:
4-
- [[Code guidelines][Code guidelines]]
5-
- [[Spacemacs core and layer][Spacemacs core and layer]]
6-
- [[All layers][All layers]]
7-
- [[Use-package][Use-package]]
8-
- [[Key bindings conventions][Key bindings conventions]]
9-
- [[Reserved prefix][Reserved prefix]]
10-
- [[User prefix][User prefix]]
11-
- [[Major mode prefix][Major mode prefix]]
12-
- [[Transient-state][Transient-state]]
13-
- [[Evilified buffers][Evilified buffers]]
14-
- [[Navigation][Navigation]]
15-
- [[n and N][n and N]]
16-
- [[Code Navigation][Code Navigation]]
17-
- [[=insert state= buffers][=insert state= buffers]]
18-
- [[Confirm and Abort][Confirm and Abort]]
19-
- [[Evaluation][Evaluation]]
20-
- [[REPLs][REPLs]]
21-
- [[Send code][Send code]]
22-
- [[In terminal][In terminal]]
23-
- [[Building and Compilation][Building and Compilation]]
24-
- [[Debugging][Debugging]]
25-
- [[Plain Text Markup Languages][Plain Text Markup Languages]]
26-
- [[Headers][Headers]]
27-
- [[Insertion of common elements][Insertion of common elements]]
28-
- [[Text manipulation][Text manipulation]]
29-
- [[Movement in normal mode][Movement in normal mode]]
30-
- [[Promotion, Demotion and element movement][Promotion, Demotion and element movement]]
31-
- [[Table editing][Table editing]]
32-
- [[Tests][Tests]]
33-
- [[All languages][All languages]]
34-
- [[Language specific][Language specific]]
35-
- [[Toggles][Toggles]]
36-
- [[Refactoring][Refactoring]]
37-
- [[Help or Documentation][Help or Documentation]]
38-
- [[Writing documentation][Writing documentation]]
39-
- [[Spacing in documentation][Spacing in documentation]]
4+
- [[#code-guidelines][Code guidelines]]
5+
- [[#spacemacs-core-and-layer][Spacemacs core and layer]]
6+
- [[#all-layers][All layers]]
7+
- [[#use-package][Use-package]]
8+
- [[#key-bindings-conventions][Key bindings conventions]]
9+
- [[#reserved-prefix][Reserved prefix]]
10+
- [[#user-prefix][User prefix]]
11+
- [[#major-mode-prefix][Major mode prefix]]
12+
- [[#transient-state][Transient-state]]
13+
- [[#evilified-buffers][Evilified buffers]]
14+
- [[#navigation][Navigation]]
15+
- [[#n-and-n][n and N]]
16+
- [[#code-navigation][Code Navigation]]
17+
- [[#insert-state-buffers][=insert state= buffers]]
18+
- [[#confirm-and-abort][Confirm and Abort]]
19+
- [[#evaluation][Evaluation]]
20+
- [[#repls][REPLs]]
21+
- [[#send-code][Send code]]
22+
- [[#in-terminal][In terminal]]
23+
- [[#building-and-compilation][Building and Compilation]]
24+
- [[#debugging][Debugging]]
25+
- [[#plain-text-markup-languages][Plain Text Markup Languages]]
26+
- [[#headers][Headers]]
27+
- [[#insertion-of-common-elements][Insertion of common elements]]
28+
- [[#text-manipulation][Text manipulation]]
29+
- [[#movement-in-normal-mode][Movement in normal mode]]
30+
- [[#promotion-demotion-and-element-movement][Promotion, Demotion and element movement]]
31+
- [[#table-editing][Table editing]]
32+
- [[#tests][Tests]]
33+
- [[#all-languages][All languages]]
34+
- [[#language-specific][Language specific]]
35+
- [[#toggles][Toggles]]
36+
- [[#refactoring][Refactoring]]
37+
- [[#help-or-documentation][Help or Documentation]]
38+
- [[#writing-documentation][Writing documentation]]
39+
- [[#spacing-in-documentation][Spacing in documentation]]
4040

4141
* Code guidelines
4242
** Spacemacs core and layer

doc/DOCUMENTATION.org

+186-186
Large diffs are not rendered by default.

doc/FAQ.org

+43-43
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,49 @@
11
#+TITLE: Frequently Asked Questions
22

33
* FAQ :TOC_4_gh:noexport:
4-
- [[Common][Common]]
5-
- [[Which version of Spacemacs am I running?][Which version of Spacemacs am I running?]]
6-
- [[What is the official pronunciation of Spacemacs?][What is the official pronunciation of Spacemacs?]]
7-
- [[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?]]
8-
- [[How to fix package download errors when installing Spacemacs ?][How to fix package download errors when installing Spacemacs ?]]
9-
- [[The Spacemacs banner is ugly, what should I do?][The Spacemacs banner is ugly, what should I do?]]
10-
- [[The powerline separators are ugly, how can I fix them?][The powerline separators are ugly, how can I fix them?]]
11-
- [[The powerline separators have no anti-aliasing, what can I do?][The powerline separators have no anti-aliasing, what can I do?]]
12-
- [[Why is after-init-hook not executed?][Why is after-init-hook not executed?]]
13-
- [[What is the difference between =spacemacs-base= and =spacemacs= distributions?][What is the difference between =spacemacs-base= and =spacemacs= distributions?]]
14-
- [[Should I place my settings in =user-init= or =user-config=?][Should I place my settings in =user-init= or =user-config=?]]
15-
- [[Why do some of my =org=-related settings cause problems?][Why do some of my =org=-related settings cause problems?]]
16-
- [[Why is Spacemacs hanging on startup?][Why is Spacemacs hanging on startup?]]
17-
- [[Why does =helm-M-x= (~SPC SPC~) not accept the prefix argument?][Why does =helm-M-x= (~SPC SPC~) not accept the prefix argument?]]
18-
- [[Why does my color theme not render correctly in terminal mode?][Why does my color theme not render correctly in terminal mode?]]
19-
- [[Why do I get =(wrong-type-argument arrayp nil)= errors on startup?][Why do I get =(wrong-type-argument arrayp nil)= errors on startup?]]
20-
- [[Typing quickly =fd= takes me out of =insert state=. What is going on?][Typing quickly =fd= takes me out of =insert state=. What is going on?]]
21-
- [[Why do I get files starting with .#?][Why do I get files starting with .#?]]
22-
- [[How do I...][How do I...]]
23-
- [[Install a package not provided by a layer?][Install a package not provided by a layer?]]
24-
- [[Disable a package completely?][Disable a package completely?]]
25-
- [[Disable a package only for a specific major-mode?][Disable a package only for a specific major-mode?]]
26-
- [[Disable company for a specific major-mode?][Disable company for a specific major-mode?]]
27-
- [[Change special buffer rules?][Change special buffer rules?]]
28-
- [[Enable navigation by visual lines?][Enable navigation by visual lines?]]
29-
- [[Disable evilification of a mode?][Disable evilification of a mode?]]
30-
- [[Include underscores in word motions?][Include underscores in word motions?]]
31-
- [[Setup =$PATH=?][Setup =$PATH=?]]
32-
- [[Change or define an alias for a leader key?][Change or define an alias for a leader key?]]
33-
- [[Restore the sentence delimiter to two spaces?][Restore the sentence delimiter to two spaces?]]
34-
- [[Prevent the visual selection overriding my system clipboard?][Prevent the visual selection overriding my system clipboard?]]
35-
- [[Make spell-checking support curly quotes (or any other character)?][Make spell-checking support curly quotes (or any other character)?]]
36-
- [[Use Spacemacs as the =$EDITOR= for git commits?][Use Spacemacs as the =$EDITOR= for git commits?]]
37-
- [[Try Spacemacs without modifying my existing Emacs configuration?][Try Spacemacs without modifying my existing Emacs configuration?]]
38-
- [[Make copy/paste working with the mouse in X11 terminals?][Make copy/paste working with the mouse in X11 terminals?]]
39-
- [[Use =helm-ag= to search only in files of a certain type?][Use =helm-ag= to search only in files of a certain type?]]
40-
- [[Windows][Windows]]
41-
- [[Why do the fonts look crappy on Windows?][Why do the fonts look crappy on Windows?]]
42-
- [[Why is there no Spacemacs logo in the startup buffer?][Why is there no Spacemacs logo in the startup buffer?]]
43-
- [[Why are all packages unavailable?][Why are all packages unavailable?]]
44-
- [[The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.][The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.]]
45-
- [[OS X][OS X]]
46-
- [[Why are the powerline colors not correct on OS X?][Why are the powerline colors not correct on OS X?]]
4+
- [[#common][Common]]
5+
- [[#which-version-of-spacemacs-am-i-running][Which version of Spacemacs am I running?]]
6+
- [[#what-is-the-official-pronunciation-of-spacemacs][What is the official pronunciation of Spacemacs?]]
7+
- [[#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?]]
8+
- [[#how-to-fix-package-download-errors-when-installing-spacemacs-][How to fix package download errors when installing Spacemacs ?]]
9+
- [[#the-spacemacs-banner-is-ugly-what-should-i-do][The Spacemacs banner is ugly, what should I do?]]
10+
- [[#the-powerline-separators-are-ugly-how-can-i-fix-them][The powerline separators are ugly, how can I fix them?]]
11+
- [[#the-powerline-separators-have-no-anti-aliasing-what-can-i-do][The powerline separators have no anti-aliasing, what can I do?]]
12+
- [[#why-is-after-init-hook-not-executed][Why is after-init-hook not executed?]]
13+
- [[#what-is-the-difference-between-spacemacs-base-and-spacemacs-distributions][What is the difference between =spacemacs-base= and =spacemacs= distributions?]]
14+
- [[#should-i-place-my-settings-in-user-init-or-user-config][Should I place my settings in =user-init= or =user-config=?]]
15+
- [[#why-do-some-of-my-org-related-settings-cause-problems][Why do some of my =org=-related settings cause problems?]]
16+
- [[#why-is-spacemacs-hanging-on-startup][Why is Spacemacs hanging on startup?]]
17+
- [[#why-does-helm-m-x-spc-spc-not-accept-the-prefix-argument][Why does =helm-M-x= (~SPC SPC~) not accept the prefix argument?]]
18+
- [[#why-does-my-color-theme-not-render-correctly-in-terminal-mode][Why does my color theme not render correctly in terminal mode?]]
19+
- [[#why-do-i-get-wrong-type-argument-arrayp-nil-errors-on-startup][Why do I get =(wrong-type-argument arrayp nil)= errors on startup?]]
20+
- [[#typing-quickly-fd-takes-me-out-of-insert-state-what-is-going-on][Typing quickly =fd= takes me out of =insert state=. What is going on?]]
21+
- [[#why-do-i-get-files-starting-with-][Why do I get files starting with .#?]]
22+
- [[#how-do-i][How do I...]]
23+
- [[#install-a-package-not-provided-by-a-layer][Install a package not provided by a layer?]]
24+
- [[#disable-a-package-completely][Disable a package completely?]]
25+
- [[#disable-a-package-only-for-a-specific-major-mode][Disable a package only for a specific major-mode?]]
26+
- [[#disable-company-for-a-specific-major-mode][Disable company for a specific major-mode?]]
27+
- [[#change-special-buffer-rules][Change special buffer rules?]]
28+
- [[#enable-navigation-by-visual-lines][Enable navigation by visual lines?]]
29+
- [[#disable-evilification-of-a-mode][Disable evilification of a mode?]]
30+
- [[#include-underscores-in-word-motions][Include underscores in word motions?]]
31+
- [[#setup-path][Setup =$PATH=?]]
32+
- [[#change-or-define-an-alias-for-a-leader-key][Change or define an alias for a leader key?]]
33+
- [[#restore-the-sentence-delimiter-to-two-spaces][Restore the sentence delimiter to two spaces?]]
34+
- [[#prevent-the-visual-selection-overriding-my-system-clipboard][Prevent the visual selection overriding my system clipboard?]]
35+
- [[#make-spell-checking-support-curly-quotes-or-any-other-character][Make spell-checking support curly quotes (or any other character)?]]
36+
- [[#use-spacemacs-as-the-editor-for-git-commits][Use Spacemacs as the =$EDITOR= for git commits?]]
37+
- [[#try-spacemacs-without-modifying-my-existing-emacs-configuration][Try Spacemacs without modifying my existing Emacs configuration?]]
38+
- [[#make-copypaste-working-with-the-mouse-in-x11-terminals][Make copy/paste working with the mouse in X11 terminals?]]
39+
- [[#use-helm-ag-to-search-only-in-files-of-a-certain-type][Use =helm-ag= to search only in files of a certain type?]]
40+
- [[#windows][Windows]]
41+
- [[#why-do-the-fonts-look-crappy-on-windows][Why do the fonts look crappy on Windows?]]
42+
- [[#why-is-there-no-spacemacs-logo-in-the-startup-buffer][Why is there no Spacemacs logo in the startup buffer?]]
43+
- [[#why-are-all-packages-unavailable][Why are all packages unavailable?]]
44+
- [[#the-powerline-isnt-shown-correctly-when-spacemacs-is-used-within-putty][The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.]]
45+
- [[#os-x][OS X]]
46+
- [[#why-are-the-powerline-colors-not-correct-on-os-x][Why are the powerline colors not correct on OS X?]]
4747

4848
* Common
4949
** Which version of Spacemacs am I running?

doc/LAYERS.org

+28-28
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
11
#+TITLE: Configuration layers
22

33
* Configuration Layers :TOC_4_gh:noexport:
4-
- [[Introduction][Introduction]]
5-
- [[Nomenclature][Nomenclature]]
6-
- [[The Emacs loading process][The Emacs loading process]]
7-
- [[Emacs Lisp files][Emacs Lisp files]]
8-
- [[Loading a file][Loading a file]]
9-
- [[Features][Features]]
10-
- [[The load path][The load path]]
11-
- [[Auto-loading][Auto-loading]]
12-
- [[Eval after load][Eval after load]]
13-
- [[Use-package][Use-package]]
14-
- [[Anatomy of a layer][Anatomy of a layer]]
15-
- [[packages.el][packages.el]]
16-
- [[packages-config.el][packages-config.el]]
17-
- [[config.el, packages-funcs.el and keybindings.el][config.el, packages-funcs.el and keybindings.el]]
18-
- [[The Spacemacs loading process][The Spacemacs loading process]]
19-
- [[Case study: auto-completion][Case study: auto-completion]]
20-
- [[Layer tips and tricks][Layer tips and tricks]]
21-
- [[Cross-dependencies][Cross-dependencies]]
22-
- [[Use-package][Use-package]]
23-
- [[Use-package hooks][Use-package hooks]]
24-
- [[Best practices][Best practices]]
25-
- [[Package ownership][Package ownership]]
26-
- [[Localize your configuration][Localize your configuration]]
27-
- [[Load ordering][Load ordering]]
28-
- [[No require][No require]]
29-
- [[Auto-load everything][Auto-load everything]]
30-
- [[How do I ... idiomatically?][How do I ... idiomatically?]]
31-
- [[Setup auto-completion for a major mode][Setup auto-completion for a major mode]]
4+
- [[#introduction][Introduction]]
5+
- [[#nomenclature][Nomenclature]]
6+
- [[#the-emacs-loading-process][The Emacs loading process]]
7+
- [[#emacs-lisp-files][Emacs Lisp files]]
8+
- [[#loading-a-file][Loading a file]]
9+
- [[#features][Features]]
10+
- [[#the-load-path][The load path]]
11+
- [[#auto-loading][Auto-loading]]
12+
- [[#eval-after-load][Eval after load]]
13+
- [[#use-package][Use-package]]
14+
- [[#anatomy-of-a-layer][Anatomy of a layer]]
15+
- [[#packagesel][packages.el]]
16+
- [[#packages-configel][packages-config.el]]
17+
- [[#configel-packages-funcsel-and-keybindingsel][config.el, packages-funcs.el and keybindings.el]]
18+
- [[#the-spacemacs-loading-process][The Spacemacs loading process]]
19+
- [[#case-study-auto-completion][Case study: auto-completion]]
20+
- [[#layer-tips-and-tricks][Layer tips and tricks]]
21+
- [[#cross-dependencies][Cross-dependencies]]
22+
- [[#use-package][Use-package]]
23+
- [[#use-package-hooks][Use-package hooks]]
24+
- [[#best-practices][Best practices]]
25+
- [[#package-ownership][Package ownership]]
26+
- [[#localize-your-configuration][Localize your configuration]]
27+
- [[#load-ordering][Load ordering]]
28+
- [[#no-require][No require]]
29+
- [[#auto-load-everything][Auto-load everything]]
30+
- [[#how-do-i--idiomatically][How do I ... idiomatically?]]
31+
- [[#setup-auto-completion-for-a-major-mode][Setup auto-completion for a major mode]]
3232

3333
* Introduction
3434
This document is intended as a tutorial for users who are interested in writing

doc/QUICK_START.org

+12-12
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
#+TITLE: Quick start
22

33
* Configuration :TOC_4_gh:noexport:
4-
- [[Configuration layers][Configuration layers]]
5-
- [[Dotfile (.spacemacs)][Dotfile (.spacemacs)]]
6-
- [[Dotdirectory (~/.spacemacs.d)][Dotdirectory (~/.spacemacs.d)]]
7-
- [[Learning Spacemacs][Learning Spacemacs]]
8-
- [[Editing Styles][Editing Styles]]
9-
- [[The leader keys][The leader keys]]
10-
- [[Evil-tutor][Evil-tutor]]
11-
- [[Universal argument][Universal argument]]
12-
- [[Configuration layers and Package discovery][Configuration layers and Package discovery]]
13-
- [[Key bindings discovery][Key bindings discovery]]
14-
- [[Describe functions][Describe functions]]
15-
- [[How-To's][How-To's]]
4+
- [[#configuration-layers][Configuration layers]]
5+
- [[#dotfile-spacemacs][Dotfile (.spacemacs)]]
6+
- [[#dotdirectory-spacemacsd][Dotdirectory (~/.spacemacs.d)]]
7+
- [[#learning-spacemacs][Learning Spacemacs]]
8+
- [[#editing-styles][Editing Styles]]
9+
- [[#the-leader-keys][The leader keys]]
10+
- [[#evil-tutor][Evil-tutor]]
11+
- [[#universal-argument][Universal argument]]
12+
- [[#configuration-layers-and-package-discovery][Configuration layers and Package discovery]]
13+
- [[#key-bindings-discovery][Key bindings discovery]]
14+
- [[#describe-functions][Describe functions]]
15+
- [[#how-tos][How-To's]]
1616

1717
* Configuration layers
1818
Spacemacs divides its configuration into self-contained units called

doc/VIMUSERS.org

+34-34
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,40 @@
11
#+TITLE: Migrating from Vim
22

33
* Migrating from vim :TOC_4_gh:noexport:
4-
- [[Purpose of this document][Purpose of this document]]
5-
- [[Philosophy][Philosophy]]
6-
- [[Basic orientation][Basic orientation]]
7-
- [[Terms][Terms]]
8-
- [[Modes vs. States][Modes vs. States]]
9-
- [[Layers][Layers]]
10-
- [[Transient-states][Transient-states]]
11-
- [[Keybinding conventions][Keybinding conventions]]
12-
- [[Running commands][Running commands]]
13-
- [[Buffer and window management][Buffer and window management]]
14-
- [[Buffers][Buffers]]
15-
- [[Special buffers][Special buffers]]
16-
- [[Windows][Windows]]
17-
- [[Files][Files]]
18-
- [[The Help System][The Help System]]
19-
- [[Exploring][Exploring]]
20-
- [[Customization][Customization]]
21-
- [[The .spacemacs file][The .spacemacs file]]
22-
- [[Emacs Lisp][Emacs Lisp]]
23-
- [[Variables][Variables]]
24-
- [[Keybindings][Keybindings]]
25-
- [[Functions][Functions]]
26-
- [[Activating a Layer][Activating a Layer]]
27-
- [[Creating a Layer][Creating a Layer]]
28-
- [[Installing a single package][Installing a single package]]
29-
- [[Loading packages][Loading packages]]
30-
- [[Uninstalling a package][Uninstalling a package]]
31-
- [[Common tweaks][Common tweaks]]
32-
- [[Changing the escape key][Changing the escape key]]
33-
- [[Changing the colorscheme][Changing the colorscheme]]
34-
- [[Nohlsearch][Nohlsearch]]
35-
- [[Sessions][Sessions]]
36-
- [[Navigating using visual lines][Navigating using visual lines]]
37-
- [[Other useful links][Other useful links]]
4+
- [[#purpose-of-this-document][Purpose of this document]]
5+
- [[#philosophy][Philosophy]]
6+
- [[#basic-orientation][Basic orientation]]
7+
- [[#terms][Terms]]
8+
- [[#modes-vs-states][Modes vs. States]]
9+
- [[#layers][Layers]]
10+
- [[#transient-states][Transient-states]]
11+
- [[#keybinding-conventions][Keybinding conventions]]
12+
- [[#running-commands][Running commands]]
13+
- [[#buffer-and-window-management][Buffer and window management]]
14+
- [[#buffers][Buffers]]
15+
- [[#special-buffers][Special buffers]]
16+
- [[#windows][Windows]]
17+
- [[#files][Files]]
18+
- [[#the-help-system][The Help System]]
19+
- [[#exploring][Exploring]]
20+
- [[#customization][Customization]]
21+
- [[#the-spacemacs-file][The .spacemacs file]]
22+
- [[#emacs-lisp][Emacs Lisp]]
23+
- [[#variables][Variables]]
24+
- [[#keybindings][Keybindings]]
25+
- [[#functions][Functions]]
26+
- [[#activating-a-layer][Activating a Layer]]
27+
- [[#creating-a-layer][Creating a Layer]]
28+
- [[#installing-a-single-package][Installing a single package]]
29+
- [[#loading-packages][Loading packages]]
30+
- [[#uninstalling-a-package][Uninstalling a package]]
31+
- [[#common-tweaks][Common tweaks]]
32+
- [[#changing-the-escape-key][Changing the escape key]]
33+
- [[#changing-the-colorscheme][Changing the colorscheme]]
34+
- [[#nohlsearch][Nohlsearch]]
35+
- [[#sessions][Sessions]]
36+
- [[#navigating-using-visual-lines][Navigating using visual lines]]
37+
- [[#other-useful-links][Other useful links]]
3838

3939
* Purpose of this document
4040
This document is intended to supplement the Spacemacs documentation by bridging

0 commit comments

Comments
 (0)