Commit graph

471 commits

Author SHA1 Message Date
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