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.
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).
* 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.
- 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
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.
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.
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.
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.
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.
`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`».
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.
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?
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).
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
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.
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.
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`.
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.
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.
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!
"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.
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.
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.
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.
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".
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.
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)
The logic for binding this to `SPC p a` is that it's analogous with
vim-projectionist's notion of "alternate" files (where alternates could
be tests, headers or what-have-you). It would be more in keeping with
Spacemacs to have it on `SPC p t`, however this is already taken by
projectile neotree. If that were to be moved to `SPC p n`, then there
would be space for it, but I have no idea whether there is stomach to
make a potentially significant change such as that.
