format .org TOCs with toc-org

syl20bnr · Mar 19, 2016 · 402bba5 · 402bba5
1 parent b2c62e2
commit 402bba5
Show file tree

Hide file tree

Showing 125 changed files with 1,279 additions and 1,279 deletions.
diff --git a/doc/CONVENTIONS.org b/doc/CONVENTIONS.org
@@ -1,42 +1,42 @@
 #+TITLE: Spacemacs Conventions
 
 * Spacemacs conventions                                     :TOC_4_gh:noexport:
- - [[Code guidelines][Code guidelines]]
-   - [[Spacemacs core and layer][Spacemacs core and layer]]
-   - [[All layers][All layers]]
-   - [[Use-package][Use-package]]
- - [[Key bindings conventions][Key bindings conventions]]
-   - [[Reserved prefix][Reserved prefix]]
-     - [[User prefix][User prefix]]
-     - [[Major mode prefix][Major mode prefix]]
-     - [[Transient-state][Transient-state]]
-   - [[Evilified buffers][Evilified buffers]]
-   - [[Navigation][Navigation]]
-     - [[n and N][n and N]]
-     - [[Code Navigation][Code Navigation]]
-     - [[=insert state= buffers][=insert state= buffers]]
-   - [[Confirm and Abort][Confirm and Abort]]
-   - [[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][Code guidelines]]
+   - [[#spacemacs-core-and-layer][Spacemacs core and layer]]
+   - [[#all-layers][All layers]]
+   - [[#use-package][Use-package]]
+ - [[#key-bindings-conventions][Key bindings conventions]]
+   - [[#reserved-prefix][Reserved prefix]]
+     - [[#user-prefix][User prefix]]
+     - [[#major-mode-prefix][Major mode prefix]]
+     - [[#transient-state][Transient-state]]
+   - [[#evilified-buffers][Evilified buffers]]
+   - [[#navigation][Navigation]]
+     - [[#n-and-n][n and N]]
+     - [[#code-navigation][Code Navigation]]
+     - [[#insert-state-buffers][=insert state= buffers]]
+   - [[#confirm-and-abort][Confirm and Abort]]
+   - [[#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

diff --git a/doc/DOCUMENTATION.org b/doc/DOCUMENTATION.org
diff --git a/doc/FAQ.org b/doc/FAQ.org
@@ -1,49 +1,49 @@
 #+TITLE: Frequently Asked Questions
 
 * FAQ                                                       :TOC_4_gh: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?]]
-   - [[How to fix package download errors when installing Spacemacs ?][How to fix package download errors when installing Spacemacs ?]]
-   - [[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?]]
-   - [[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?]]
-   - [[Why is Spacemacs hanging on startup?][Why is Spacemacs hanging on startup?]]
-   - [[Why does =helm-M-x= (~SPC SPC~) not accept the prefix argument?][Why does =helm-M-x= (~SPC SPC~) not accept the prefix argument?]]
-   - [[Why does my color theme not render correctly in terminal mode?][Why does my color theme not render correctly in terminal mode?]]
-   - [[Why do I get =(wrong-type-argument arrayp nil)= errors on startup?][Why do I get =(wrong-type-argument arrayp nil)= errors on startup?]]
-   - [[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?]]
-   - [[Why do I get files starting with .#?][Why do I get files starting with .#?]]
- - [[How do I...][How do I...]]
-   - [[Install a package not provided by a layer?][Install a package not provided by a layer?]]
-   - [[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=?]]
-   - [[Change or define an alias for a leader key?][Change or define an alias for a leader key?]]
-   - [[Restore the sentence delimiter to two spaces?][Restore the sentence delimiter to two spaces?]]
-   - [[Prevent the visual selection overriding my system clipboard?][Prevent the visual selection overriding my system clipboard?]]
-   - [[Make spell-checking support curly quotes (or any other character)?][Make spell-checking support curly quotes (or any other character)?]]
-   - [[Use Spacemacs as the =$EDITOR= for git commits?][Use Spacemacs as the =$EDITOR= for git commits?]]
-   - [[Try Spacemacs without modifying my existing Emacs configuration?][Try Spacemacs without modifying my existing Emacs configuration?]]
-   - [[Make copy/paste working with the mouse in X11 terminals?][Make copy/paste working with the mouse in X11 terminals?]]
-   - [[Use =helm-ag= to search only in files of a certain type?][Use =helm-ag= to search only in files of a certain type?]]
- - [[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?]]
-   - [[The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.][The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.]]
- - [[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][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?]]
+   - [[#how-to-fix-package-download-errors-when-installing-spacemacs-][How to fix package download errors when installing Spacemacs ?]]
+   - [[#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?]]
+   - [[#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?]]
+   - [[#why-is-spacemacs-hanging-on-startup][Why is Spacemacs hanging on startup?]]
+   - [[#why-does-helm-m-x-spc-spc-not-accept-the-prefix-argument][Why does =helm-M-x= (~SPC SPC~) not accept the prefix argument?]]
+   - [[#why-does-my-color-theme-not-render-correctly-in-terminal-mode][Why does my color theme not render correctly in terminal mode?]]
+   - [[#why-do-i-get-wrong-type-argument-arrayp-nil-errors-on-startup][Why do I get =(wrong-type-argument arrayp nil)= errors on startup?]]
+   - [[#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?]]
+   - [[#why-do-i-get-files-starting-with-][Why do I get files starting with .#?]]
+ - [[#how-do-i][How do I...]]
+   - [[#install-a-package-not-provided-by-a-layer][Install a package not provided by a layer?]]
+   - [[#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=?]]
+   - [[#change-or-define-an-alias-for-a-leader-key][Change or define an alias for a leader key?]]
+   - [[#restore-the-sentence-delimiter-to-two-spaces][Restore the sentence delimiter to two spaces?]]
+   - [[#prevent-the-visual-selection-overriding-my-system-clipboard][Prevent the visual selection overriding my system clipboard?]]
+   - [[#make-spell-checking-support-curly-quotes-or-any-other-character][Make spell-checking support curly quotes (or any other character)?]]
+   - [[#use-spacemacs-as-the-editor-for-git-commits][Use Spacemacs as the =$EDITOR= for git commits?]]
+   - [[#try-spacemacs-without-modifying-my-existing-emacs-configuration][Try Spacemacs without modifying my existing Emacs configuration?]]
+   - [[#make-copypaste-working-with-the-mouse-in-x11-terminals][Make copy/paste working with the mouse in X11 terminals?]]
+   - [[#use-helm-ag-to-search-only-in-files-of-a-certain-type][Use =helm-ag= to search only in files of a certain type?]]
+ - [[#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?]]
+   - [[#the-powerline-isnt-shown-correctly-when-spacemacs-is-used-within-putty][The powerline isn't shown correctly when Spacemacs is used within =PuTTY=.]]
+ - [[#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?

diff --git a/doc/LAYERS.org b/doc/LAYERS.org
@@ -1,34 +1,34 @@
 #+TITLE: Configuration layers
 
 * Configuration Layers                                      :TOC_4_gh: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]]
-   - [[packages-config.el][packages-config.el]]
-   - [[config.el, packages-funcs.el and keybindings.el][config.el, packages-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][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]]
+   - [[#packages-configel][packages-config.el]]
+   - [[#configel-packages-funcsel-and-keybindingsel][config.el, packages-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
@@ -1,18 +1,18 @@
 #+TITLE: Quick start
 
 * Configuration                                             :TOC_4_gh: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]]
+ - [[#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 layers
 Spacemacs divides its configuration into self-contained units called

diff --git a/doc/VIMUSERS.org b/doc/VIMUSERS.org
@@ -1,40 +1,40 @@
 #+TITLE: Migrating from Vim
 
 * Migrating from vim                                        :TOC_4_gh: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]]
-     - [[Transient-states][Transient-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][Purpose of this document]]
+ - [[#philosophy][Philosophy]]
+ - [[#basic-orientation][Basic orientation]]
+   - [[#terms][Terms]]
+     - [[#modes-vs-states][Modes vs. States]]
+     - [[#layers][Layers]]
+     - [[#transient-states][Transient-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