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

Update README.org template 

Replace some local Org links with GitHub ones
This commit is contained in:
JAremko 2017-07-16 19:37:37 +03:00
parent 2ecfbef20a
commit 106f98497e
9 changed files with 43 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
core/templates/README.org.template
View File

@ -5,13 +5,19 @@
# TOC links should be GitHub style anchors. # TOC links should be GitHub style anchors.
* Table of Contents :TOC_4_gh:noexport: * Table of Contents :TOC_4_gh:noexport:
- [[#decsription][Description]] - [[#description][Description]]
- [[#install][Install]] - [[#features][Features:]]
- [[#key-bindings][Key bindings]] - [[#install][Install]]
- [[#key-bindings][Key bindings]]
* Description * Description
This layer does wonderful things: This layer adds support for something.
- thing01
** Features:
- Autocomplete
- Linting
- Refactoring
- ...
* Install * Install
To use this configuration layer, add it to your =~/.spacemacs=. You will need to To use this configuration layer, add it to your =~/.spacemacs=. You will need to
@ -23,6 +29,7 @@ file.
| Key Binding | Description | | Key Binding | Description |
|-------------+----------------| |-------------+----------------|
| ~SPC x x x~ | Does thing01 | | ~SPC x x x~ | Does thing01 |
# Use GitHub URLs if you wish to link a Spacemacs documentation file or its heading. # Use GitHub URLs if you wish to link a Spacemacs documentation file or its heading.
# Examples: # Examples:
# [[https://github.com/syl20bnr/spacemacs/blob/master/doc/VIMUSERS.org#sessions]] # [[https://github.com/syl20bnr/spacemacs/blob/master/doc/VIMUSERS.org#sessions]]

12
doc/DOCUMENTATION.org
View File

@ -263,7 +263,7 @@ project.
* Who can benefit from this? * Who can benefit from this?
- Spacemacs was initially intended to be used by *Vim users* who want to go to - Spacemacs was initially intended to be used by *Vim users* who want to go to
the next level by using Emacs (see [[file:VIMUSERS.org][guide]] for Vimmers). But it is now the next level by using Emacs (see [[https://github.com/syl20bnr/spacemacs/blob/master/doc/VIMUSERS.org][guide]] for Vimmers). But it is now
perfectly *usable by non Vim users* by choosing the =emacs= editing style. perfectly *usable by non Vim users* by choosing the =emacs= editing style.
- It is also a good fit for people wanting to *lower the [[https://en.wikipedia.org/wiki/Repetitive_strain_injury][risk of RSI]]* induced by - It is also a good fit for people wanting to *lower the [[https://en.wikipedia.org/wiki/Repetitive_strain_injury][risk of RSI]]* induced by
@ -329,7 +329,7 @@ and choosing a rollback slot (sorted by date). This button uses the command
* Configuration layers * Configuration layers
This section is an overview of layers. A more extensive introduction to writing This section is an overview of layers. A more extensive introduction to writing
configuration layers can be found [[file:LAYERS.org][here]] (recommended reading!). configuration layers can be found [[https://github.com/syl20bnr/spacemacs/blob/master/doc/LAYERS.org][here]] (recommended reading!).
** Purpose ** Purpose
Layers help collect related packages together to provide features. For example, Layers help collect related packages together to provide features. For example,
@ -393,7 +393,7 @@ properly. For instance if package =A= depends on =B= then you can configure
(with-eval-after-load 'B ...) (with-eval-after-load 'B ...)
#+END_SRC #+END_SRC
For details on installing packages using quelpa or local packages see [[file:LAYERS.org::packages.el][LAYERS]]. For details on installing packages using quelpa or local packages see [[https://github.com/syl20bnr/spacemacs/blob/master/doc/LAYERS.org#packagesel][LAYERS]].
**** Initialization **** Initialization
To initialize a package =xxx=, define a function with this format in To initialize a package =xxx=, define a function with this format in
@ -589,7 +589,7 @@ To use a configuration layer, declare it in your dotfile by adding it to the
*Note:* In this documentation a =used layer= is equivalent to a =declared *Note:* In this documentation a =used layer= is equivalent to a =declared
layer=. layer=.
For instance, [[Thank you][RMS]] can add his private configuration layer like this: For instance, [[#thank-you][RMS]] can add his private configuration layer like this:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(setq-default dotspacemacs-configuration-layers (setq-default dotspacemacs-configuration-layers
@ -984,9 +984,9 @@ can be bound in your =~/.spacemacs= file or in individual layers.
* GUI Elements * GUI Elements
Spacemacs has a minimalistic and distraction free graphical UI: Spacemacs has a minimalistic and distraction free graphical UI:
- custom [[https://github.com/milkypostman/powerline][powerline]] mode-line [[Flycheck integration][with color feedback]] according to current [[https://github.com/flycheck/flycheck][Flycheck]] status - custom [[https://github.com/milkypostman/powerline][powerline]] mode-line [[#flycheck-integration][with color feedback]] according to current [[https://github.com/flycheck/flycheck][Flycheck]] status
- Unicode symbols for minor mode lighters which appear in the mode-line - Unicode symbols for minor mode lighters which appear in the mode-line
- [[Errors handling][custom fringe bitmaps]] and error feedbacks for [[https://github.com/flycheck/flycheck][Flycheck]] - [[#errors-handling][custom fringe bitmaps]] and error feedbacks for [[https://github.com/flycheck/flycheck][Flycheck]]
** Color themes ** Color themes
*** Default theme *** Default theme

8
doc/FAQ.org
View File

@ -83,7 +83,7 @@ To install packages that does not belong to any Spacemacs layers, you can:
which will prevent Spacemacs from removing the packages you installed which will prevent Spacemacs from removing the packages you installed
manually. manually.
To create a new configuration layer see the [[file:QUICK_START.org][quick start guide]] for more info. To create a new configuration layer see the [[https://github.com/syl20bnr/spacemacs/blob/master/doc/QUICK_START.org][quick start guide]] for more info.
** How to fix package download errors when installing Spacemacs ? ** How to fix package download errors when installing Spacemacs ?
Since 0.105.0 HTTPS protocol is used by default to download packages. If your Since 0.105.0 HTTPS protocol is used by default to download packages. If your
@ -110,17 +110,17 @@ This is most likely caused by a corrupted package archive. Try deleting your
** The Spacemacs banner is ugly, what should I do? ** The Spacemacs banner is ugly, what should I do?
Install the default font supported by Spacemacs or choose a fixed width font. Install the default font supported by Spacemacs or choose a fixed width font.
More information in the font section of the [[file:DOCUMENTATION.org][documentation]]. More information in the font section of the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][documentation]].
** The powerline separators are ugly, how can I fix them? ** The powerline separators are ugly, how can I fix them?
Use the property =:powerline-scale= of the variable =dotspacemacs-default-font=. Use the property =:powerline-scale= of the variable =dotspacemacs-default-font=.
See font section of the [[file:DOCUMENTATION.org][documentation]] for more details. See font section of the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][documentation]] for more details.
** The powerline separators have no anti-aliasing, what can I do? ** The powerline separators have no anti-aliasing, what can I do?
Emacs powerline uses XMP images to draw the separators in a graphical Emacs powerline uses XMP images to draw the separators in a graphical
environment. You can have anti-aliasing if you use the =utf8= separator. Note environment. You can have anti-aliasing if you use the =utf8= separator. Note
that by default the =utf8= separator is used in a terminal. See the powerline that by default the =utf8= separator is used in a terminal. See the powerline
section in the font section of the [[file:DOCUMENTATION.org][documentation]]. section in the font section of the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][documentation]].
** Why is after-init-hook not executed? ** Why is after-init-hook not executed?
Don't launch Spacemacs with =emacs -q -l init.el= command. This command will run Don't launch Spacemacs with =emacs -q -l init.el= command. This command will run

8
doc/QUICK_START.org
View File

@ -39,7 +39,7 @@ Any configuration layers you create must be explicitly loaded in =~/.spacemacs=.
Note: For your privacy, the contents of the =private= directory are not Note: For your privacy, the contents of the =private= directory are not
under source control. See the section on private configuration management in under source control. See the section on private configuration management in
the [[file:DOCUMENTATION.org][documentation]]. the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][documentation]].
* Dotfile (.spacemacs) * Dotfile (.spacemacs)
As mentioned =.spacemacs= controls which configuration layers to load and As mentioned =.spacemacs= controls which configuration layers to load and
@ -66,7 +66,7 @@ dotspacemacs-configuration-layers '(auto-completion smex)
#+END_SRC #+END_SRC
Some configuration layers support configuration variables to expose granular Some configuration layers support configuration variables to expose granular
control over layer-specific features, [[file:../layers/+source-control/git/README.org][git layer]] being one such example. control over layer-specific features, [[https://github.com/syl20bnr/spacemacs/blob/develop/layers/+source-control/git/README.org][git layer]] being one such example.
Variables can be directly set within =dotspacemacs-configuration-layers= like so: Variables can be directly set within =dotspacemacs-configuration-layers= like so:
#+BEGIN_SRC elisp #+BEGIN_SRC elisp
@ -81,7 +81,7 @@ At anytime you can apply the changes made to the dotfile or layers
_without restarting_ Spacemacs by pressing ~SPC f e R~. _without restarting_ Spacemacs by pressing ~SPC f e R~.
The [[https://github.com/syl20bnr/spacemacs/blob/master/core/templates/.spacemacs.template][dotfile template]] contains further information about how to customize The [[https://github.com/syl20bnr/spacemacs/blob/master/core/templates/.spacemacs.template][dotfile template]] contains further information about how to customize
Spacemacs. See the dotfile configuration section of the [[file:DOCUMENTATION.org::#dotfile-configuration][documentation]] for Spacemacs. See the dotfile configuration section of the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org#dotfile-configuration][documentation]] for
more details. more details.
* Dotdirectory (~/.spacemacs.d) * Dotdirectory (~/.spacemacs.d)
@ -174,4 +174,4 @@ about functions, variables, modes etc. These commands are bound thusly:
| ~SPC h d v~ | describe-variable | | ~SPC h d v~ | describe-variable |
* How-To's * How-To's
Some quick =how-to's= are compiled in the [[file:FAQ.org::#how-do-i][FAQ.]] Some quick =how-to's= are compiled in the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/FAQ.org#how-do-i][FAQ.]]

18
doc/VIMUSERS.org
View File

@ -42,7 +42,7 @@ the gap between vim and Spacemacs. While some information may be duplicated,
this does not replace the Spacemacs documentation. It is recommended that you this does not replace the Spacemacs documentation. It is recommended that you
read both files to fully understand Spacemacs. read both files to fully understand Spacemacs.
[[file:DOCUMENTATION.org][Spacemacs Documentation]] [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][Spacemacs Documentation]]
* Philosophy * Philosophy
One misconception many vim users have is that Spacemacs is an Emacs /clone/ of One misconception many vim users have is that Spacemacs is an Emacs /clone/ of
@ -60,7 +60,7 @@ for new users. This section attempts to clear up any confusion.
*** Modes vs. States *** Modes vs. States
In vim you have various editing modes like =insert mode= and =visual mode= to In vim you have various editing modes like =insert mode= and =visual mode= to
manipulate text. In Emacs, we have [[file:DOCUMENTATION.org::#states][states]]. These are equivalent to vim modes. manipulate text. In Emacs, we have [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org#states][states]]. These are equivalent to vim modes.
For example, =evil-insert-state= is the same as =insert-mode= in vim. For example, =evil-insert-state= is the same as =insert-mode= in vim.
A =minor-mode= in Emacs is like a feature that is activated. For example, A =minor-mode= in Emacs is like a feature that is activated. For example,
@ -80,7 +80,7 @@ layer includes support for auto-completion, documentation look-up, tests, and
much more by using several different packages. This keeps you from thinking much more by using several different packages. This keeps you from thinking
about what packages to install, and instead worry about what features you want. about what packages to install, and instead worry about what features you want.
More information on layers can be found in the [[#customization][customization]] section and in the More information on layers can be found in the [[#customization][customization]] section and in the
[[file:DOCUMENTATION.org::#configuration-layers][documentation]]. There is also a more in-depth guide on writing layers [[file:LAYERS.org][here]]. [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org#configuration-layers][documentation]]. There is also a more in-depth guide on writing layers [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org][here]].
*** Transient-states *** Transient-states
Spacemacs provides a special functionality called transient-states. Transient-states Spacemacs provides a special functionality called transient-states. Transient-states
@ -99,7 +99,7 @@ Spacemacs uses ~SPC~ as its ~<Leader>~ key. This document will use ~SPC~ to refe
the ~<Leader>~ key. All keybindings are mnemonic and are organized under the the ~<Leader>~ key. All keybindings are mnemonic and are organized under the
~<Leader>~ key. For example, the keybindings for language-specific commands are ~<Leader>~ key. For example, the keybindings for language-specific commands are
always under the ~SPC m~ prefix. A full list of conventions used in Spacemacs is always under the ~SPC m~ prefix. A full list of conventions used in Spacemacs is
[[file:CONVENTIONS.org][here]]. Note that all keybindings can be changed. [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/CONVENTIONS.org][here]]. Note that all keybindings can be changed.
Spacemacs uses [[https://github.com/justbur/emacs-which-key][which-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:
@ -134,7 +134,7 @@ are located under the ~SPC b~ prefix.
**** Special buffers **** Special buffers
By default Emacs creates a lot of buffers that most people will never need, like By default Emacs creates a lot of buffers that most people will never need, like
=*Messages*=. Spacemacs automatically ignores these when using these =*Messages*=. Spacemacs automatically ignores these when using these
key bindings. More information can be found [[file:DOCUMENTATION.org::#special-buffers][here]]. key bindings. More information can be found [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org#special-buffers][here]].
*** Windows *** Windows
Windows are like splits in vim. They are useful for editing multiple files at Windows are like splits in vim. They are useful for editing multiple files at
@ -359,16 +359,16 @@ execute code before or after a package loads. It would look like this:
**Note**: Only one layer can have a =init= function for a package. If you want **Note**: Only one layer can have a =init= function for a package. If you want
to override the configuration of a package in another layer, use a to override the configuration of a package in another layer, use a
=<layer-name>/pre-init= function in addition to [[file:LAYERS.org::#use-package-hooks][use-package hooks]]. =<layer-name>/pre-init= function in addition to [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org#use-package-hooks][use-package hooks]].
If a package is not available on MELPA, you must use a local package or a If a package is not available on MELPA, you must use a local package or a
package recipe. For more details see [[file:LAYERS.org::#anatomy-of-a-layer][anatomy of a layer]]. package recipe. For more details see [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org#anatomy-of-a-layer][anatomy of a layer]].
Make sure you [[#activating-a-layer][add]] your layer to your =.spacemacs= file and restart to Make sure you [[#activating-a-layer][add]] your layer to your =.spacemacs= file and restart to
activate it. activate it.
A detailed description of the loading process and how layers work can be found in A detailed description of the loading process and how layers work can be found in
the [[file:LAYERS.org][configuration layers documentation.]] the [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/LAYERS.org][configuration layers documentation.]]
** Installing a single package ** Installing a single package
Sometimes creating a layer is a bit overkill. Maybe you just want one package Sometimes creating a layer is a bit overkill. Maybe you just want one package
@ -477,7 +477,7 @@ your =.spacemacs=:
* Other useful links * Other useful links
- [[https://www.gnu.org/software/emacs/manual/emacs.html][Emacs Manual]] - [[https://www.gnu.org/software/emacs/manual/emacs.html][Emacs Manual]]
- [[file:DOCUMENTATION.org][Spacemacs Documentation]] - [[https://github.com/syl20bnr/spacemacs/blob/develop/doc/DOCUMENTATION.org][Spacemacs Documentation]]
- [[http://ian.mccowan.space/2015/04/07/Spacemacs/][Spacemacs: A Vimmer's Emacs Prerequisites]] - [[http://ian.mccowan.space/2015/04/07/Spacemacs/][Spacemacs: A Vimmer's Emacs Prerequisites]]
- Note: The article refers to ~SPC b s~ as the keybinding to switch buffers. - Note: The article refers to ~SPC b s~ as the keybinding to switch buffers.
It is ~SPC b b~ It is ~SPC b b~

2
layers/+email/gnus/README.org
View File

@ -41,7 +41,7 @@ following:
)) ))
#+END_SRC #+END_SRC
For adding RSS Feeds please see the [[Keybindings][keybindings section]]. For adding RSS Feeds please see the [[#keybindings][keybindings section]].
* Configuring gmail * Configuring gmail

4
layers/+intl/keyboard-layout/README.org
View File

@ -157,7 +157,7 @@ operating systems.
[[file:img/programmer-dvorak-layout.png]] [[file:img/programmer-dvorak-layout.png]]
There's also a sub-layout called [[Https://www.kaufmann.no/roland/dvorak/][Programmer Dvorak]]. It reorders the number and There's also a sub-layout called [[https://www.kaufmann.no/roland/dvorak/][Programmer Dvorak]]. It reorders the number and
symbol keys, to make it easier to type common programming symbols, without symbol keys, to make it easier to type common programming symbols, without
having to hold down the shift key. The keys that differ from the /Dvorak having to hold down the shift key. The keys that differ from the /Dvorak
Simplified Keyboard/ are shown in blue. Simplified Keyboard/ are shown in blue.
@ -216,7 +216,7 @@ wikipedia keyboard layout page.
[[file:img/workman-layout.png]] [[file:img/workman-layout.png]]
As recommended in this blog post: [[Https://axiomatic.neophilus.net/posts/2013-08-13-workman-layout-for-vim.html][Workman layout for Vim]], this layout As recommended in this blog post: [[https://axiomatic.neophilus.net/posts/2013-08-13-workman-layout-for-vim.html][Workman layout for Vim]], this layout
substitutes the following keys with these mnemonics: substitutes the following keys with these mnemonics:
- (y)ank -> (h)aul - (y)ank -> (h)aul

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

@ -371,7 +371,7 @@ An alternative to syntax checking is to build your project using
reliable. The error navigation is similar to interactive haskell-mode. reliable. The error navigation is similar to interactive haskell-mode.
** Troubleshooting ** Troubleshooting
Flycheck and ghc-mod can fail silently for miscellaneous reasons. See the [[FAQ]] Flycheck and ghc-mod can fail silently for miscellaneous reasons. See the [[#faq][FAQ]]
for troubleshooting. for troubleshooting.
* FAQ * FAQ
@ -460,18 +460,18 @@ snippet into your =dotspacemacs/user-config= function.
** Flycheck displays HLint warnings but not errors ** Flycheck displays HLint warnings but not errors
The HLint checker is called *after* normal flycheck checker even if the checker The HLint checker is called *after* normal flycheck checker even if the checker
fails. Check the [[Flycheck doesn't work]] section. fails. Check the [[#flycheck-doesnt-work][Flycheck doesn't work]] section.
** I can see highlighted errors but they don't appear in the error list ** I can see highlighted errors but they don't appear in the error list
The error list is only set by flycheck. You are probably seeing errors The error list is only set by flycheck. You are probably seeing errors
highlighted by either ghc-mode or haskell-mode. Check the [[Flycheck doesn't work]] highlighted by either ghc-mode or haskell-mode. Check the [[#flycheck-doesnt-work][Flycheck doesn't work]]
section. section.
** Flycheck doesn't work ** Flycheck doesn't work
You can check what is wrong with flycheck with the =flycheck-compile= command. You can check what is wrong with flycheck with the =flycheck-compile= command.
This will show you the exact command line used and its output. This will show you the exact command line used and its output.
If you are using stack, check the [[Flycheck doesn't work with =stack=]] section. If you are using stack, check the [[#flycheck-doesnt-work-with-stack][Flycheck doesn't work with =stack=]] section.
** Flycheck doesn't work with =stack= ** Flycheck doesn't work with =stack=
First check that flycheck uses the correct checker and all the paths are First check that flycheck uses the correct checker and all the paths are

2
layers/+lang/octave/README.org
View File

@ -10,7 +10,7 @@
- [[#helpers][Helpers]] - [[#helpers][Helpers]]
* Description * Description
This layer activates [[info:octave-mode][octave-mode]] for files with =.m= This layer activates [[https://www.gnu.org/software/emacs/manual/html_mono/octave-mode.html][octave-mode]] for files with =.m=
extensions and configures spacemacs-style key bindings. extensions and configures spacemacs-style key bindings.
* Install * Install