Commit graph

104 commits

Author SHA1 Message Date
emacspace
bfb3cdad8a documentation formatting: Sat Mar 20 21:07:12 UTC 2021 2021-03-21 00:46:47 +02:00
Daniel Nicolai
e702cbac4e Add to docs, replacing a layer package with a local version
When contributing to packages it is often handy to replace a package, already
installed and configured by some layer with a local version of the package (i.e.
a git repo). This commit adds instructions for how to achieve that.
2021-03-19 13:12:45 +01:00
Ilya Grigoriev
b5e32b42c0 FAQ on including _ in words for * searches
This expands the entry on including underscores and dashes in word motions to discuss `*` and `#` searches. There is a new solution for them is different, and simpler, than the solution for the other motions (but it is difficult to find).

For me, personally, this obviates the necessity of messing with the syntax definitions.

Some related issues: https://github.com/syl20bnr/spacemacs/issues/9740, 
https://github.com/syl20bnr/spacemacs/pull/1248, 
https://github.com/syl20bnr/spacemacs/issues/1261.

Many thanks to lyro@ for fixing https://github.com/emacs-evil/evil/issues/360.
2021-03-14 00:15:24 +01:00
ClarityStorm
d1578dd4a9 Expand solution for underscores in word motions 2020-09-08 20:47:51 +02: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
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
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
Hong Xu
9637ceb389 Correct the example for stopping evilification of various magit's major-mode 2019-07-07 17:52:04 +02:00
emacspace
c7c348a676 documentation formatting: Sun May 26 20:58:52 UTC 2019 2019-05-27 01:23:35 +03:00
Anton-Latukha
f6660f82d4
Switch to the new layers generator 2019-05-15 21:08:21 +03: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
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
JAremko
cd39f80c24 Reformat documentation 2018-10-11 00:13:43 +03:00
JAremko
6946e255e6 Reformat docs 2018-07-20 02:45:21 +03:00
syl20bnr
6220ace290 core: rework environment variables and PATH management
See updated DOCUMENTATION.org and FAQ.org for more info.

* add core-env.el
* add library load-env-vars.el
* add bootstrap package dotenv-mode.el
* remove spacemacs-environment from bootstrap layer
* remove dotspacemacs variable dotspacemacs-import-env-vars-from-shell
* remove dotspacemacs variable dotspacemacs-improt-env-vars-shell-file-name
* add new key binding SPC f e e to open spacemacs.env file
* add new key binding SPC f e E to reload environment variable from env file
* add new key binding SPC f e C-e to re-initialize the env file from shell.
2018-06-25 02:55:28 -04:00
Jaremy Creechley
4a73b15503 General solution for underscores in word-motions
c.f. https://github.com/syl20bnr/spacemacs/issues/1261 

I am currently going between many programming languages and the current solution falls short for me. The 'prog-mode-hook seems to work pretty well.
2018-05-25 01:41:48 +03:00
Nicolas Forgerit
c73844f291 Fix typo 2018-02-17 16:09:06 -05:00
syl20bnr
0f646b884d Add properties for mode-line theme, remove powerline-scale
Since we have now a variable for the mode-line theme, it makes sense to move
the scaling of the mode-line to this variable. Thus the property
=:powerline-scale= of variable dotspacemacs-default-font has been removed and
it is replace by the property =:separator-scale= used in the variable
=dotspacemacs-mode-line-theme=.

This commit also adds a the property =:sperator= for the variable
=dotspacemacs-mode-line-theme= which allows to set the separator type.

Example of the final result:

   dotspacemacs-mode-line-theme '(all-the-icons
                                  :separator cup
                                  :separator-scale 1.5)

Documentation has been updated to reflect the changes.
2018-01-16 22:59:29 -05:00
JAremko
106f98497e Update README.org template
Replace some local Org links with GitHub ones
2017-07-23 01:22:20 +03:00
JAremko
6c5a0b2b14 update docs to the new toc-org format 2017-05-22 18:35:37 +03:00
JAremko
dc5781f715 fix link 2017-05-22 18:32:47 +03:00
deb0ch
7280f1a6be FAQ: add "where to start learning elisp" section 2017-05-14 22:08:13 -04:00
David
eaf7ef05b8 FAQ: Fix git clone command for trying Spacemacs 2017-05-14 22:05:31 -04:00
JAremko
bd866b6c99 docker: add develop tag to spacemacs-docker images
also fix some links
2017-05-14 12:48:53 -04:00
Darkhan Kubigenov
a5c94b3328 Fix typos in documentation 2017-05-03 22:46:24 -04:00
JAremko
c1e4556882 Format and cleanup docs. Fix links. 2017-04-28 23:29:14 -04:00
person808
6dc447cf5f Documentation fixes.
Fixes:
  - Typo
  - Code block indentation
  - Put keybindings on one line so they look nicer when viewed in Spacemacs
  - Make one sentence sound better
2017-04-19 22:51:08 -04:00
smile13241324
289e963218 Remove CUSTOM ID from documentation to fix #8216
Previously we entered the CUSTOM IDs manually into the
documentation files to fix the html export.
However today this is done automatically during export.
In this case the manually added ids are interfering
with this process and consequently are visible in the
web pages. Therefore I have removed them again.
2017-04-17 18:37:26 -04:00
nikolaiam
76213f982c Fix export-breaking org links in documentation
As discussed in #8054 and #8136, org doesn't always export links correctly if
the syntax deviates from the one given on the org mode website. This results
in broken links on github and/or spacemacs.org as in #6722, #8036, #8054, #7956
and possibly others.

This modifies all links not already fixed in #8136. Internal links are
handled with Custom IDs. External file links are formatted according to org
guidelines as well (see bottom), and if they point to a specific headline in an
external file, a custom ID is created as well.

Fixes #6722, #8036, #7956, #7916 as well as other unreported broken
links.

http://orgmode.org/manual/External-links.html#External-links
http://orgmode.org/manual/Internal-links.html#Internal-links

TODO: make Custom IDs invisble in space-org-mode
2017-01-12 22:49:07 -05:00
John Stevenson
8840c94448 evil-escape documentation link update
Updated the FAQ evil-escape documentation link to point to the "14.1.1 Escaping" section of the documentation, where the evil-escape function is described.

Currently the FAQ evil-escape documentation link points to http://spacemacs.org/doc/DOCUMENTATION.html#orgheadline78, which takes you to the "13.1 Layouts" section of the documentation.
2016-12-27 19:20:00 +00:00
syl20bnr
5e4f609a19 FAQ: add explanation about the usage of the word "distribution" 2016-10-09 12:25:56 -04:00
ChuntaoLu
e659965a70
fix typo 2016-09-23 10:45:59 +03:00
JAremko
95f4119366 disabled by default centering in space-doc-mode.
Fix centered-buffer-mode conflict with Emacs 25
2016-09-05 21:12:52 -04:00
JAremko
328c6b81aa Add aspect ratio check for centering.
Fix git conflict.
minor improvements and cleanup.
2016-08-21 17:29:19 +02:00
JAremko
7140e8dfa8 Add extra checks, cleanup
simplify space-doc customization

rearrange defcustom groups

more checks
2016-08-21 17:29:16 +02:00
JAremko
9ba525cdde simplify space-doc-mode
refactoring
2016-08-21 17:29:13 +02:00
Eivind Fonn
e94ab321cd faq: add exec-path-from-shell entry 2016-08-21 17:25:36 +02:00
syl20bnr
1e64768fb7 core: rename dotspacemacs-download-packages
Rename dotspacemacs-download-packages to dotspacemacs-install-packages
to better reflect the changes in the previous commit.

Also change the value 'used to 'used-only (note that 'used is still
supported for backward compatibility).
2016-08-19 21:31:57 -03:00
Caleb Meyer
94d71cda83
Fix notes on wrong powerline separators
I recently uninstalled railwaycat's emacs-mac-port (the old
recommendation for OS X) and installed @d12frosted's emacs-plus.

When I did that my powerline separators became just slightly off in
color from the rest of the spaceline. Asking on chat yielded that
ns-use-srgb-colorspace is set to true by default but should be nil.
2016-07-22 12:59:29 +03:00
JAremko
f9a846d2ee Integrate centered-buffer-mode and space-doc-mode. 2016-07-06 21:27:34 -04:00
JAremko
7a52759aa3 Rework buffer centering mode.
Add functions:
  - `spacemacs/maximize-horizontally` `SPC w _`
  - `spacemacs/toggle-centered-buffer-mode` `SPC w c`
  - `spacemacs/centered-buffer-mode-full-width` `SPC w C`
2016-07-06 21:27:17 -04:00
JAremko
e3c86859b3 refactor space-doc, add to the FAQ. 2016-07-05 00:23:16 -04:00
syl20bnr
829f00a824 Add more info for fish shell and ansi-term 2016-06-22 23:28:41 -04:00
d12frosted
52202cc927
fix double equals sign in FAQ 2016-06-17 09:28:09 +03:00
syl20bnr
f23ecf0b12 Rename +distribution to +distributions 2016-06-08 22:17:04 -04:00
syl20bnr
60f5a3a0fa New dotfile variable dotspacemacs-download-packages
This new variable replace dotspacemacs-delete-orphan-packages

It defines the behaviour of Spacemacs when downloading packages.

Possible values are `used', `used-but-keep-unused' and `all'.
- `used' will download only explicitly used packages and remove any
unused packages as well as their dependencies.
- `used-but-keep-unused' will download only the used packages but won't
delete them if they become unused.
- `all' will download all the packages regardless if they are used or
not and packages won't be deleted by Spacemacs.

Default value is `used`.
2016-05-30 22:58:59 -04:00
MadAnd
87f5d89d3e FAQ.org: fix text 2016-05-27 00:32:05 -04: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