Move documentation material and markdowns to `doc`
syl20bnr
39
README.md
|
|
@ -1,7 +1,7 @@
|
|||
|
||||
[](https://gitter.im/syl20bnr/spacemacs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)[![Twitter][]](http://www.twitter.com/spacemacs)
|
||||
|
||||
[philosophy][] | [goals][] | [for who?][] | [screenshots][] | [achievements][] | [contribute][CONTRIBUTE.md] | [documentation][DOCUMENTATION.md]
|
||||
[philosophy][] | [goals][] | [for who?][] | [screenshots][] | [documentation][DOCUMENTATION.md] | [contribute][CONTRIBUTE.md] | [achievements][] | [FAQ][]
|
||||
|
||||
**Quick Install:**
|
||||
|
||||
|
|
@ -56,7 +56,7 @@ that extend the default distribution.
|
|||
Spacemacs looks good. It comes with high-quality themes and a custom low-clutter
|
||||
modeline.
|
||||
|
||||
|
||||
|
||||
|
||||
### Excellent Evil Support
|
||||
|
||||
|
|
@ -261,24 +261,25 @@ The corresponding feature request for the powerline can be found
|
|||
[here][pw-patched-fonts].
|
||||
|
||||
[Twitter]: http://i.imgur.com/tXSoThF.png
|
||||
[philosophy]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#philosophy
|
||||
[goals]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#goals
|
||||
[for who?]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#who-can-benefit-from-this-
|
||||
[screenshots]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#screenshots
|
||||
[config]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#configuration-layers
|
||||
[dotfile]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#dotfile-configuration
|
||||
[manage_config]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#managing-private-configuration-layers
|
||||
[using_package_buf]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#using-the-package-list-buffer
|
||||
[achievements]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#achievements
|
||||
[troubleshoot]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#troubleshoot
|
||||
[contrib layers]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#using-configuration-layers
|
||||
[Git support]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#working-with-git
|
||||
[ace-jump]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#vim-motions-with-ace-jump-mode
|
||||
[project management]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#project-management
|
||||
[Evil Mode]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md#evil
|
||||
[philosophy]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#philosophy
|
||||
[goals]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#goals
|
||||
[for who?]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#who-can-benefit-from-this-
|
||||
[screenshots]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#screenshots
|
||||
[config]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#configuration-layers
|
||||
[dotfile]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#dotfile-configuration
|
||||
[manage_config]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#managing-private-configuration-layers
|
||||
[using_package_buf]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#using-the-package-list-buffer
|
||||
[achievements]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#achievements
|
||||
[troubleshoot]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#troubleshoot
|
||||
[contrib layers]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#using-configuration-layers
|
||||
[Git support]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#working-with-git
|
||||
[ace-jump]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#vim-motions-with-ace-jump-mode
|
||||
[project management]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#project-management
|
||||
[Evil Mode]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md#evil
|
||||
[private]: https://github.com/syl20bnr/spacemacs/tree/master/private
|
||||
[DOCUMENTATION.md]: https://github.com/syl20bnr/spacemacs/blob/master/DOCUMENTATION.md
|
||||
[CONTRIBUTE.md]: https://github.com/syl20bnr/spacemacs/blob/master/CONTRIBUTE.md
|
||||
[DOCUMENTATION.md]: https://github.com/syl20bnr/spacemacs/blob/master/doc/DOCUMENTATION.md
|
||||
[CONTRIBUTE.md]: https://github.com/syl20bnr/spacemacs/blob/master/doc/CONTRIBUTE.md
|
||||
[FAQ]: https://github.com/syl20bnr/spacemacs#faq
|
||||
[emacs_live]: https://github.com/overtone/emacs-live
|
||||
[guide-key]: https://github.com/kai2nenobu/guide-key
|
||||
[guide-key-tip]: https://github.com/aki2o/guide-key-tip
|
||||
|
|
|
|||
|
|
@ -192,13 +192,13 @@ and remember.
|
|||
# Screenshots
|
||||
|
||||
_Startup_
|
||||
|
||||
|
||||
|
||||
_Python_
|
||||
|
||||
|
||||
|
||||
_Terminal (urxvt)_
|
||||
|
||||
|
||||
|
||||
*Note: Even though screenshots are updated frequently, `Spacemacs` is evolving
|
||||
quickly and the screenshots may not reflect exactly the current state of the
|
||||
|
|
@ -581,10 +581,10 @@ 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-symbol micro-state](#auto-highlight-and-edition-of-symbols):
|
||||
|
||||
|
||||
|
||||
[Text scale micro-state](#change-font-size):
|
||||
|
||||
|
||||
|
||||
# Color theme
|
||||
|
||||
|
|
@ -682,7 +682,7 @@ Some elements can be dynamically toggled:
|
|||
When [Flycheck][flycheck] minor mode is enabled, a new element appears showing
|
||||
the number of errors, warnings and info.
|
||||
|
||||
|
||||
|
||||
|
||||
### Anzu integration
|
||||
|
||||
|
|
@ -690,7 +690,7 @@ the number of errors, warnings and info.
|
|||
integrates nicely the Anzu status by displaying it temporarily when `n` or `N` are
|
||||
being pressed. See the `5/6` segment on the screenshot below.
|
||||
|
||||
|
||||
|
||||
|
||||
### Battery status integration
|
||||
|
||||
|
|
@ -726,22 +726,22 @@ powerline, here is an exhaustive set of screenshots:
|
|||
|
||||
Separator | Screenshot
|
||||
------------------|------------------------------------------------------------
|
||||
`alternate` | 
|
||||
`arrow` | 
|
||||
`arrow-fade` | 
|
||||
`bar` | 
|
||||
`box` | 
|
||||
`brace` | 
|
||||
`butt` | 
|
||||
`chamfer` | 
|
||||
`contour` | 
|
||||
`curve` | 
|
||||
`rounded` | 
|
||||
`roundstub` | 
|
||||
`slant` | 
|
||||
`wave` | 
|
||||
`zigzag` | 
|
||||
`nil` | 
|
||||
`alternate` | 
|
||||
`arrow` | 
|
||||
`arrow-fade` | 
|
||||
`bar` | 
|
||||
`box` | 
|
||||
`brace` | 
|
||||
`butt` | 
|
||||
`chamfer` | 
|
||||
`contour` | 
|
||||
`curve` | 
|
||||
`rounded` | 
|
||||
`roundstub` | 
|
||||
`slant` | 
|
||||
`wave` | 
|
||||
`zigzag` | 
|
||||
`nil` | 
|
||||
|
||||
### Minor Modes
|
||||
|
||||
|
|
@ -1611,9 +1611,9 @@ you can answer `y` with no issue.
|
|||
|
||||
Symbol | Description
|
||||
:-------------------------------------------------------------------------------------------:|-----------------
|
||||
 | new line
|
||||
 | at least one line has been deleted
|
||||
 | modified line
|
||||
 | new line
|
||||
 | at least one line has been deleted
|
||||
 | modified line
|
||||
|
||||
## Registers
|
||||
|
||||
|
|
@ -1644,9 +1644,9 @@ Custom fringe bitmaps:
|
|||
|
||||
Symbol | Description
|
||||
:----------------------------------------------------------------------------------------------:|------------
|
||||
 | Error
|
||||
 | warning
|
||||
 | Info
|
||||
 | Error
|
||||
 | warning
|
||||
 | Info
|
||||
|
||||
## Compiling
|
||||
|
||||
|
|
@ -1957,7 +1957,7 @@ developers to elisp hackers!
|
|||
[guide-key]: https://github.com/kai2nenobu/guide-key
|
||||
[guide-key-tip]: https://github.com/aki2o/guide-key-tip
|
||||
[gitter]: https://gitter.im/syl20bnr/spacemacs
|
||||
[CONTRIBUTE.md]: https://github.com/syl20bnr/spacemacs/blob/master/CONTRIBUTE.md
|
||||
[CONTRIBUTE.md]: https://github.com/syl20bnr/spacemacs/blob/master/doc/CONTRIBUTE.md
|
||||
[neotree]: https://github.com/jaypei/emacs-neotree
|
||||
[nerdtree]: https://github.com/scrooloose/nerdtree
|
||||
[anaconda-mode]: https://github.com/proofit404/anaconda-mode
|
||||
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 6.7 KiB After Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 188 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 242 KiB After Width: | Height: | Size: 242 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 53 KiB After Width: | Height: | Size: 53 KiB |
|
Before Width: | Height: | Size: 301 KiB After Width: | Height: | Size: 301 KiB |
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |