Commit Graph

48 Commits

Author SHA1 Message Date
Trevor Buchanan e715fffb3c [doc] fix incorrect key bindings for buffer functions 2021-11-02 21:34:35 +01: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
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
Zach Latta 1d2a1fa6e4 Fix capitalization of GitHub
Change instances of "Github" to "GitHub".
2020-01-20 09:14:12 +01:00
JAremko 28c8bbebc2 fix link 2019-07-15 18:27:44 +03: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 45276bd96f documentation formatting: Wed Dec 5 03:03:03 UTC 2018 2018-12-04 22:06:14 -05:00
emacspace 901f35849a documentation fixes: Tue Oct 23 14:18:21 UTC 2018 2018-10-23 23:38:16 +03:00
JAremko cd39f80c24 Reformat documentation 2018-10-11 00:13:43 +03:00
syl20bnr ebe4c60264 Revert "Defer packages by default using use-package-always-defer"
This reverts commit 29c78ce841 and all other fixes
that have been made afterwards.

The motivation is that use-package is seen by many as a replacement for
`require`. Is use-package always defer the loading of packages then is breaks
this use case, this does not respect POLA so even if it was making Spacemacs
loading faster (up to 3s faster on some startup on my machine) we just cannot
use it, it would be irresponsible. Spacemacs should be easy to use, loading
performance will come with time but it is not a priority.
2018-03-03 23:40:10 -05:00
syl20bnr e2b1cecb77 Update documentation for :defer t 2018-02-27 23:32:52 -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 94205a3e81 Fix css links and various org links 2017-04-29 10:45:52 -04:00
Archenoth 45f02b09bb Minor typo in VIMUSERS Elisp intro ("arg1 arg1" -> "arg1 arg2") 2017-04-28 22:25:24 -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
syl20bnr bcf2ce6ca4 Move SPC b k to SPC b C-d 2016-10-03 00:23:15 -04:00
bmag fe60d0fc1e Set buffer-predicate to spacemacs/useful-buffer-p
Prevent next-buffer, other-buffer, etc. from choosing useless buffers.
No need for spacemacs/next-useful-buffer,
spacemacs/previous-useful-buffer anymore.

Also fix spacemacs/alternate-buffer to respect buffer-predicate.

When spacemacs-layouts is used, buffer-predicate filters useful buffer
that belong to the current layout.
2016-07-25 20:02:28 +09:00
ivanbrennan 3c85dd7f0c fix typo in VIMUSERS Customization section
Pluralize "four top-level functions".
2016-07-25 14:03:55 +09:00
Markus Koller 58bb7d122f spacemacs-base: Always kill buffers with SPC b d
Fixes #4929
2016-06-05 21:22:50 -04:00
syl20bnr 07852abad5 Format documenation files with doc-fmt tool 2016-04-12 23:31:38 -04:00
Xiao Hanyu aa1129eee0 Fix url links in VIMUSERS.org 2016-04-07 22:58:18 -04:00
syl20bnr 3b0c1fd93d Convert org doc files with doc-fmt 2016-03-30 22:59:55 -04:00
Fabien Dubosson 06cb27e1dc [doc] Fix some additional `SPC :` to `SPC SPC` 2016-02-07 14:39:54 +01:00
Balaji Sivaraman 2b1ed603dc Change all references of micro-state in codebase to transient-state 2016-01-31 23:04:47 -05:00
person808 73a40805b3 Update tip to use new layout variable. 2016-01-05 00:45:38 -05:00
Fabien Dubosson 6cb7399cac Change `SPC f e h` to `SPC h SPC` for helm-spacemacs default binding
This make `SPC h SPC` as default binding for accessing `helm-spacemacs`,
by either A) changing all the documentation; and B) adding a deprecation
message for `SPC f e h`.

The deprecation use a warning, because if a message is used it's hidden
directly when the helm buffer is shown, making it nearly unnoticeable
for the user.
2016-01-03 22:23:12 -05:00
person808 337b9f8683 Update VIMUSERS.org for new leader key functions. 2015-12-09 00:57:52 -05:00
justbur 87d61dbd3f doc: Minor doc changes for evil-leader removal 2015-11-21 18:22:51 +01: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 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
syl20bnr 383b1bec20 Update dotspacemacs/config and dotspacemacs/init occurrences 2015-09-28 02:05:18 -04:00
person808 9fe0d8f10f Update VIMUSERS.org for new layer changes. 2015-09-07 01:06:31 -04:00
Eivind Fonn 1231a05cec Add doc on how to write layers
[ci skip]
2015-08-31 22:18:03 -04:00
justbur d1bb779340 Update docs for which-key 2015-08-26 22:58:24 -04:00
Syohei YOSHIDA a793512931 Correct misspellings 2015-08-05 00:28:48 -04:00
person808 9d44000623 Fix issues in VIMUSERS.org.
1. Fix broken links.
2. Make spacing consistent with other documentation.
3. Use a better function example. The previous one did not work for some
common use cases.
4. Update and add some screenshots for use in the file.
2015-07-04 19:32:39 -04:00
Christopher Corley 68e3d42f9d Fixes links to other documents (.md => .org) 2015-07-04 18:43:31 -04:00
Török Edwin f0e98c2113 VIMUSERS.org: remove space before closing ~, otherwise it is not highlighted 2015-06-11 21:31:42 -04:00
Diego Berrocal be73bb4edf Change VIMUSERS first headline to use toc-org package
As this includes 4 levels of headings, the tag that needs to be used is
:TOC@4:. Now every time one saves this file, the TOC is automatically
generated. There is an interesting feature from toc-org that enables
users to use org links or GitHub enabled
[links](https://github.com/snosov1/toc-org#use)
 we should discuss how to use it because on one hand, having org links
 makes it easier to read in emacs, while having GitHub links makes it
 easier to read online.
2015-06-11 21:31:41 -04:00
Tu Do cfaa6edc19 Enhance viewing Spacemacs documents in Org
- Use `~` marker to represent key bindings. The `~` and `=` markers are
equivalent in Emacs: `=` uses `org-verbatim verbatim` faces, while `~`
uses `org-code verbatim)`, but both `org-verbatim` and `org-code` is
inherited from `shadow` face. So we can use `~` marker for this purpose.
`~` marker is also displayed properly on Github, since it's part of
standard Emacs, so no web functionality is broken.

- Add org-kbd face for displaying key bindings.

- Update CHANGELOG.org: use the proper `~` marker for key bindings.

- Update VIMUSERS.org: use the proper `~` marker for key bindings.
2015-06-09 20:36:19 -04:00
person808 8f3d65e59b Vim migration guide: Initial version. 2015-06-06 01:01:09 -04:00