Commit graph

797 commits

Author SHA1 Message Date
duianto
dba5dd34e1 CONVENTIONS.org: update evilify macro name 2017-05-14 12:33:16 -04:00
Benjamin Reynolds
68364b969e Add custom layout for mu4e buffers
This commit adds a custom layout for mu4e related buffers. Four different major
modes are used in mu4e buffers based on their purpose, so a function is used to
add buffers in these modes to the new layout. This setup is largely based on
that of the ERC layers custom layout.
2017-05-04 00:32:35 -04:00
Benjamin Reynolds
9e17d9e6bf Add @Slack layout to documented list of default custom layouts
This commit adds the custom layout defined in the Slack layer to the list of
custom layouts that spacemacs ships with in `doc/DOCUMENTATION.org`
2017-05-04 00:31:08 -04:00
Nikolai Myllymäki
3b4aff8cdb Remove redundant installation instructions
The readme.md documents the first startup comprehensively, so the duplicate
information is removed from the beginners tutorial.
2017-05-03 22:47:58 -04:00
Darkhan Kubigenov
a5c94b3328 Fix typos in documentation 2017-05-03 22:46:24 -04:00
Henry Marshall
82cfce0768 Fixed url with unescaped + causing broken link 2017-05-03 08:59:05 -04:00
JAremko
94205a3e81 Fix css links and various org links 2017-04-29 10:45:52 -04:00
JAremko
f805d0ebd9 Fix spacefmt test on deleted files
Also fix some links
[ci skip]
2017-04-28 23:29:43 -04:00
JAremko
c1e4556882 Format and cleanup docs. Fix links. 2017-04-28 23:29:14 -04:00
Kepi
7e266f4f3c Improve support for fancy frame title 2017-04-28 23:16:22 -04:00
Darkhan
a488a56e8e Fix a typo in beginners tutorial 2017-04-28 23:09:52 -04:00
Rafi Khan
dc8bb7ae3b typo 2017-04-28 22:50:28 -04:00
Archenoth
45f02b09bb Minor typo in VIMUSERS Elisp intro ("arg1 arg1" -> "arg1 arg2") 2017-04-28 22:25:24 -04:00
Fabian Wilk
fe9de0afd8 Add key binding SPC d w SPC for built-in commnand just-one-space 2017-04-23 13:03:51 -04:00
Kristoffer Haugsbakk
a9a8f1e905 docs: correct keybinding for helm-resume
The keybinding has changed from `SPC h l` to `SPC r l`; see the changelog, entry
0.200.0 (2016/10/02). So correct the documentation to reflect that.

`SPC h l` is currently bound to `helm-spacemacs-help-layers` (on branch
`develop`).
2017-04-20 23:13:37 -04:00
Kristoffer Haugsbakk
31a11abd54 Use RET instead of return for return key
It is an Emacs-wide convention to use `RET` when referring to the act of
pressing the return key.  Spacemacs seems to follow that convention as well.  So
fix some Org files that were deviating from this convention.

In particular, replace usages of `<return>` and `return` with `RET`.

Also update the description of an `M-RET` keybinding[1] based on the docstring
of `ido-select-text`.

[1]: Suggested-by: bmag <bmag@users.noreply.github.com>
2017-04-20 23:09:46 -04:00
Jonas Strømsodd
be72fe17f4 Update documentation on window manipulation to clarify behavior of window 0 2017-04-20 23:00:34 -04:00
Chase Adams
c646a6b22d change spelling and grammar in quick start 2017-04-20 22:58:53 -04:00
Nikolai Myllymäki
419fc605ec Add commands for font install on macOS
Add brew commands for Source Code Pro installation to installation instructions
in README.md, describe command usage and add missing capitalisation.

Concentrate installation instructions

Make installation instructions more beginner-friendly, concise and thorough:
- Add Git to prerequisites
- Move specific git clone instructions for Windows users from beginners
tutorial to README.md
- Move fallback font installation instructions and info from beginners tutorial
to README.md
- Remove redundant install steps from beginners tutorial
- Misc. typo fixes and wording improvements
2017-04-20 22:29:25 -04:00
person808
6dc447cf5f Documentation fixes.
Fixes:
  - Typo
  - Code block indentation
  - Put keybindings on one line so they look nicer when viewed in Spacemacs
  - Make one sentence sound better
2017-04-19 22:51:08 -04:00
Max Nordlund
37de114ea5 Fix documentation about replace mode
There is in fact a replace mode in vanilla Vim, see
http://vimdoc.sourceforge.net/htmldoc/insert.html#mode-replace
and not exclusive to Evil.
2017-04-17 23:43:13 -04:00
Ric da Silva
c1e805cb46 Add string inflection to spacemacs-editing
Add string inflection doc
2017-04-17 23:31:58 -04:00
syl20bnr
f20ef3477d Remove redundant create-align-repeat "brackets" 2017-04-17 23:27:24 -04:00
Nikolai Myllymäki
ec08c9d734 Fix links and instructions in beginners tutorial
- Fix broken org link, make links relative as in other documentation and get
them to work correctly in github, spacemacs.org and Spacemacs.

- Add instructions for copying the tutorial and editing it for org mode intro
purposes. The instructions for testing org-mode did not work when the tutorial
was opened in read-only mode.

- The link to the FAQ was said to be online while it would open inside
Spacemacs when clicked. The wording is improved to reflect the actual
behaviour.

- Replace instances of "enter" with "~RET~".
2017-04-17 23:18:35 -04:00
smile13241324
c8e8280660 Add missing "m key" to debugging and help base prefix 2017-04-17 23:11:00 -04:00
Phil Pirozhkov
2dc9feafb4 Update Evil repo
Gitorious is now defunct and Evil moved to Bitbucket
2017-04-17 22:42:08 -04:00
Steven Allen
830b252bdc Change the frame-killer mapping to SPC q f
It was `SPC q z` but:

1. 'z' is not a mnemonic for "frame" (although it may be more familiar to vim
   users).
2. More importantly, it's *really hard* to type 'qz' on a qwerty keyboard.
2017-04-17 22:41:11 -04:00
syl20bnr
ff0bd88b0c Move all "new empty buffer" key bindings under SPC b N
and add documentation
2017-04-17 22:10:16 -04:00
smile13241324
289e963218 Remove CUSTOM ID from documentation to fix #8216
Previously we entered the CUSTOM IDs manually into the
documentation files to fix the html export.
However today this is done automatically during export.
In this case the manually added ids are interfering
with this process and consequently are visible in the
web pages. Therefore I have removed them again.
2017-04-17 18:37:26 -04:00
syl20bnr
a4be86cb5d Update documentation to remove explicit mentions to helm
Move some helm explicit sections the helm layer README.
2017-04-16 11:14:59 -04:00
duianto
c9e21e0e53 Update doc/LAYERS.org: Fix 2 Use-package titles/links
problem:  The TOC link: Layers tips and tricks > Use-package
          navigates to: The Emacs loading process > Use-package
solution: Rename: Layers tips and tricks > Use-package
          to: Layers tips and tricks > Use-package init and config
2017-04-16 11:14:59 -04:00
Sebastien Duthil
b756498ae8 fix some typos in the docs 2017-04-16 11:14:59 -04:00
Jonathan Arnett
817f6e9fc0 Minor typo fix
Change "no tied to" to "not tied to" for the `keybindings.el` file description.
2017-04-13 00:31:51 -04:00
syl20bnr
f7599c4665 core: Fix spacemacs/diminish-undo and add documentation about it 2017-04-13 00:17:24 -04:00
Reverend Homer
4c3e3b86a7 doc: fix typo 2017-04-12 23:47:30 -04:00
syl20bnr
d65cd1ebd9 Add documentation for SPC x a { 2017-04-11 23:50:06 -04:00
syl20bnr
bb57dc8cd9 Move symon to spacemacs-modeline layer 2017-04-11 23:36:13 -04:00
syl20bnr
5cb0fd735b doc: fix nesting 2017-04-10 00:07:10 -04:00
John Wood
de6284d963 Fix typos 2017-04-09 17:17:50 -04:00
bmag
a1c02ba323 dsm-line-numbers: support parent modes, fix mode restriction
Specifying parent modes (e.g. prog-mode) in :enabled-for-modes and
:disabled-for-modes keys in dotspacemacs-line-numbers catches derived
modes (e.g. c-mode) as well.

Fix bug where an empty :disabled-for-modes and a non-empty :enabled-for-modes
enabled line numbers everywhere, instead of only in modes specified in
:enabled-for-modes. (see https://github.com/syl20bnr/spacemacs/issues/8482)

Add auxiliary function spacemacs/derived-mode-p, similar to derived-mode-p but
takes a major-mode as an argument instead of using the current major-mode.
2017-03-13 21:04:00 +02:00
syl20bnr
6212795523 core: allow users to set custom-file variable
In this case Spacemacs won't write custom variables to the
dotspacemacs/emacs-custom-settings variable.

Move setq and add-advice to spacemacs/initialize-custom-file which is now
called in spacemacs/init function just after dotspacemacs/user-init function.
2017-03-12 12:10:21 -04:00
antonshwab
5cddd56395 Fix typo
Fix typo
2017-02-19 19:37:16 +02:00
syl20bnr
87cd00eac7 conventions: update debug conventions
Step in and Step out are now, i and o respectively.
Inspect a value is now v.
Next step is now s.

These new conventions better fit evilificiation.
2017-02-12 13:02:55 -05:00
syl20bnr
252547aa81 core: add support for :location keyword in dotspacemacs-themes
New functions:
- configuration-layer/get-location-directory which return the location on disk
given a location
- spacemacs//get-theme-directory which returns the location on disk of the
theme

Add note in documentation to warn about the directory name when :location local
is used, the directory name is the package name not the theme name.
2017-02-05 23:47:17 -05:00
deb0ch
a28e17c4d3 line numbers: finer configuration of line numbers activation 2017-02-05 12:47:19 -05:00
syl20bnr
c7e47de938 evil: enable evil-search search module in evil state.
Add new hybrid variable hybrid-mode-use-evil-search-module to switch evil
search module to its own which is closer to Vim. Default is nil.

Fixes #5101
2017-02-03 19:36:19 -05:00
syl20bnr
9ab4453029 Add convention for clean build project. 2017-02-03 11:40:19 -05:00
syl20bnr
415b29b140 core: dotspacemacs-themes entries now accept package properties
It is now possible to use package properties like :location in
dotspacemacs-themes.

Added hooks ran at the beginning and end of configuration-layer/sync:
- configuration-layer-pre-sync-hook
- configuration-layer-post-sync-hook

configuration-layer-pre-sync-hook is used to hook the new function
spacemacs//add-theme-packages-to-additional-packages. This new function updates
dotspacemacs--additional-theme-packages variables.

Update documentation to mention the new feature.
2017-02-01 22:59:03 -05:00
duianto
bb8537c3fc
Update layout and workspace key binding documentation
Changed the `[1..9, 0]` and `[C-1..C-9, C-0]` entries to
`[0..9]` and `[C-0..C-9]`, in both the layout and workspace
key bindings sections.
2017-02-01 16:28:00 +02:00
syl20bnr
0c04d3892d doc: add mention of layers.el file in LAYERS.org 2017-01-15 23:14:20 -05:00
bmag
0c3afd5a3f Fix old documentation of loading order 2017-01-13 23:11:38 +02:00
syl20bnr
3a96adf75d Add achievement for 10000th star
Goes to colt365
2017-01-12 23:44:51 -05:00
nikolaiam
76213f982c Fix export-breaking org links in documentation
As discussed in #8054 and #8136, org doesn't always export links correctly if
the syntax deviates from the one given on the org mode website. This results
in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956
and possibly others.

This modifies all links not already fixed in #8136. Internal links are
handled with Custom IDs. External file links are formatted according to org
guidelines as well (see bottom), and if they point to a specific headline in an
external file, a custom ID is created as well.

Fixes #6722, #8036, #7956, #7916 as well as other unreported broken
links.

http://orgmode.org/manual/External-links.html#External-links
http://orgmode.org/manual/Internal-links.html#Internal-links

TODO: make Custom IDs invisble in space-org-mode
2017-01-12 22:49:07 -05:00
smile13241324
84c36ade86 Fix links in documentation which breaks org html export
Since org 9 internal links must be declared either as #customID
or textTargetOrFullTextSearch. Relative path links must
be either file:relative/path or ./relative/path. Many links
are using the #customID form to trigger a full text search which is not
defined as to the org documentation. In addition relative file paths are
declared as relative/path which is also not defined. If this is done
the html export can fail. Therefore these links must be corrected
for the files where they break the html export.
Fixes #8054 for all spacemacs documentation files.
2017-01-12 22:48:57 -05:00
Nikolai Myllymäki
f4368bc092
Add info about the fallback fonts 2017-01-04 20:27:52 +02:00
Nikolai Myllymäki
0265aca91a
Add explanation of menu usage and accessing files 2017-01-04 20:27:49 +02:00
Nikolai Myllymäki
c5a6006563
Direct font installation link to the right section 2017-01-04 20:27:45 +02:00
Nikolai Myllymäki
2dd0befc6a
Add Spacemacs ABC and Gitter chat to further info 2017-01-04 20:27:40 +02:00
Nikolai Myllymäki
4de3611648
Improved link formatting, minor text edits
Also fixed a broken link
2017-01-04 20:27:30 +02:00
Leandro Lisboa Penz
998f5dcf9a
Fix a link on beginner's tutorial 2017-01-04 20:26:17 +02:00
syl20bnr
74fdbb6795 Refactor and simplify company backends declaration
Enabling a company backend for a specific mode was a tedious tasks with code
scattered at different locations, one for local variable definitions, one for
company hook function definitions and another where the backends were pushed to
the local variables (which was problematic, since we ended up pushing the same
backends over and over again with `SPC f e R`, pushes have been replaced by
add-to-list calls in the new macro).

All these steps are now put together at one place with the new macro
spacemacs|add-company-backends, check its docstring for more info on its
arguments.

This macro also allows to define arbitrary buffer local variables to tune
company for specific modes (similar to layer variables via a keyword :variables)

The code related to company backends management has been moved to the
auto-completion layer in the funcs.el file. A nice side effect of this move is
that it enforces correct encapsulation of company backends related code. We can
now easily detect if there is some configuration leakage when the
auto-completion layer is not used. But we loose macro expansion at file loading
time (not sue it is a big concern though).

The function spacemacs|enable-auto-complete was never used so it has been
deleted which led to the deletion of the now empty file core-auto-completion.el.

The example in LAYERS.org regarding auto-completion is now out of date and has
been deleted. An example to setup auto-completion is provided in the README.org
file of the auto-completion layer.
2017-01-02 00:39:04 -05:00
John Stevenson
8840c94448 evil-escape documentation link update
Updated the FAQ evil-escape documentation link to point to the "14.1.1 Escaping" section of the documentation, where the evil-escape function is described.

Currently the FAQ evil-escape documentation link points to http://spacemacs.org/doc/DOCUMENTATION.html#orgheadline78, which takes you to the "13.1 Layouts" section of the documentation.
2016-12-27 19:20:00 +00:00
Adel Qalieh
8e7fe6e1f2
Add keybinding for spacemacs/alternate-window
spacemacs/alternate-window was suggested to switch between the last selected
window, or the window-analog of SPC TAB (spacemacs/alternate-buffer). This is
part of a larger family of functions, such as spacemacs/jump-to-last-layout on
SPC l TAB and eyebrowse-last-window-config on SPC l w TAB.

Resolves #7845
2016-12-27 09:50:10 +02:00
Joe Lane
43e199b6a5 add copy key to neotree
CHANGES
-------
Add new keybinding to neotree to allow the copying of nodes from the neotree
buffer. Update documentation as well.

WHY
-------
There appear to be all other common file operations bound to the neotree buffer,
however copying of a node is not.
2016-12-09 18:19:52 +02:00
d12frosted
96e6de20f6 add some notes on ivy usage 2016-11-22 20:41:45 -05:00
Rob Donnelly
779072a651 Documentation has outdated shortcut
The suggestions to use SPC ; SPC y is from the previous versions where SPC y was bound to avy-goto-line.
Now that command is bound to SPC j l
2016-11-20 18:59:22 -05:00
Rory O’Kane
31bc9425ff Fix typo in beginner’s tutorial – “differend” 2016-11-20 18:54:48 -05:00
syl20bnr
237b2a7373 Move SPC b m to kill other buffers to SPC b C-d
Also move `SPC b C-d` to kill other buffer with regexp to `SPC b C-D`
Update Documentation accordingly.
2016-11-20 13:27:16 -05:00
Aron Griffis
385c12743a Add ripgrep support
* Add rg to helm completion layer
* Add rg to ivy layer
* Prepend rg to dotspacemacs-search-tools
* Add rg to documentation
2016-11-11 15:22:03 +02:00
syl20bnr
c379cd46cd Beginnier tutorial: refill paragraphs to respect 80col/line 2016-11-07 10:05:27 -05:00
Nikolai Myllymäki
8dd2eb410f Add beginners tutorial - further amendments
Amend suggested fixes:
- Add chapter on key notation
- Fix document structure according to conventions
- Add note on emacs path on Windows
- Expand on evil and emacs mode explanations
- Expand on first startup procedure
- Various typo fixes and clarifications
2016-11-07 10:02:45 -05:00
deb0ch
855d786100
Add duplicate-line-or-region to layer better-defaults
from https://www.emacswiki.org/emacs/CopyingWholeLines

Duplicate current line, or region if active.
With argument N, make N copies.
With negative N, comment out original line and use the absolute value.

keybinding: `SPC x l d` (text - line - duplicate)
2016-11-02 21:07:15 +02:00
Stratos Gerakakis
4f46efcf07 Simple misspelling typos... 2016-10-31 08:35:23 +02:00
Michael Weiss
4a02c8a90a Fix some minor mistakes and typos in the documentation 2016-10-30 08:12:00 +02:00
Eivind Fonn
4bf8e529b8 Move SPC p C-g to SPC p G 2016-10-28 13:44:29 +02:00
Willian van der Velde
187290b6e0 Updates links to layers 2016-10-23 19:44:35 +02:00
syl20bnr
2c5b628570 Move SPC t H to SPC t h s
SPC t h is the prefix for toggling highlighting stuff.
2016-10-23 19:44:35 +02:00
jupl
253276e0d1 Add toggle for syntax highlighting (via font-lock) 2016-10-23 19:44:35 +02:00
syl20bnr
7cdd998e78 Inverse SPC t m t and SPC t m T
Toggling the time is a segment so it is more consistent with the rest
of the lowercase keys.
Toggling the whole mode-line feels better on a capital letter.
2016-10-23 19:44:35 +02:00
jupl
e384b2124b Add toggle to display time in modeline 2016-10-23 19:44:35 +02:00
syl20bnr
d04ab325db Add achievements
9000th star to deb0ch
2016-10-18 22:40:38 -04:00
syl20bnr
66d9f38a45 Add hide/show comments on SPC c h 2016-10-17 15:32:43 -04:00
Peter Nagy
781aa079ab Update layer docs for packages.el to note where should local packages reside
The information about location of local packages is noted in the parent section. While this can be considered enough I kept re-reading `packages.el` and couldn't find the information. Adding the information here as well makes the section more self-contained.
2016-10-17 13:56:53 +02:00
syl20bnr
5e4f609a19 FAQ: add explanation about the usage of the word "distribution" 2016-10-09 12:25:56 -04:00
bmag
c337eb083e Paste TS: fix doc 2016-10-08 19:36:11 +02:00
Andrew Schwartzmeyer
00e0b99c35 Change 'SPC :' to 'SPC SPC' in quick start
The former was deprecated.
2016-10-08 19:27:11 +02:00
syl20bnr
bcf2ce6ca4 Move SPC b k to SPC b C-d 2016-10-03 00:23:15 -04:00
ChuntaoLu
e659965a70
fix typo 2016-09-23 10:45:59 +03:00
bmag
753b81275c dumb-jump: bind key instead of enable mode 2016-09-16 15:07:05 +02:00
syl20bnr
80694ea676 Add some achievements
justbur
 d12frosted
 deb0ch
 shsteven
 JAremko
 TheBB
 travisbhartwell
2016-09-05 21:47:00 -04:00
JAremko
95f4119366 disabled by default centering in space-doc-mode.
Fix centered-buffer-mode conflict with Emacs 25
2016-09-05 21:12:52 -04:00
syl20bnr
4c72b369c3 Typo in DOCUMENTATION.org 2016-08-31 22:34:57 -04:00
syl20bnr
d998c7edf5 Move SPC p G to SPC p C-g to regenerate tags
I have the impression that SPC p G can be used for something more
useful regarding tags.
Tags regeneration triggers a process that can take a while to make
more sense to make it less accessible.

If there is nothing useful to be added to SPC p G we can consider
reverting this commit.
2016-08-31 22:32:27 -04:00
syl20bnr
1b4efdddc3 Move projectile-find-tag from SPC p y to SPC p g
SPC p g was free so why not using it.
2016-08-31 22:32:22 -04:00
Eivind Fonn
3a28393a23 Implement :enabled-for layer keyword 2016-08-31 22:15:13 -04:00
bmag
64a1b85523 NeoTree: clarify docs 2016-08-30 15:55:48 +02:00
Eivind Fonn
0b92e47189 Add note about ivy/helm choice 2016-08-30 15:51:26 +02:00
Allen Li
5877d2fd54
Fix references to declare-used-layer(s) in docs 2016-08-25 21:01:31 -07:00
syl20bnr
c1c2d06f36 Remove SPC j F and SPC j V and add SPC m g G in Emacs Lisp
SPC j F and SPC j V don't fit the SPC j prefix because they require
the thing under point to be an Emacs lisp thing, which means that these
bindings should be major mode specific.
To replace them and accordingly to the convention the key bindings
SPC m g G in Emacs Lisp buffers has been added to go to definition
in other window.

SPC j f and SPC j v (minus letters) don't require the current buffer
to be Emacs Lisp and thus I only updated the documentation about them
mentioning that they're about Emacs Lisp variables and functions.
2016-08-25 21:19:21 -04:00
JAremko
328c6b81aa Add aspect ratio check for centering.
Fix git conflict.
minor improvements and cleanup.
2016-08-21 17:29:19 +02:00