Commit graph

794 commits

Author SHA1 Message Date
syl20bnr
380be09700 Fix wrong documentation introduced by previous commit. 2016-05-27 07:58:37 -04:00
syl20bnr
c35e4ee27b core: remove packages-funcs and packages-config
Change the semantic of the files for a better control over the
configuration (like being able to use package-usedp function to
guard package configuration and function definition).

This is a big change!

The list of packages of the layer must now be placed in config.el
packages.el only contains pre-init, init and post-init functions

Now both packages.el and funcs.el can use
configuration-layer/package-usedp which is much more powerful than
just configuration-layer/layer-usedp.

Also merging into one file the layer variable and the list of packages
make sense (in this case config.el).

It also means that we can quickly load all the packages declared in
all layer for helm and ivy sources by just loading the config.el file.

Expect some regressions introduced by this change, like the helm
and ivy sources, they will be fixed in other commits.
2016-05-27 00:32:05 -04:00
sooheon
15e6290151 Make check for company-mode explicit, not implicit
People may have company-mode installed without necessarily using the
auto-completion layer.
2016-05-27 00:32:05 -04:00
MadAnd
87f5d89d3e FAQ.org: fix text 2016-05-27 00:32:05 -04:00
Eivind Fonn
84fc47a106 Update powerline separator documentation 2016-05-11 09:57:49 +02:00
Eivind Fonn
9502ed1f86 Add FAQ entry about font settings 2016-05-05 15:13:30 +02:00
Li Xinyang
22a47a5e97 Fix a typo 2016-05-05 12:57:13 +02:00
Eivind Fonn
7383bac3a3 SPC cd: close more compilation windows 2016-05-05 12:50:27 +02:00
Don March
4833cd4dd5 Add small, non-structural fixes to documentation 2016-04-28 15:40:51 +02:00
NJBS
746b04f7e8 Add 7000th star to achievements 2016-04-28 15:34:51 +02:00
Fabien Dubosson
4ad9c93f59 Apply fill-paragraph after previous commit 2016-04-28 15:30:54 +02:00
Bar
940941b96e Clarify search-replace tool dependecy
Make it clearer that search-replace via helm-ag requires ag, pt, or ack.
2016-04-28 15:28:38 +02:00
tj@data-driven.de
65faafd766 Improve dotdirectory section of QUICK_START.org. 2016-04-21 20:58:53 -04:00
syl20bnr
edfc5dea98 Remove some empty lines in doc 2016-04-17 00:37:47 -04:00
Muneeb Shaikh
32f9b809ed core: update report-issue docs and docstring
* core/core-spacemacs.el (spacemacs/report-issue): update docstring
* doc/DOCUMENTATION.org (Reporting Issue table): reword key description
  to keep table width small

Fix #5155
2016-04-17 00:37:47 -04:00
Joe Hillenbrand
af6f3d0d87 Bind SPC p T to projectile-test-project
The purpose of `projectile-find-test-file` is not obvious
and it is not applicable to all languages.

Actually running the tests seems like a more useful and intuitive binding.
2016-04-17 00:37:47 -04:00
syl20bnr
c8682b5b86 Add new achievements
New section Special Mentions, first mentions attributed to:
StreakyCobra
justbur
CestDiego
JAremko

Rename Special section to Special Titles

Give The Librarian special title to JAremko
2016-04-12 23:53:18 -04:00
syl20bnr
07852abad5 Format documenation files with doc-fmt tool 2016-04-12 23:31:38 -04:00
JAremko
4cff5d12b8 Change headline "How do I..." -> "How do I:"
It's a more common form. Also it simplifies removal of
trailing ",", ";", "." from org headlines.
2016-04-12 23:19:07 -04:00
Eivind Fonn
2034195771 Remove some mentions of extensions 2016-04-11 14:53:28 +02:00
Xiao Hanyu
a797194d63 Fix typo in FAQ.org 2016-04-07 22:58:53 -04:00
Xiao Hanyu
aa1129eee0 Fix url links in VIMUSERS.org 2016-04-07 22:58:18 -04:00
Kevin Suen
c964644e64 Clarified surround command documentation 2016-04-07 22:15:09 -04:00
Robert Johnson
16e1be2691 Fix inconsistent notation of SPC key in docs
Replace all occurrences of <SPC> in org files with SPC.

Fixes syl20bnr/spacemacs#1823
2016-04-05 12:46:10 +02:00
Fabien Dubosson
d6202d3f33 Reorder projectile-replace-regexp alphabetically 2016-04-05 12:38:43 +02:00
d12frosted
5212e5539e add key binding for projectile-replace-regexp
Following https://github.com/bbatsov/projectile/pull/977
2016-04-05 12:37:53 +02:00
Fabien Dubosson
5e4c12c117 Justify a paragraph in the FAQ 2016-04-05 12:28:14 +02:00
Teo Stocco
dae39145a4 Add ansi-term information to FAQ 2016-04-05 12:28:14 +02:00
Muneeb Shaikh
25abc07359 hybrid: evilify supporting buffer as default
Fix #5645
2016-04-04 22:24:37 -04:00
syl20bnr
ac5a68e236 FAQ: move up some items in the list 2016-04-01 09:19:38 -04:00
Eivind Fonn
5fe895dd99 Add FAQ entry about HTTPS 2016-04-01 15:03:12 +02:00
person808
4010c63276 Change theme search keybinding to SPC T s.
Unify the bindings of spacemacs-helm and spacemacs-ivy. The new mnemonic
for both ivy and helm is `Themes/select`.
2016-04-01 00:26:20 -04:00
syl20bnr
3b0c1fd93d Convert org doc files with doc-fmt 2016-03-30 22:59:55 -04:00
Immortalin
95ca114ee6 Added FAQ entry for remapping paste key 2016-03-30 18:51:34 -04:00
syl20bnr
828ae8113d Replace enforce-column layer by a toggle on SPC t 8 2016-03-21 21:18:36 -04:00
syl20bnr
f48b251968 Delete SPC j b and move SPC j u to SPC j b
By convention, jump back should be on `b`, not `u`
Since `SPC j u` is free, move as well `SPC j U` to `SPC j u`.

`SPC j b` for bookmark jump is already available under `SPC f b`
2016-03-21 20:02:56 -04:00
syl20bnr
f801ceebe7 Doc: transient-state => transient state 2016-03-20 22:08:49 -04:00
syl20bnr
eaddd19e71 Update layouts and workspaces documentation 2016-03-20 22:00:45 -04:00
syl20bnr
944960daf8 Move eyebrowse to spacemacs-layouts layer and add documentation
Add toggle capability with ? for workspaces transient state
Remove the variable eyebrowse-display-help
2016-03-20 21:48:06 -04:00
Sylvain Benner
bc31eb4878 FAQ windows: Add GDIPP as an alternative for MacType 2016-03-18 17:03:30 -04:00
syl20bnr
4f07ff2030 First pass to update DOCUMENTATION.org 2016-03-17 22:03:19 -04:00
syl20bnr
5585a40db1 doc: update editing style documentation 2016-03-17 20:38:23 -04:00
syl20bnr
d52eb414bb Remove dotspacemacs-use-ido
Users should now bind ido commands themselves.
2016-03-10 23:13:19 -05:00
syl20bnr
b97b61c01c Add documentation for C-c C-e in helm-find-files 2016-03-10 23:13:19 -05:00
syl20bnr
0ca738989e Update, simplify and add smooth scrolling toggle on SPC t v 2016-03-02 09:13:09 -05:00
Johan K. Jensen
be2c471397 Fix inline code blocks
Add zero-width space because emphasis blocks can't start/end with
a comma, an apostrophe or a quote.
2016-03-01 18:51:13 +01:00
Eivind Fonn
2442431d92 Further improve helm-descbinds documentation 2016-02-25 20:33:05 +01:00
Th. Rikl
4c2d5b9d7e Explain helm-descbind prompt more detailed 2016-02-25 20:32:36 +01:00
Eivind Fonn
6355c7dd73 Add FAQ about lockfiles 2016-02-23 10:36:25 +01:00
strout
1577f25361 Fix typo 2016-02-19 23:52:59 -05:00
syl20bnr
835aa53435 Add uuidgen package to generate... UUIDs 2016-02-17 16:11:39 -05:00
Muneeb Shaikh
f8484fa8aa achievement: 6k star 2016-02-16 23:03:31 -05:00
justbur
aab007d225 evil-jumper: Remove obsolete package
The functionality is now incorporated into the evil core and this
package has been marked as obsolete.
2016-02-16 21:23:07 -05:00
adrsta
feefea4b18 Update align function documentation 2016-02-14 23:39:37 -05:00
syl20bnr
5ac51287cd Replace close words by delete in documentation 2016-02-14 23:11:52 -05:00
Robert O'Connor
4348c17433 Switch “bc”->“bd” and “wc”->“wd”
Also:
- switch spacemacs layouts to the same.
- Add “wD” for ace-delete-window
- switch window dedication toggle to “wt”
- all documentation has been updated to reflect these changes

Closes #5031
2016-02-14 23:09:45 -05:00
Fabien Dubosson
06cb27e1dc [doc] Fix some additional SPC : to SPC SPC 2016-02-07 14:39:54 +01:00
Christoph Hegemann
ce4ad5161e Update FAQ.org
To match new dotfiles-emacs-command-key default of SPC
2016-02-07 14:33:44 +01:00
Fran Casas
c3ef15faee Add more doc to the underscores word motion. 2016-02-07 14:30:55 +01:00
Fabien Dubosson
6903524ec4 [Doc] Fix possible misunderstanding of "root"
"root" usually refer to `/` on linux. Use "project's root" to avoid
misunderstanding.
2016-02-02 16:45:29 +01:00
Eivind Fonn
8d60b15ccf Move projectile-shell-pop to shell layer 2016-02-02 16:42:58 +01:00
Fabien Dubosson
010444cdc7 Add projectile-shell-pop and bind it to SPC p '
This allows to open a shell at project's root
2016-02-02 16:36:39 +01:00
Fabien Dubosson
8c8da65b25 Add FAQ entry about helm-ag file extension filter
Fix #3282
2016-02-01 19:08:11 +01:00
Fabien Dubosson
ff2b87d7ba Add FAQ entry about X11 mouse support in terminals
Fix #4028
2016-02-01 18:42:20 +01:00
Eivind Fonn
b3b0ecb399 Make buffer and window close bindings consistent 2016-01-31 23:43:23 -05:00
syl20bnr
39d044dcb4 Move unimpaired contribution to spacemacs-evil
And document it.
2016-01-31 23:04:48 -05:00
Fabien Dubosson
324c2fa8d8 Add link-hint package
Use link-hint package. Bind it to `SPC x o` and `SPC x O`.
2016-01-31 23:04:47 -05:00
Balaji Sivaraman
e19abfc559 Fix/delete dead references to HOWTOs.org file 2016-01-31 23:04:47 -05:00
Balaji Sivaraman
2b1ed603dc Change all references of micro-state in codebase to transient-state 2016-01-31 23:04:47 -05:00
syl20bnr
09af60594c LAYERS.org: update layer files section 2016-01-31 22:27:40 -05:00
Robert O'Connor
63e15998f8 Update layers tutorial with new layer structure 2016-01-31 22:22:33 -05:00
syl20bnr
564c98e1bc Typo: at point --> around point 2016-01-31 20:32:02 -05:00
Fabien Dubosson
42bc71dcac Add helm-projectile-find-file-dwim
Complete #4144 in supporting `spacemacs-helm`
2016-01-31 22:12:49 +01:00
Tu Do
03ec0cb4bb [#4137] Give useful Projectile commands key bindings
helm-projectile-find-file-dwim is equivalent to find-file-at-point,
but operate in project scope and does not require full path.
2016-01-31 21:48:52 +01:00
Xue Fuqiao
4958f7fc10 Fix "the point" problems
Point is a proper name when it refers to the current editing location.
Moreover, point designates a place *between* two characters (or before the first
character, or after the last character), rather than a particular character.

References:

* http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html
* https://www.gnu.org/software/emacs/manual/html_node/elisp/Point.html#index-point
2016-01-31 21:48:52 +01:00
Rastus Vernon
bdc719876a Change 'SPC f e h' to 'SPC h SPC'
The 'SPC f e h' binding is deprecated, therefore the documentation
should refer to 'SPC h SPC' instead.
2016-01-31 21:42:07 +01:00
Fabien Dubosson
92a689a499 [FAQ.org] Make BEGIN_ blocks uniform 2016-01-31 21:42:07 +01:00
Fabien Dubosson
125a553dae [FAQ.org] Justify paragraphs 2016-01-31 21:42:03 +01:00
Balaji Sivaraman
4cf6a88ff8 Add How-to for running Spacemacs w/o modifying existing config 2016-01-31 20:33:21 +01:00
syl20bnr
a000a03349 Move report error to SPC h I
h for help and I for issue
2016-01-26 01:21:02 -05:00
Fabien Dubosson
aa39eb3fd0 Add a command for reporting issue to spacemacs 2016-01-26 01:21:02 -05:00
Xue Fuqiao
9dfc1d93aa Doc fix for spacemacs/show-and-copy-buffer-filename 2016-01-26 01:21:02 -05:00
Eivind Fonn
40836f1c11 Basic support for hexl 2016-01-26 01:21:01 -05:00
JAremko
574dffbeeb added follow mode key binding 2016-01-23 14:11:20 +01:00
syl20bnr
f8550a4682 Move helm-locate-library to SPC f e l 2016-01-18 00:39:38 -05:00
Balaji Sivaraman
e643b0b560 Add doc for spacemacs/open-junk-file keybinding 2016-01-18 00:29:07 -05:00
Balaji Sivaraman
d94d34a34c Add doc for spacemacs/restart-emacs keybinding 2016-01-18 00:28:14 -05:00
Balaji Sivaraman
3be33a5e51 Fix docs to provide correct keybindings for Avy 2016-01-18 00:26:03 -05:00
Fabien Dubosson
123844cd51 Add text justification bindings 2016-01-18 00:25:31 -05:00
Vivien Moreau
e64863d5b9 doc: add a FAQ item about evil-escape
squash! Precise that it is not only about going from insert state to
normal state.
2016-01-17 23:59:52 -05:00
Diego Berrocal
e7e7f75d3f Add evil-scroll-line bindings to evilified state
Unless there is a valid reason why these shouldn't be included I think
we should keep them. after all we can yank with `v y` right?

squash! Add documentation
2016-01-17 23:56:56 -05:00
syl20bnr
cf11c5eb41 Update conventions (use-package and key bindings in doc) 2016-01-17 23:42:04 -05:00
syl20bnr
194a42db74 Move unimpaired to spacemacs layer 2016-01-17 23:28:09 -05:00
syl20bnr
33ead6fc42 Deprecation of extensions and <pkg>-excluded-packages variables
As announced in previous releases, see CHANGELOG.next for more info
in the Breaking Changes section.
2016-01-17 22:06:04 -05:00
syl20bnr
052e8dfc08 Move helm and search key bindings
Key bindings should not be choosen given a package name, some helm
key bindings are under `SPC h` which are corrected the following way:

SPC h l for helm-resume to SPC r l (resume last completion)
SPC s l for last-search to SPC r s (resume search) (SPC s l is still
available)
SPC h L for helm-locate-library to SPC s L

Resolve #4592
2016-01-13 08:32:16 -05:00
syl20bnr
8c0a4452b0 Move open bookmarks on SPC f b 2016-01-13 08:01:52 -05:00
Balaji Sivaraman
d3048a1395 Fix helm-project-do-pt key-binding in docs 2016-01-13 00:40:35 -05:00
Fabien Dubosson
ad448d6683 Add helm-apropos on SPC h d d
Bind it to `SPC h d d` as it's a way to describe a lot of elements:
- commands
- functions
- classes
- generic functions
- variables
- faces
- helm-attributes

Is also bound on `SPC F1` and will also stay there.
2016-01-13 00:40:25 -05:00
syl20bnr
a5857b3d7c Optimize SPC j prefix
`SPC j j` is now for avy-goto-char (SPC SPC in 0.105)
`SPC j J` is for avy-goto-char-2
`SPC j s` is for splitting strings or sexps
`SPC j S` is for splitting strings of sexps, insert new line and indent
`SPC j n` is to split line at point, insert new line and indent
2016-01-12 01:17:41 -05:00
Fabien Dubosson
78b8d939f4 Add spacemacs/describe-last-keys 2016-01-11 22:01:01 -05:00
justbur
32f523e062 spacemacs-helm: New layer
Collect helm configuration from spacemacs and spacemacs-base into one
place. The purpose is to allow choice between this layer and
spacemacs-ivy.
2016-01-09 13:36:03 -05:00
syl20bnr
58e5241c8d dotfile: rename dotspacemacs-command-key for dotspacemacs-emacs-command-key
And change the key from ":" to "SPC"
This key does not try to bind evil ex-command anymore, it only bind
M-x behind the leader key.
2016-01-09 01:53:24 -05:00
syl20bnr
454027df35 Remove undocumented and duplicated SPC j m and update doc. 2016-01-09 01:30:05 -05:00
justbur
02e2ce4d5a keybindings: Add SPC j for jumping
Use mnemonic j for jumping commands. Although some of these commands
exist in other places, they are duplicated here when they don't
conflict.

Add:

  1. jb for bookmark-jump
  2. jc for avy char jump
  3. jd for dired-jump
  4. jD for dired-jump-other-window
  5. jf for find-function-at-point
  6. ji for spacemacs/jump-in-buffer (imenu)
  7. jI for helm imenu in all buffers
  8. jl for avy go to line
  9. ju for avy-pop-mark (u for "undo")
  10. jU for spacmacs/avy-goto-url
  11. jv for find-variable-at-point
  12. jw for avy go to word or subword

Move:
  1. jh to j0 (push mark and go to beginning of line)
  1. jl to j$ (push mark and go to end of line)
2016-01-09 01:00:44 -05:00
syl20bnr
7d0ba07cef Add achievement
5000th star goes to StreakyCobra
2016-01-05 02:39:57 -05:00
syl20bnr
70cf8c750a Add documentation for SPC h n 2016-01-05 01:29:08 -05:00
syl20bnr
74689e0c22 Add documentation in README.md and FAQ for --insecure
Should fix #4375
2016-01-05 01:16:29 -05:00
person808
73a40805b3 Update tip to use new layout variable. 2016-01-05 00:45:38 -05:00
Fabien Dubosson
16b742e83a Update code and references to evil-leader in the FAQ 2016-01-04 23:10:44 +01:00
Eivind Fonn
02f7500c86 Add FAQ about corrupted ELPA archives 2016-01-04 21:48:42 +01:00
syl20bnr
ca3b7c4f71 FAQ: minor update 2016-01-04 01:29:30 -05:00
syl20bnr
4a27a812b1 conventions: generalize confirm and abort bindings 2016-01-04 00:34:14 -05:00
Fabien Dubosson
6cb7399cac Change SPC f e h to SPC h SPC for helm-spacemacs default binding
This make `SPC h SPC` as default binding for accessing `helm-spacemacs`,
by either A) changing all the documentation; and B) adding a deprecation
message for `SPC f e h`.

The deprecation use a warning, because if a message is used it's hidden
directly when the helm buffer is shown, making it nearly unnoticeable
for the user.
2016-01-03 22:23:12 -05:00
Fabien Dubosson
11c692dc0f Correct last evil-leader/set-key in documentation 2016-01-03 22:23:11 -05:00
syl20bnr
336539500d doc: rewrite of Who can benefit from this 2016-01-03 13:18:55 -05:00
syl20bnr
ffb33a4d47 doc: rewrite of goals as highlighted feature 2016-01-03 13:07:18 -05:00
syl20bnr
7990b8d167 Doc: rewrite core pillars to be straight to the point 2016-01-03 12:57:34 -05:00
Wieland Hoffmann
80a9add5af doc: Don't make a link to quelpa verbatim
At least GitHubs org renderer only showed the raw markup when rendering
this link.
2016-01-03 14:42:14 +01:00
Treri
cd954312f6 Fix horizontal/vertical splits documentation (-, /) 2016-01-03 14:22:55 +01:00
Fabien Dubosson
374e37e32c Add information about global-git-commit-mode
Fix #2522
2015-12-21 13:56:38 +01:00
syl20bnr
70ea7a5d9c Add documentation for spacemacs/recompile-elpa 2015-12-21 00:43:35 -05:00
syl20bnr
6f4a8defac Document hybrid-mode-default-state variable 2015-12-21 00:14:54 -05:00
justbur
812ba329f2 core: move spacemacs-mode to core-spacemacs-buffer.el
The rationale is to keep the spacemacs buffer related code contained in
the core-spacemacs-buffer.el file.
2015-12-11 02:25:22 -05:00
Fabien Dubosson
315528c89f Refactor CONTRIBUTING documentations
This commit merge the `CONTRIBUTING.md` and `doc/CONTRIBUTE.org` file
into a new `CONTRIBUTING.org` file. It also refactors the content to be
more organized and make its navigation more goal-oriented.

Github displays a link to the `CONTRIBUTING.*` file when people are
opening new issues or proposing new PRs. This file is important because
it is the entry-point to contributions guidelines for most of the users.
The current setup is non-optimal, even broken, as it adds a level of
indirection, and points to a contributing file that has broken
links (due to the new documentation format). The possible drawback of
the proposed solution is that I'm not sure if it is possible to include
it into the new online documentation as it is not in `doc/` folder.

The other possibility is to keep a small `CONTRIBUTING.md` file, as it
is now, pointing to the new documentation system (once online), but I'm
preferring the proposed solution for the following reasons:

- People that are willing to contribute will probably open Github
  first (for forking, creating PR, etc), not the online documentation.

- It has one level of indirection less when people click on the
  guidelines guide from a new issue/PR.

- `CONTRIBUTING.*` is by convention a special kind of file on github, so
  it's valid reason to break the rule and not having it in the `doc/`
  folder.
2015-12-11 01:09:09 -05:00
William Casarin
c4a80efcb8 keybinding: ck -> kill-compilation 2015-12-09 01:31:42 -05:00
syl20bnr
5895e0e45f change mhh for gh to follow-symbol in help buffers
Also document the key bindings
2015-12-09 01:08:52 -05:00
person808
337b9f8683 Update VIMUSERS.org for new leader key functions. 2015-12-09 00:57:52 -05:00
syl20bnr
2409a3dfc0 conventions: add justbur suggestion for SPC m a for abort 2015-12-09 00:51:50 -05:00
Fabien Dubosson
fb3e539eaf Define a convention for message modes 2015-12-09 00:50:22 -05:00
syl20bnr
68e67fbd1c Add achievements
3000th issue: malchmih
4000th issue: icymist
2000th merged PR: channingwalton
2015-12-07 23:43:46 -05:00
Fabien Dubosson
ec8250ea1d Move jump-in-buffer to SPC s j
After a discussion on gitter with @TheBB and @syl20bnr, `jump-in-buffer`
is moved from `SPC s L` to `SPC s j`.
2015-12-07 13:12:10 +01:00
syl20bnr
5104593e89 spacemacs-base: swap SPC s l and SPC s L
SPC s l to bring last search buffer is a powerful binding, let it take
the easier binding.
2015-12-06 23:20:46 -05:00
syl20bnr
69dd09c9a0 Add achievements
The Tiler: bmag
The Geometer: TheBB

The Tiler is for being an Emacs windows expert.
The Geometer is for being an expert in Emacs mode-line and for the "line"
and "segments" (spaceline).
2015-12-06 02:12:13 -05:00
syl20bnr
8191a6695f Add Expert in Latin Language achievement
Attributed to vijaykiran
2015-12-04 00:49:33 -05:00
syl20bnr
bef8d26688 Fixes typos 2015-12-04 00:04:46 -05:00
AdrieanKhisbe
6e8d89ef61 Add Documentation about how to avoid conflict
built on #3277 cf #3562
2015-12-04 00:01:32 -05:00
Sergey Shishkin
83e08d9e68 Typo 2015-12-01 01:28:02 -05:00
Fabien Dubosson
e19d968571 Add an alternative solution for HELM #1000 in FAQ
Close #3853
2015-11-29 12:04:56 +01:00
Fabien Dubosson
163b82c960 [FAQ] Make spell-checking supports curly quotes
Close #3829
2015-11-29 12:04:25 +01:00
Eivind Fonn
fa819a6634 Update documentation for packages binding 2015-11-27 10:32:51 +01:00
Fabien Dubosson
ec308f0f8e Add a binding for helm-ag-pop-stack
Close #2736
2015-11-24 23:29:12 +01:00
Fabien Dubosson
028c53fbd7 Create the layer README on create-layer
When using `configuration-layer/create-layer`, the `README.org` file is
not created from the template. This change corrects this.

Close #3259
2015-11-24 23:20:45 +01:00
syl20bnr
c732c9ea22 Move vi-tilde-fringe toggle to SPC T ~ 2015-11-24 09:59:16 -05:00
Eivind Fonn
aa068a212a Fix neotree documentation 2015-11-23 20:20:25 +01:00
Adam Olsen
ac9e81bf49 Set neo-vc-integration to nil by default
* Set `neo-vc-integration` to `nil` for much better performance
* Add documentation for the `neo-vc-integration` setting.
* Add documentation for the `neo-theme` setting.
2015-11-23 20:17:03 +01:00
syl20bnr
b540b15afe Move describe-keymap to SPC h d K and document it 2015-11-22 22:31:29 -05:00
justbur
87d61dbd3f doc: Minor doc changes for evil-leader removal 2015-11-21 18:22:51 +01:00
Fabien Dubosson
7c160e8ae5 FAQ update
Close #1206
Close #1269
Close #1504
Close #1742
Correct #3839
2015-11-17 15:32:42 +01:00
Fabien Dubosson
7dd57eb845 Add a FAQ entry for installing a package
Close #1330
2015-11-16 20:51:06 +01:00
Fabien Dubosson
471fce6106 Change behaviour of [=] [0] in zooms
As proposed in #2144, Use [=] as an alias of [+], and use [0] instead
for resetting the zoom.

Add a missing `q` binding/documentation.

Close #2144
2015-11-16 20:51:06 +01:00
Fabien Dubosson
ee4ad69847 FAQ: How to restore sentence delimiter to 2 spaces
Close #1819
2015-11-16 20:51:06 +01:00
Eivind Fonn
f56e49f30e Document SPC h SPC 2015-11-16 20:51:06 +01:00
Eivind Fonn
bd2e847a33 Move which-key top level to SPC hk
…and helm-make to SPC cm
2015-11-16 16:21:24 +01:00
Christian Wesselhoeft
df5f8d3d13 Grammar fix in DOCUMENTATION.org 2015-11-15 12:26:25 +01:00
Eivind Fonn
f6eb4f4290 Document SPC h h binding and move to init function
Also remove hl-anything docs
2015-11-15 12:24:49 +01:00
Christoph Paulik
9726033515 Don't use ido for sudo-edit of new files and bind key 2015-11-15 12:19:25 +01:00
Sebastian Wiesner
a4882308a5 Move lorem ipsum package to il
Spacemacs already has the "i" prefix for insertion, why do we also need
a separate prefix "xi" for “text insertion”?
2015-11-14 00:33:46 -05:00
Christoph Paulik
d1c8e4b9f7 Disable projectile-caching by default.
- Default projectile settings are to disable caching when indexing
  method is `alien. So setting the indexing method should be enough.
- On windows we keep the 'native method unless find is found
2015-11-14 00:32:43 -05:00
Eivind Fonn
c3866382b2 Documentation update
- Add #+HTML_HEAD_EXTRA options to all org files
- HTMLize published documentation via CSS
2015-11-13 14:23:13 +01:00
Eivind Fonn
7518da2f49 Update mode-line documentation for spaceline 2015-11-13 14:02:51 +01:00
Joe Hillenbrand
3b6fd59245 Add SPC c q to close the compilation window
I found it annoying to have to re-navigate to the *compilation* window
and close it after every time I compile with `SPC p c`.

This patch adds a binding to make closing this window fast and easy.

Also a little bit of clean up.
2015-11-13 13:55:53 +01:00
nashamri
f0a05d1d54 Fix grammar to be more consistent and discoverable 2015-11-13 13:40:17 +01:00
Fabien Dubosson
05a2256cff Update the FAQ for evil-leader rebinding
As `SPC L` has moved to `SPC l` and avy is now on `SPC y`, the FAQ has
to be updated because the evil-leader example doesn't make sense any
longer. The question is also moved to "How do I …" where it belongs.

The code has also been updated to be a little bit cleaner.
2015-11-09 19:02:37 +01:00
Eivind Fonn
2c5d873916 Add link description in FAQ 2015-11-09 19:00:17 +01:00
Swaroop C H
db97ba56e4 Add FAQ: Why is Spacemacs hanging on startup?
Refs #3422
2015-11-09 18:59:16 +01:00
justbur
94fe2cb755 docs: Note commands for update/rollback packages
In case someone doesn't want to use the buttons
2015-11-09 18:42:18 +01:00
Joe Hillenbrand
5559060ab5 bind avy-goto-line to SPC y
After the change in 1d340dcc77,
there was some grumbling in gitter that `SPC L` is not as convenient
as `SPC l`. Apparently avy-goto-line is a popular function.

`SPC y` is chosen because it is:

- currently unused (as far as I can tell).
- sort of mnemonic because "avy" has a "y" in it.
- doesn't require SHIFT to type
- is accessible even on non-US keyboards
  (there were suggestions such ";" and "\" that are not as accessible
   on non-US keyboards)

This change also updates the documentation regarding the change from
ace-jump-mode to avy.
2015-11-06 01:29:49 -05:00
Joe Hillenbrand
be817362ae update docs for switch to SPC l for perspectives 2015-11-06 01:17:10 -05:00
syl20bnr
b405752f6c Remove global infix in dotspacemacs-global-line-numbers
I feel that it is not needed because it makes not a lot of sense to
have it non global since it is a dotfile variable.

Also remove ' from the docstring for consistency.
2015-11-03 00:00:55 -05:00
Fabien Dubosson
612c3df265 Introduce 'relative for global-line-numbers
Allow to use 'relative as value for the dotspacemacs-global-line-numbers
setting. This enable relative global line numbers as it is a common
usage.
2015-11-03 00:00:55 -05:00
syl20bnr
34ce7a0c23 Move lorem ipsum to SPC x i l and declare prefixes
This a rarely used key binding so we can nest it a little bit more and
free some key bindings in the `text insert` namespace.
2015-11-03 00:00:54 -05:00
Fabien Dubosson
5f7c3d067f Add the lorem-ipsum package
Add the `lorem-ipsum` package to insert text, and bind it to:

* `xil`: lorem-ipsum-insert-list
* `xip`: lorem-ipsum-insert-paragraphs
* `xis`: lorem-ipsum-insert-sentences

`x` as it's text related, and `l` for `list, `p` for `paragraph` and `s`
for sentences.
2015-11-03 00:00:54 -05:00
syl20bnr
6b2da3ca0c Add doc for describe-face binding 2015-11-03 00:00:54 -05:00
Piotrek Bzdyl
3c7658daa6 Fixed a typo in Editing Lisp code section. 2015-11-01 23:41:35 -05:00
Eivind Fonn
1070d4b56a Set up documentation publishing 2015-11-01 23:40:36 -05:00
Eivind Fonn
13c5b1d24b Convert documentation to publishable format 2015-11-01 23:40:29 -05:00
Adam Olsen
68fa0330e4 Make NeoTree more "vim" friendly
This rebinds keys in NeoTree so that `g` and `G` work correctly
2015-10-31 14:10:57 +01:00
Eivind Fonn
72c569429d 4000th star achievement 2015-10-31 08:09:19 +01:00
Fabien Dubosson
c3299f0eca Make linum toggle local and add a variable for global mode
`global-linum-mode` is making line numbers appearing in `*spacemacs*`
and `helm` buffers, what is annoying.

This change make the linum `SPC t n` toggle buffer-local, and add a
customization variable in `.spacemacs` to enable line numbers globally.
«Globally» here as to be understood as «in `prog-mode` and `text-mode`».
2015-10-29 19:30:06 +01:00
Eivind Fonn
16e7ad2923 Clean up PATH documentation 2015-10-29 13:48:46 +01:00
d12frosted
a89a05ca9a add note about setting up $PATH 2015-10-29 13:48:46 +01:00
Ernestas Lisauskas
ad97fd06ba Correct the documentation 2015-10-25 10:39:46 +01:00
Eivind Fonn
bf4cb35f18 FAQ: underscores and word motions 2015-10-23 12:30:23 +02:00
Eivind Fonn
1fdd332e5c Make FAQ explicit about eval after load 2015-10-23 10:19:29 +02:00
Eivind Fonn
aa64092dc9 FAQ: %s/ \?/?/g 2015-10-23 10:14:30 +02:00
Eivind Fonn
cf6b66c2ba Fix error in FAQ 2015-10-23 10:13:29 +02:00
Zach Liss
0463b3fc55 grammar fix: need "of" in a sentence 2015-10-22 18:26:51 -04:00
Fabien Dubosson
0fb5e24039 Merge HOWTOs.org in FAQ.org
Merging the HOW-TOs inside the FAQ allows to have a central place to
look for information. It will also offer all HOW-TOs through the
`SPC f e h` helm search.
2015-10-19 00:30:06 -04:00
Wieland Hoffmann
a358eb0154 doc: Fix Markup in the projectile key binding table 2015-10-19 00:29:20 -04:00
Fabien Dubosson
bd71237db1 Update the FAQ
This commit apply the following changes:

- Remove leading whitespaces
- Apply fill-paragraph to justify answers' paragraphs.
- Add question: how to define/change an evil-leader prefix?
- Add question: user-init or user-config?
2015-10-19 00:24:34 -04:00
Fabien Dubosson
ab23559047 Adapt project-search keybindings
For buffers, `*` search for the word under the cursor, and `/` ask to
search for an expression. To keep the same mnemonic at project level,
this commit change `SPC /` to ask for an expression to search, and add
`SPC *` to search for the expression under the cursor (in fact the only
difference being the expression pre-filled inside the input field).
2015-10-19 00:20:59 -04:00
syl20bnr
91dcafe993 doc: add hint for C-s in SPC p p helm buffer 2015-10-19 00:19:30 -04:00
Sebastian Wiesner
6652e0d8b8 Add bindings for local variable commands
- fvd: Add a directory variable
- fvf: Add a file variable
- fvp: Add a file variable to property line
2015-10-18 23:56:46 -04:00
Fabien Dubosson
5105b99754 Add a note about org loading limitation
Add a release note about the limitation of org loading since 0.105, and
also document it in the org-layer's README.

Close #3277

Move note to FAQ and correct text to 0.104
2015-10-18 10:10:02 -04:00
justbur
c96183f56a spacemacs-buffer: Distinguish types of updates
Add a spacemacs update button to the spacemacs buffer, and relabel the
package update button to read "Update Packages". This will hopefully
resolve some confusion about updating spacemacs vs. updating the
packages.

I also tweaked the switch-to-version function to make it a little more
verbose to use it for the spacemacs update button.
2015-10-14 00:42:00 -04:00
justbur
bfd360440f doc: Be consistent with ref to Spacemacs
Use of =Spacemacs= vs Spacemacs is inconsistent. This picks Spacemacs as
a convention
2015-10-14 00:32:09 -04:00
Wieland Hoffmann
fa23d9453b Change references to the old contrib folder to layers 2015-10-14 00:30:00 -04:00
Wieland Hoffmann
a788e1a88e Markup fixes
This makes all Notes in DOCUMENTATION.org be *Note*: and changes the
markup around the spacemacs init file path in jabbers README.org to
proper org markup.
2015-10-14 00:28:03 -04:00
Fabien Dubosson
e5dbfa0032 Add switch-to-scratch-buffer function and bind it
This change add a `switch-to-scratch-buffer` function allowing to – you
guessed it – switch to the `*scratch*` buffer, taking care of creating
it if necessary. The function is bind to `SPC b s`, `b` as it concerns
buffers, and `s` for `scratch`.
2015-10-12 09:34:46 -04:00
Christoph Paulik
9119766d35 Make it clear in global docs that spell checking is a layer 2015-10-09 12:16:35 +02:00
Fabien Dubosson
b1fc99bdee Improve keybindings for text-region counting.
Emacs provides a `count-words-region' which is badly named as it counts
not only words, but also characters and lines. The current keybinding
for this function `SPC x w c' implies it's referring to words only. The
new mapping `SPC x c` is more coherent since it means counting text,
whether it is characters, words or lines. An alias `count-region` is
created to be less confusing in which-key description.

`SPC x w c` being free, `spacemacs/count-words-analysis` is remapped to
it instead of `SPC x w C` to save one keystroke.
2015-10-07 15:51:39 -04:00
person808
c1b6293268 Replace eval-after-load with with-eval-after-load.
We now backport the macro for 24.3 so we can use it everywhere.
2015-10-07 15:51:39 -04:00
Fabien Dubosson
6a18cad5c0 Add avy-open-url and its keybinding to open urls
The function `spacemacs/avy-open-url` allows to easily select an URL on
the screen with `avy` and open it. The function is bind to `SPC x o`,
`x` as it is text-related and `o` for open.
2015-10-07 15:51:39 -04:00
nashamri
668d20700c New screenshot without rainbow-identifiers 2015-10-07 15:51:39 -04:00
Fabien Dubosson
5e3dbd9234 Add FAQ as a source in helm-spacemacs
Add the `FAQ.org` file as a source in helm-spacemacs (`SPC f e h`).
Define a new keybinding for looking directly inside the FAQ with helm:
`SPC f e f`.

With help from TheBB, thanks!
2015-10-07 15:51:38 -04:00
Bar
f59298b4c4 Doc typo: "search for files" -> "search in files"
"Search for files" means that the command looks for files, while actually `SPC s f` searches in some files for lines that match the given search pattern. Changed it to "search in files" to better reflect what the command does.
2015-10-07 15:51:38 -04:00
Martina Kollarova
1ea9812376 Update key binding for flycheck toggle in docs 2015-10-07 15:51:38 -04:00
Eivind Fonn
91947406f8 Clarify evilified rules 2015-10-05 22:07:38 +02:00
Robert O'Connor
3aa8c44660 Fix link to layers directory. 2015-10-05 12:13:26 +02:00
Eivind Fonn
23efb683e8 Document GnuTLS for Windows
Fix #2371

[ci-skip]
2015-10-05 12:07:45 +02:00
Eivind Fonn
4fb764cf0b Document helm focus trick
Fix #2851

[ci-skip]
2015-10-05 12:07:45 +02:00
Eivind Fonn
48d660fd98 Document evilified modes
[ci-skip]
2015-10-05 12:07:45 +02:00
Eivind Fonn
ec4b74102c Document dotspacemacs/test-dotfile
Fix #3181

[ci-skip]
2015-10-05 12:07:45 +02:00
Robert O'Connor
8da367d529 Add an FAQ about the new distributions.
Fixes #3180
2015-09-29 21:47:16 -04:00
syl20bnr
ab6ebd0348 conventions: better evilified buffers section 2015-09-29 21:35:21 -04:00
Tommi Komulainen
910417d143 doc: fix typo in before listing "SPC m x" keybindings 2015-09-28 23:21:50 -04:00
syl20bnr
afa537d341 Update automatic highlight of symbol toggle 2015-09-28 22:12:08 -04:00
syl20bnr
383b1bec20 Update dotspacemacs/config and dotspacemacs/init occurrences 2015-09-28 02:05:18 -04:00
syl20bnr
bac79f03b7 readme: add drop-shadow to screenshot 2015-09-28 01:48:53 -04:00
syl20bnr
e6aab8703d readme: update screenshot 2015-09-28 01:42:55 -04:00
syl20bnr
63428d8bed Doc: replace all occurences of =Spacemacs= by Spacemacs 2015-09-27 10:20:54 -04:00
syl20bnr
b256475325 helm-find-files: use C-h and C-l to go up down a directory
Import TheBB configuration into Spacemacs and add `C-S-h` to replace
redefined `C-h` binidng.

Also remove the go up a directory behavior on backspace, now backspace
is a regular backspace.
2015-09-27 10:20:14 -04:00
syl20bnr
ae475c06c4 base: move toggles for editing styles
SPC t E e -> emacs
SPC t E h -> hybrid
2015-09-26 11:06:45 -04:00
syl20bnr
7e8c275bc5 Rework editing style toggles
Put the toggles on SPC t E with
SPC t E h -> holy-mode
SPC t E y -> hybrid-mode

Make the mode-line diminished lighter consistent with the key bindings,
so holy is Ⓔh and hybrid is Ⓔy

Add seamless switch between holy and hybrid.
2015-09-23 23:27:51 -04:00
syl20bnr
98e43b17ad doc: update doc on editing styles 2015-09-23 23:08:01 -04:00
justbur
9874e0c12c Update docs for new hybrid state
The docs don't reflect the new design of hybrid mode
2015-09-23 22:54:19 -04:00
syl20bnr
2ab7a2a60f Rewrite README.md to make it lighter
And move some parts to QUICK_START.org and FAQ.org
2015-09-22 23:26:12 -04:00
Eivind Fonn
40ee152865 doc: M-SPC doesn't exit helm micro-state
Move `q` binding further up to make it visible
2015-09-14 10:57:55 +02:00
Martin Račák
5b1ef55b96 Fix documentation for emacsclient
Verbatim text with equal sign was't displaying correctly. Another
solution would be to escape `=` with Org mode entity, but GitHub won't
display it correctly.
2015-09-13 22:21:05 -04:00
justbur
6eab954afe Use + instead of ! for layer categories
Helm seems to treat "!" specially in pattern matching, so having a ! in
the pattern string when traversing directories is problematic. This
change fixes #2737, because as far as I can tell "+" has no special
meaning in a helm pattern.

Of course, we can choose a different character, but I'm fond of "+" as
representing "more layers here".
2015-09-11 00:13:51 -04:00
syl20bnr
b53b5db967 spacemacs-core: remove SPC f e s and SPC f e c
Now the user should use `SPC f e h` helm-spacemacs.
This is due to the fact that spacemacs layer is now a regular layer
stored in the "layers" directory.
2015-09-08 01:01:46 -04:00
person808
f53620a1c8 Update hybrid mode documentation. 2015-09-08 00:36:31 -04:00
person808
9fe0d8f10f Update VIMUSERS.org for new layer changes. 2015-09-07 01:06:31 -04:00
Endre Bakken Stovner
18b8e3ff76 Enabled comment inversion without toggling switch
Previously, you had to set the evilnc-invert-comment-line-by-line
to be enable inverted comments. Since whether you want to invert
comments or not varies on a case to case basis, depending on the region
you wish to comment, this is bad UI.

Made two functions per original commenting function, one for inverse
the other for regular.

Added keybindings for the new inverted operations on capital letter,
so that comment lines is SPC c l and invert comment lines is SPC c L.

I removed the comment invert toggle as it is no longer needed.

(Also removed old docs which said that SPC c r is comment region;
it is actually recompile)
2015-09-07 01:06:31 -04:00
syl20bnr
281cddd12a Add documentation for SPC f C u and SPC f C d 2015-09-07 01:06:30 -04:00
person808
12bc72123a Make Y equivalent to y$.
This is much more consistent with C and D and is even recommended by vim
itself.
2015-09-07 01:06:30 -04:00
syl20bnr
2692332b64 Add doc for neotree VCS integration and evil text objects 2015-09-07 01:06:29 -04:00
person808
a50ae0c7f4 Format paragraphs/code/tables in DOCUMENTATION.org. 2015-09-07 01:06:28 -04:00
person808
b0b9f0066c Document hybrid mode and update holy mode documentation. 2015-09-07 01:06:28 -04:00
person808
63b5fb07ae Consitently format Note: lines in DOCUMENTATION.org.
Format is:
*Note*: note here
2015-09-07 01:06:28 -04:00
person808
4a23e3bea6 Update .spacemacs function names in DOCUMENTATION.org.
dotspacemacs/init -> dotspacemacs/user-init
dotspacemacs/config -> dotspacemacs/user-config
2015-09-07 01:06:28 -04:00
person808
e9ebd7e343 Update documentation for installing .spacemacs. 2015-09-07 01:06:28 -04:00
person808
4b2430d922 Update documentation for updating.
Add screenshot of update arrow.
Also add a little for "who is this for" section.
2015-09-07 01:06:28 -04:00
person808
3dd0a8d4b4 Update layer information in DOCUMENTATION.org. 2015-09-07 01:06:28 -04:00
justbur
292659d0c6 Add key binding tips to documentation.org 2015-09-07 01:06:27 -04:00
syl20bnr
6c71e6b2eb Update doc for evil-escape 2015-09-02 00:02:26 -04:00
Eivind Fonn
1231a05cec Add doc on how to write layers
[ci skip]
2015-08-31 22:18:03 -04:00
Eivind Fonn
c6ba7d9300 Refactor test system
Should allow easier testing of layers, not just core
2015-08-31 21:16:34 -04:00
Xue Fuqiao
17a652f05e Minor doc fixes 2015-08-31 16:23:26 +02:00
syl20bnr
3c1387f5ea move helm-locate on SPC f L 2015-08-30 23:51:16 -04:00