Commit graph

486 commits

Author SHA1 Message Date
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
Andrew Oppenlander
7274d9d5c2 Added text line sort and uniquify commands 2015-08-30 23:34:49 -04:00
syl20bnr
c8a2d2d4f3 Move SPC e ? to SPC e h 2015-08-30 23:20:47 -04:00
Xue Fuqiao
8c4264d9b3 Minor doc fixes. 2015-08-26 23:08:43 -04:00
Eivind Fonn
e7edf8cef4 Update modeline documentation
[ci skip]
2015-08-26 23:02:48 -04:00
justbur
8bf4f60e5a Mention .spacemacs.d in documentation 2015-08-26 23:00:05 -04:00
justbur
d1bb779340 Update docs for which-key 2015-08-26 22:58:24 -04:00
Devagamster
93d227b73f Update docs for H and L
H and L no longer move the cursor 10 lines up or down. Not sure how or when they did before, but they don't anymore, so the docs should reflect that.
2015-08-26 22:52:55 -04:00
Eivind Fonn
d17c229c2a Make SPC m o reserved for user 2015-08-26 21:37:01 -04:00