Commit graph

1007 commits

Author SHA1 Message Date
mark30247 cb26ca6b33 Improve readability
Replaces the description of various keys (Space, Ctrl, etc) in a single line with a list describing each key as a list item. Improves readability.
2020-10-02 13:33:45 +02:00
syl20bnr 6b23185992 [core] Swap SPC h d t and SPC h d T
As describing text feels more useful than describing themes.
2020-09-20 22:32:41 -04:00
Maximilian Wolff dc143a765b
[doc] Add missing documentation for ~SPC h d T~ 2020-09-18 19:48:42 +02:00
ClarityStorm d1578dd4a9 Expand solution for underscores in word motions 2020-09-08 20:47:51 +02:00
emacspace 69ecdfe514 documentation formatting: Sat Jul 18 20:49:09 UTC 2020 2020-07-18 22:54:28 +02:00
duianto b604743369 [doc] Document how to bind keys to a macro (one or more keys) 2020-07-18 22:33:11 +02:00
Kensuke Nagae 660ea402ad Fix inline code styling
[Unicode Character 'RIGHT DOUBLE QUOTATION MARK' (U+201D)](https://www.fileformat.info/info/unicode/char/201d/index.htm) breaks inline `code` styling.

Replacing it with [Unicode Character 'QUOTATION MARK' (U+0022)](https://www.fileformat.info/info/unicode/char/0022/index.htm) fixes it.
2020-07-01 20:53:09 +02:00
emacspace bf9d9d1962 documentation formatting: Sat May 16 21:43:42 UTC 2020 2020-05-16 23:54:53 +02:00
JAremko a54f75c0c9 20k stars achievement unlocked! 2020-05-16 21:22:49 +03:00
syl20bnr 1fc809bdf0 Use spacebind for Differences key bindings 2020-03-05 21:04:51 -05:00
emacspace 4415131e4f
documentation formatting: Tue Feb 25 22:34:54 UTC 2020 2020-02-26 00:35:14 +01:00
Xiang Ji 6049d901f6
Add documentation on the difference in regex syntax with Vim 2020-02-25 21:08:40 +01:00
emacspace e1742a4d39 documentation formatting: Mon Feb 24 00:14:51 UTC 2020 2020-02-24 02:26:40 +02:00
duianto 07d12c1308 [doc] Update keyboard macro documentation
The key bindings were wrapped in a comment block, which prevented them from
appearing.

Added recording steps with explanations.
2020-02-23 21:19:50 +01:00
syl20bnr 978be09f6b [base] Refactor keyboard macro key bindings 2020-02-23 09:42:20 -05:00
syl20bnr 51c7fb961b [default] Move ediff key bindings from SPC E to SPC D prefix
And add documentation
2020-02-01 16:27:44 -05:00
syl20bnr 68dab82d98 [doc] Add documentation for SPC x d l 2020-02-01 10:13:12 -05:00
duianto 27178f23e9 Fix helm-spacemacs-help-faq, SPC h f
The function: helm-org-get-candidates was removed upstream.

Improvements:
Recenter the target candidate.

Reversed the helm headings list, to match the order of the
questions in FAQ.org, so that the Common questions are
listed first.

Removed the : (colon) after the heading: How do I
in FAQ.org, to match the other parent headings.
2020-01-25 17:37:47 +01:00
syl20bnr 2bec3bb719
[doc] Remove unneeded SPC U for numerical prefix argument 2020-01-20 11:26:14 -05:00
syl20bnr 101c920dbc
Add key bindings to randomize word and lines in region 2020-01-20 11:26:14 -05:00
Zach Latta 1d2a1fa6e4 Fix capitalization of GitHub
Change instances of "Github" to "GitHub".
2020-01-20 09:14:12 +01:00
Ullas Holla 8e66bf36df Add missing apostrophe in DOCUMENTATION.org 2020-01-04 09:01:57 +01:00
milserk 0f5cc6e5fc Fix typo "verbose" -> "verbatim" 2019-12-06 12:31:32 +01:00
Maximilian Wolff f6fd88f40b
Change recompile-elpa to a more emacs file specific keybinding 2019-11-24 20:56:52 +00:00
Maximilian Wolff dd7a5d98be
Revise helm recompile package action and bind recompile-elpa
The newly introduced function to compile an elpa package
was very much redundant with the existing recompile-elpa function.

I have adapted recompile-elpa so that it can be used for the helm action too.

In addition I have bound recompile-elpa to `SPC c C-c` to allow users to
easily recompile their entire elpa directory if the need arises.

I have also removed the error handling in the helm action in favor of
standard error reporting via the *Compile-Log* buffer.
2019-11-24 02:07:15 +01:00
duianto 9f16032f69
Update transient state wording, etc.
- Removed the word `Manipulation` from the transient state titles:
  - Buffer Manipulation Transient State and Window Manipulation TS
  - Expanded the TS abbreviation to Transient State
- Documented the Buffer Transient State key binding:
  `q` to quit the transient state
- Capitalized `Transient State` in the titles
- Window Transient State:
  - Added a line break after the title in the folded hint.
    This allows for more keys to be visible horizontally.
  - Moved up the [?] help key after the title, so that
    it's in the same place in both the folded and full
    transient state.
2019-11-23 23:12:37 +01:00
Maximilian Wolff 28959d73ab Document missing keybindings for window manipulation transient state 2019-11-21 22:13:50 +00:00
jaremko 247830ab40 fix links 2019-11-10 16:13:13 +02:00
syl20bnr 55ea4dfee6 Reword answer to Spacemacs pronounciation FAQ
Fixes https://github.com/syl20bnr/spacemacs.org/issues/26
2019-11-09 14:09:15 -05:00
duianto a0bc920d4d [doc] Update beginners_tutorial.org todo key, etc.
The org-mode todo key has been changed from just: t
to: SPC m T T (same as: , T T)
in this PR: Use evil-org from MELPA #9041

The PR authors reasons were:
>- single-shortcut keys are few in number and valuable
>- the vim/evil defaults for those keys are designed for editable modes, and org
>  is an editable mode
>- practically nowhere else in Spacemacs are such keys overridden
>- the benefit of making an exception in this case is dubious
>- it's not too difficult to configure on a user level
>
>For sure, many people will be toggling todo state more often than using the t
jump operator while in org-mode, but I'm not convinced that this is worth
violating POLA in org-mode. But of course if there is consensus that I'm wrong
then I'm happy to be convinced otherwise.

source: https://github.com/syl20bnr/spacemacs/pull/9041#issuecomment-309758098

- Mentioned that: `t` can be restored for toggling todo, and added a link to the
  instructions in the org layer documentation:
  https://github.com/syl20bnr/spacemacs/blob/develop/layers/%2Bemacs/org/README.org#org-with-evil-org-mode
- Rewrote some sentences.
- Wrapped some paragraphs at 80 chars.
2019-11-09 18:55:22 +01:00
duianto f19d57eb57 [doc] add visual line nav keys, startup snippet
documentation.org
- added visual line navigation (w/w/o) globally keys and unicode/ascii symbol

faq.org
- updated snippet for enabling visual line navigation globally on startup
2019-10-30 10:00:05 +01:00
Miciah Masters 552fd5953c Update references to macOS
Apple renamed "Mac OS X" to "OS X" in 2012 and then to "macOS" in 2016.
Update references to use the current name.
2019-10-13 12:04:40 +02:00
ahanwadi 98473c2a2d Fixed a typo
share the buffer -> the buffers
2019-10-05 19:03:29 +02:00
syl20bnr ba4e790dbc [conventions] Add transient state key binding convention 2019-09-30 00:34:26 -04:00
Trey Merkley 1646a246d6 Update DOCUMENTATION.org 2019-09-21 21:26:05 +02:00
emacspace e61e91fbc5 documentation formatting: Thu Aug 29 23:13:44 UTC 2019 2019-08-30 01:17:29 +02:00
smile13241324 e40c112d55 [doc] Add more detailed troubleshooting information 2019-08-28 23:53:26 +02:00
emacspace 3747afb4b0 documentation formatting: Fri Aug 23 17:22:19 UTC 2019 2019-08-24 00:03:42 +02:00
syl20bnr bd97ef47ef Move doc for layout restriction and SPC TAB to DOCUMENTATION.org 2019-08-20 00:54:41 -04:00
bb2020 8ed7e5e7a1 Add `spacemacs/iwb-region-or-buffer'. 2019-08-11 20:15:40 +02:00
syl20bnr cfd2b110f2 Update documentation and parameters for the portable dumper 2019-07-26 15:36:08 -04:00
Aaron Zeng cc4ab653c2 Update core-dotspacemacs.el default font size
0ffdb353f9 changed the default config template to use a point size instead of a pixel size.  Change the defvar declaration as well.

Commit modified by duianto:
Updated font size in doc/documentation.org
2019-07-18 11:43:45 +02:00
JAremko 28c8bbebc2 fix link 2019-07-15 18:27:44 +03:00
duianto b9e61e6437 Add transient state keys _, j, k
Thanks sdwolfz for the suggestion to add underscore to the transient states,
then the shift key doesn't have to be released if it was held down to press `+`.

Added key bindings:
Evil numbers:
`SPC n _` decrease number under point
in the transient state:
`j` decrease number under point
`k` increase number under point

`SPC T T _` decrease transparency
`SPC z x _` scale down font
`SPC z f _` zoom out frame

Update documentation:
Zoom frame:
`q` quit transient state

Evil numbers:
`SPC n =` increase number under point
`SPC n _` decrease number under point
`0..9` add a number prefix argument
`q` quit transient state

Fixed a typo and made a small rewrite of the tip about using a prefix argument.

Added keys to transient states:
Font scaling:
Added `_` scale down
Reordered `k` assignment to match the order in the transient state

Frame transparency:
Added `_` decrease
Reordered `k` assignment to match the order in the transient state

Evil numbers:
Added `k` increase
Added `_` and `j` decrease

Zoom frame:
Added `_` zoom frame out
Reordered `k` assignment to match the order in the transient state

Which-key entries for Evil numbers `SPC n`:
Group together keys that call the same command:
From: + and =
To:   +,=

From: - and _
To:   -,_
2019-07-14 22:56:57 +02:00
Hong Xu 9637ceb389 Correct the example for stopping evilification of various magit's major-mode 2019-07-07 17:52:04 +02:00
duianto d6cdd6aa88 Add a tutorials section to SPC h T
`SPC h T e` for `emacs-tutorial` (aliased from `help-with-tutorial` for a more
descriptive name)
`SPC h T v` for `evil-tutor-start`

Added a wikipedia link to the `vi` article, where the origins of modal editing
is discussed.
2019-07-07 11:34:16 +02:00
syl20bnr 1aa0af260e Move indirect buffer key bindings to SPC b N prefix 2019-06-26 00:10:01 -04:00
syl20bnr f04ff9e837 Change SPC , to SPC j c to go to last change 2019-06-25 23:52:21 -04:00
syl20bnr 6ce974795e Change SPC j C to SPC j ( to jump to fist unbalanced parens 2019-06-25 23:49:21 -04:00
duianto 84287f020d [doc] Add relative and visual line number keys
Documented two missing line number key bindings:
`SPC t r` toggle relative line numbers
`SPC t V` toggle visual line numbers
2019-06-24 13:31:13 +02:00
jcaw d4cca74854 Add support for visual line numbers
Emacs 26 added built-in support for line numbers, relative line numbers, and
visual line numbers. Spacemacs supports only absolute and relative, but there is
no way to access the visual mode. It's hard to get around this, since Spacemacs
abstracts line numbers to a reasonably high degree.

Arguably, `visual` is much more useful than `relative` as a display type. Visual
line numbers are like relative line numbers, but only lines that are actually
showing are counted. This means:

  1. Hidden lines are not counted. If a large amount of text is folded, the line
     numbers won't jump from "10" to "546". This is particularly useful in
     buffers like `magit-status`, where a large amount of information is folded
     by default.

  2. Lines that are wrapped are counted as multiple lines, since they're being
     displayed as multiple lines in the editor. Each visual line will be
     numbered - unlike `relative`, where the entire thing is numbered... Once.

With standard relative line numbers, you can't actually navigate using the line
numbers in the sidebar as soon as folded or wrapped lines are introduced. Since
this is one of the main use cases for relative line numbers, this is a big
problem.

Visual mode fixes that problem. Every line that's being displayed is labelled.
Numbers always correspond to the actual number of lines you'd need to navigate
to reach that line.

This commit extends Spacemacs' line number interface to provide visual line
number support.
2019-06-23 19:16:44 +02:00
duianto e734e9b4a9 [doc] Fix incorrect ace-link instruction
The ace-link instruction says that it's invoked:
"with two key strokes"
but it's invoked by pressing a single letter: o
2019-06-13 01:11:23 +02:00
Ag Ibragimov cf796a4224 spacemacs/recompile-elpa with argument deletes all existing *.elc files
Rationale: very often users required to find and delete all *.elc files
manually. That's a bit tedious.
2019-06-12 20:15:51 +02:00
Anton Alekseev b5027f8f2a Add key bindings for indirect buffer functions 2019-06-08 20:36:34 +02:00
duianto 3868a5364f [doc] Fix typos and add missing/remove extra ~
Add missing ~ (tilde) around key bindings.
Remove an extra ~.
2019-06-01 20:40:22 +02:00
emacspace c7c348a676 documentation formatting: Sun May 26 20:58:52 UTC 2019 2019-05-27 01:23:35 +03:00
bb2020 e1cde25da6 Add bindings for goto-last-change and check-parens 2019-05-24 18:42:55 +02:00
emacspace 4c8d820585 documentation formatting: Sun May 19 20:32:09 UTC 2019 2019-05-19 23:52:00 +02:00
Ag Ibragimov fd76a7f300 Add j and k to transient states
It is nicer when user can stay in the "home row" for basic operations like
zooming in and out

Font Scaling Transient State
`k` scale up
`j` scale down

Frame Transparency Transient State
`k` increase transparency
`j` decrease transparency

Zoom Frame Transient State
`k` zoom frame in
`j` zoom frame out

Added two additional Zoom Frame TS keys:
`m` max frame
`f` fullscreen
2019-05-19 22:24:11 +02:00
JAremko 1554873414 fix links 2019-05-18 13:25:44 +03:00
Anton-Latukha f6660f82d4
Switch to the new layers generator 2019-05-15 21:08:21 +03:00
syl20bnr 8fa16d19a9 [editing] Document key binding ~SPC x y~ and sort them 2019-05-12 10:59:57 -04:00
syl20bnr 4e93c2fb88 [conventions] Add ~SPC m t l~ to run last executed tests 2019-05-12 10:08:28 -04:00
Witoslaw Koczewski 9a0275ffef Link updated: Somelauw/evil-org-mode
Since edwtjo/evil-org-mode doesn't receive any updates anymore, the link is changed to Somelauw/evil-org-mode.
2019-05-07 21:46:53 +02:00
Jonathan Chen c05c421026 [docs] Fix spelling, Reorder configuration functions
To logical order
2019-05-01 23:12:16 +02:00
emacspace 6f6b064c7e documentation formatting: Sat Apr 27 00:15:28 UTC 2019 2019-04-27 02:23:35 +02:00
Max Deineko 764075be70 A note about user-config and files supplied via command line arguments 2019-04-26 21:36:09 +02:00
yuhan0 a3469c04ea Add window maximization bindings to transient state 2019-04-11 10:50:41 +02:00
yuhan0 f961d622cf Add 'SPC w' leader bindings for window resizing
For convenience they directly enter the window manipulation transient state,
since resizing operations tend to involve repeated key presses.
2019-04-11 10:50:40 +02:00
emacspace 7bf2d00857 documentation formatting: Wed Apr 10 18:17:02 UTC 2019 2019-04-10 22:37:15 +02:00
Miciah Masters b1b483e4ae FAQ: Set sentence-end-double-space in user-config
The FAQ has an entry for configuring Spacemacs to use double-space as the
sentence delimiter.  This FAQ entry instructs the reader to set the
sentence-end-double-space variable in the dotspacemacs/user-init function.

The problem is that the spacemacs-defaults layer sets
sentence-end-double-space when it loads, and Spacemacs loads layers after
calling dotspacemacs/user-init, which means the layer overrides any setting
for sentence-end-double-space in dotspacemacs/user-init.

To solve this problem, this commit modifies the FAQ entry to instruct the
reader to set the variable in the dotspacemacs/user-config function, which
Spacemacs runs after loading layers.

The FAQ entry was added in commit ee4ad69847.

* doc/FAQ.org: Instruct the reader to set sentence-end-double-space in
dotspacemacs/user-init rather than in dotspacemacs/user-config.
2019-04-10 18:32:24 +02:00
smile13241324 b00767cd6e Fix partial merge of last doc update
Just cherry picked the last commit in the
previous PR and noticed that I have just
got part of the changes due to multiple
commits in the PR.

However as I did already push I am now
providing the missing changes manually
rather than to rollback the commit.
2019-04-10 00:05:32 +02:00
Anton-Latukha 16e36d75e1 doc: DOCUMENTATION.org: upd Binding keys: direct to key Conventions 2019-04-09 23:56:53 +02:00
emacspace 584084ab2d documentation formatting: Mon Apr 8 15:39:05 UTC 2019 2019-04-09 23:11:10 +02:00
syl20bnr 5f27edb107 [conventions] Add conventions for imports 2019-04-08 11:32:43 -04:00
duianto 2ef94efbf4 Add line text object using evil-textobj-line 2019-04-07 15:34:02 +02:00
emacspace 18a998b675 documentation formatting: Thu Apr 4 16:29:54 UTC 2019 2019-04-04 23:19:59 +02:00
Miciah Masters 17ec4da516 Delete helm-wikipedia-suggest key binding
Helm has removed the helm-wikipedia-suggest command, so delete Spacemacs's
key binding for the command.

4ef8299d78

* CHANGELOG.develop: Add entry.
* doc/DOCUMENTATION.org: Delete documentation for the key binding for
helm-wikipedia-suggest.
* layers/+completion/helm/packages.el (helm/init-helm): Delete the key
binding for helm-wikipedia-suggest.
2019-04-03 08:19:40 +02:00
duianto d55f39eed3 Change helm-apropos from SPC h d d to SPC h d a
Change the binding to be more mnemonic.

It calls helm-[a]propos and it pretty much describes [a]ll.
2019-02-18 16:42:12 -05:00
syl20bnr ab2fc3fb02 First part of review and tweaks of release notes 2019-01-28 23:09:29 -05:00
JAremko edf3b9d28c document new centering key bindings 2019-01-28 07:15:08 +02:00
yuhan0 6737c8c8e5 Add ivy option to buffer transient state 2019-01-21 23:06:08 +02:00
emacspace 03cb987c6d documentation formatting: Sun Jan 20 15:34:11 UTC 2019 2019-01-20 15:45:54 +00:00
Alexander Miller e7d13da61d Make treemacs the default file browser. 2019-01-20 14:31:36 +02:00
emacspace 45276bd96f documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-04 22:06:14 -05:00
emacspace 4912b54f24 documentation formatting: Mon Nov 12 22:12:39 UTC 2018 2018-11-12 22:24:27 +00:00
yuhan0 0596e90c3d Add 'z' recenter bindings for various transient states
By analogy with the "zz", "zb", "zt" vim / evil bindings, this adds an
additional key binding "z" for `recenter-top-bottom` to the following
transient states which navigate around the buffer in large jumps:
- auto-symbol-highlight
- error
- buffer
- vcs
- org-babel

This allows for repositioning of the buffer for visibility without having to
exit the transient state.

Minor updates are also made to documentation of other transient states.
2018-11-12 21:47:17 +00:00
Codruț Constantin Gușoi 9d835384cc Fixes formatting on documentation table 2018-11-12 23:07:49 +02:00
pancho horrillo d2b7b0a04a DOCUMENTATION.org: Fix typos 2018-11-12 21:07:03 +00:00
pancho horrillo b67cf79107 DOCUMENTATION.org: Add missing help keybindings
All described in the changelog for 0.200.
2018-11-12 21:04:39 +00:00
JAremko 141b6328e3 Reformat docs 2018-11-08 22:37:23 +02:00
syl20bnr f46b8c916d Update documentation for SPC b n and SPC b p 2018-11-04 10:15:19 -05:00
emacspace 901f35849a documentation fixes: Tue Oct 23 14:18:21 UTC 2018 2018-10-23 23:38:16 +03:00
emacspace 7ccddbcec6 documentation fixes:Thu Oct 18 17:07:35 UTC 2018 2018-10-18 20:39:35 +03:00
Billy Wade 7002867c24
80's => '80s 2018-10-18 19:33:56 +03:00
emacspace 0fb6470acf documentation fixes:Wed Oct 17 04:03:28 UTC 2018 2018-10-17 04:03:28 +00:00
JAremko cd39f80c24 Reformat documentation 2018-10-11 00:13:43 +03:00
Boris Buliga 12510f9854 add a special title for JAremko 2018-10-10 00:13:02 +03:00
Boris Buliga 3b24c4729b add a special title for StreakyCobra 2018-10-09 22:01:38 +01:00
deb0ch f14bf4dde1
DOCUMENTATION.org: fix typo 2018-10-06 09:30:54 +03:00