TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Format docs

This commit is contained in:
JAremko 2017-12-31 02:39:19 +02:00
parent b4d663dcb5
commit c47d88a098
3 changed files with 34 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/DOCUMENTATION.org
View File

@ -69,15 +69,17 @@
- [[#notes][Notes]]
- [[#font][Font]]
- [[#gui-toggles][GUI Toggles]]
- [[#global-line-numbers][Global line numbers]]
- [[#global-line-numbers][Global line numbers]]
- [[#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]]
- [[#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]]
- [[#spaceline][Spaceline]]
- [[#restore-lighters][Restore lighters]]
- [[#frame-title][Frame title]]
- [[#iconified-tabified-title][Iconified (tabified) title]]
- [[#layouts-and-workspaces][Layouts and workspaces]]
@ -1143,7 +1145,7 @@ and ~T~):
*Note*: These toggles are all available via the =spacemacs-help= interfaces
(press ~SPC h SPC~ to display the =spacemacs-help= buffer).
**** Global line numbers
*** Global line numbers
Line numbers can be toggled on in all =prog-mode= and =text-mode= buffers by
setting the =dotspacemacs-line-numbers= variable in your =~/.spacemacs= to =t=.
@ -1248,19 +1250,19 @@ Some elements can be dynamically toggled:
| ~SPC t m v~ | toggle the version control info |
| ~SPC t m V~ | toggle the new version lighter |
**** Powerline font installation for terminal-mode users
*** Powerline font installation for terminal-mode users
Users who run Emacs in terminal mode may need to install the [[https://github.com/powerline/fonts][Powerline patched
fonts]] and configure their terminal clients to use them to make the Powerline
separators render correctly.
**** Flycheck integration
*** Flycheck integration
When [[https://github.com/flycheck/flycheck][Flycheck]] minor mode is enabled, a new element appears showing the number of
errors, warnings and info.
[[file:img/powerline-wave.png]]
/Flycheck integration in mode-line/
**** Anzu integration
*** Anzu integration
[[https://github.com/syohex/emacs-anzu][Anzu]] shows the number of occurrence when performing a search. Spacemacs
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.
@ -1268,7 +1270,7 @@ are being pressed. See the =5/6= segment on the screenshot below.
[[file:img/powerline-anzu.png]]
/Anzu integration in mode-line/
**** Battery status integration
*** Battery status integration
[[https://github.com/lunaryorn/fancy-battery.el][fancy-battery]] displays the percentage of total charge of the battery as well as
the time remaining to charge or discharge completely the battery.
@ -1282,7 +1284,7 @@ A color code is used for the battery status:
Note the these colors may vary depending on your theme.
**** Powerline separators
*** Powerline separators
It is possible to easily customize the =powerline separator= by setting the
=powerline-default-separator= variable in your =~/.spacemacs= and then
recompiling the modeline. For instance if you want to set back the separator to
@ -1318,7 +1320,7 @@ powerline, here is an exhaustive set of screenshots:
| =zigzag= | [[file:img/powerline-zigzag.png]] |
| =nil= | [[file:img/powerline-nil.png]] |
**** Minor Modes
*** Minor Modes
Spacemacs uses [[https://www.emacswiki.org/emacs/DiminishedModes][diminish]] mode to reduce the size of minor mode indicators:
The minor mode area can be toggled on and off with ~SPC t m m~
@ -1365,8 +1367,8 @@ can be reached using the =control= key.
| ~SPC t C-W~ | =Ⓦ= | W | automatic whitespace cleanup globally |
| ~SPC t y~ | =ⓨ= | y | [[https://github.com/capitaomorte/yasnippet][yasnippet]] mode |
**** Customizing the mode-line
***** Spaceline
*** Customizing the mode-line
**** Spaceline
Spacemacs uses [[https://github.com/TheBB/spaceline][Spaceline]] to provide its mode-line. It consists of a number of
/segments/ arranged on the left and right sides. These are defined in the
variables =spaceline-left= and =spaceline-right=. Segments can be defined using
@ -1375,7 +1377,7 @@ right hand side variables.
Please see the Spaceline documentation for more information.
***** Restore lighters
**** Restore lighters
Lighters are abbreviations displayed in the mode-line to identify running minor
modes. Spacemacs diminishes most of them to make them more compact.

8
layers/+lang/asm/README.org
View File

@ -6,8 +6,8 @@
- [[#description][Description]]
- [[#features][Features:]]
- [[#install][Install]]
- [[#layer][Layer]]
- [[#pdfs][PDFs]]
- [[#layer][Layer]]
- [[#pdfs][PDFs]]
- [[#key-bindings][Key bindings]]
* Description
@ -26,12 +26,12 @@ in general, and provides Imenu integration so you can jump around with ~SPC s j~
- Imenu integration.
* Install
*** Layer
** Layer
To use this configuration layer, add it to your =~/.spacemacs=. You will need to
add =asm= to the existing =dotspacemacs-configuration-layers= list in this
file.
*** PDFs
** PDFs
To look up the x86 instructions, two things are required:
- the =pdftotext= command line tool from Poppler:

20
layers/+tags/gtags/README.org
View File

@ -14,11 +14,11 @@
- [[#emacs-configuration][Emacs Configuration]]
- [[#disabling-by-default][Disabling by default]]
- [[#usage][Usage]]
- [[#language-support][Language Support]]
- [[#built-in-languages][Built-in languages]]
- [[#exuberant-ctags-languages][Exuberant ctags languages]]
- [[#universal-ctags-languages][Universal ctags languages]]
- [[#pygments-languages-plus-symbol-and-reference-tags][Pygments languages (plus symbol and reference tags)]]
- [[#language-support][Language Support]]
- [[#built-in-languages][Built-in languages]]
- [[#exuberant-ctags-languages][Exuberant ctags languages]]
- [[#universal-ctags-languages][Universal ctags languages]]
- [[#pygments-languages-plus-symbol-and-reference-tags][Pygments languages (plus symbol and reference tags)]]
- [[#eldoc-integration][Eldoc integration]]
- [[#key-bindings][Key bindings]]
- [[#helm][Helm]]
@ -172,8 +172,8 @@ GTAGSLABEL environment variable, use this command instead:
gtags --gtagslabel=pygments
#+END_SRC
*** Language Support
**** Built-in languages
** Language Support
*** Built-in languages
If you do not have =ctags= or =pygments= enabled gtags will only produce
tags for the following languages:
@ -183,7 +183,7 @@ tags for the following languages:
- php
- yacc
**** Exuberant ctags languages
*** Exuberant ctags languages
If you have enabled =exuberant ctags= and use that as the backend (i.e.,
=GTAGSLABEL=ctags= or =--gtagslabel=ctags=) the following additional languages
will have tags created for them:
@ -201,7 +201,7 @@ will have tags created for them:
- vimscript
- windows-scripts (.bat .cmd files)
**** Universal ctags languages
*** Universal ctags languages
If instead you installed you the newer/beta =universal ctags= and use that
as the backend (i.e., GTAGSLABEL=ctags or --gtagslabel=ctags) the following
additional languages will have tags created for them:
@ -211,7 +211,7 @@ additional languages will have tags created for them:
- go
- rust
**** Pygments languages (plus symbol and reference tags)
*** Pygments languages (plus symbol and reference tags)
In order to look up symbol references for any language not in the built in
parser you must use the pygments backend. When this backend is used global
actually uses both ctags and pygments to find the definitions and uses of