Commit graph

821 commits

Author SHA1 Message Date
Sam Pablo Kuper 6c15fca82d Fix typo. Improve grammar. 2017-07-06 12:30:58 +02:00
syl20bnr e2e532bb49 core: change <function>p to <function>-p suffixes for consistency
Also defined aliases for backward compatibility with `usedp` functions.
2017-07-02 10:09:39 -04:00
Tim Jäger 0b2dfd0297 Implement helm-dir-search
This is equivalent to helm-file-search with the current directory as the scope
2017-07-01 12:41:03 +02:00
Ben Lloyd 51bcba8964 Added frame manipulation commands 2017-06-18 14:10:42 +02:00
duianto c6fda1a1d4 string-inflection: group which-keys, sort code/doc
Group together the which-key entries that call the same command:
k and - becomes k,-
u and _ becomes u,_

Declare a prefix name for SPC x i, this changes the SPC x entry:
from: "i -> +prefix"
to: "i -> +inflection".

Capitalize the transient state title, so that it matches the other TS titles.

Sort the code and documentation key bindings alphabetically.
2017-06-12 12:32:46 +02:00
Eivind Fonn 377cb2f417 doc: code, not keys 2017-06-10 16:32:18 +02:00
Eivind Fonn 2db9958894 string-inflection: transient state for cycling 2017-06-10 16:31:05 +02:00
Eivind Fonn c366991422 doc: add new bindings 2017-06-10 16:30:36 +02:00
Eivind Fonn 4610351b60 Format editorconfig documentation 2017-05-26 10:46:51 +02:00
Swaroop C H 7bd3390dae [docs] Mention EditorConfig support
Fixes #8960
2017-05-26 10:44:46 +02:00
Martin Račák f63132cd16 Fix Evil URL 2017-05-24 14:54:12 +02:00
ralesi d28d9beed4 emacs-restart: make debugging commands accessible. 2017-05-24 13:53:19 +02:00
Niko Felger 24c46d6698 Correct minor errors in DOCUMENTATION.org 2017-05-24 11:45:45 +02:00
ralesi e7d01304b8 ivy: define matcher desc, deprecated from package, add M-SPC 2017-05-24 10:00:53 +02:00
Eivind Fonn 5290456304 Modify evil-lion config
- Adjust keys not to collide with evil-little-word
- Add documentation
2017-05-23 11:08:06 +02:00
JAremko 6c5a0b2b14 update docs to the new toc-org format 2017-05-22 18:35:37 +03:00
JAremko dc5781f715 fix link 2017-05-22 18:32:47 +03:00
syl20bnr 7cd8e1fee5 Add password-generator package under SPC i p 2017-05-18 23:12:56 -04:00
Fuqiao Xue 6835e7605b Change HTTP to HTTPS in docs 2017-05-18 18:42:33 +02:00
Fuqiao Xue 00db1e3d4b Mention the change of dotspacemacs-check-for-update in the documentation
Its default value was changed to nil in 9d72b12245.
2017-05-18 18:22:24 +02:00
deb0ch 7280f1a6be FAQ: add "where to start learning elisp" section 2017-05-14 22:08:13 -04:00
David eaf7ef05b8 FAQ: Fix git clone command for trying Spacemacs 2017-05-14 22:05:31 -04:00
MadAnd 9f3e656c8f Add support for building multi-file local packages with Quelpa
At the moment a Quelpa recipe like `(recipe :fetcher local)` is being translated
to something like
`(recipe :fetcher file :path "my-layer/local/my-pkg/my-pkg.el")`. So we can
build simple single-file local packages.

This commit changes it to translate to the package directory instead of exact lisp
file, so we can build multi-file local packages. Thus, the above example will be
translated to `(recipe :fetcher file :path "my-layer/local/my-pkg")`.

Also, add the relevant info to LAYERS.org.
2017-05-14 13:39:02 -04:00
JAremko bd866b6c99 docker: add develop tag to spacemacs-docker images
also fix some links
2017-05-14 12:48:53 -04:00
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