Commit graph

26 commits

Author SHA1 Message Date
Daniel Nicolai
4f8ac8fc39 Improve quick-start guide
The [quick-start](https://www.spacemacs.org/doc/QUICK_START.html) starts with
 explaining that users can build their own layers. Instead it should start by
 showing how easy and straightforward it is to use one of the existing layer,
 then continue about the possibility of creating personal layers (the
 quick-start guide is a logical place to visit first for a newcomer). It is only
 a small detail, but it can make a substantial difference for people who peek
 into the quick-start guide and decide if it is worth the trouble to switch to
 Spacemacs (Many newcomers think that even only trying another editor, is
 probably not worth it because they are already using vim).

A guide that starts explaininging that you can build your own layers in
Spacemacs that exists of a directory containing at a packages.el file, is not a
quick-start guide.
2021-05-03 21:30:54 +02:00
emacspace
9257aab154 documentation formatting: Sat Apr 17 07:08:57 UTC 2021 2021-04-17 11:32:54 +03:00
Daniel Nicolai
b3c78297fb Add describe evil ex-command functionality
For introspection purposes it can be nice to have this functionality. Also this
function can be used to discover which ex-commands are available.
2021-04-15 22:03:59 +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
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
JAremko
cd39f80c24 Reformat documentation 2018-10-11 00:13:43 +03: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
Chase Adams
c646a6b22d change spelling and grammar in quick start 2017-04-20 22:58:53 -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
Andrew Schwartzmeyer
00e0b99c35 Change 'SPC :' to 'SPC SPC' in quick start
The former was deprecated.
2016-10-08 19:27:11 +02:00
tj@data-driven.de
65faafd766 Improve dotdirectory section of QUICK_START.org. 2016-04-21 20:58:53 -04:00
Robert Johnson
16e1be2691 Fix inconsistent notation of SPC key in docs
Replace all occurrences of <SPC> in org files with SPC.

Fixes syl20bnr/spacemacs#1823
2016-04-05 12:46:10 +02:00
syl20bnr
3b0c1fd93d Convert org doc files with doc-fmt 2016-03-30 22:59:55 -04:00
Johan K. Jensen
be2c471397 Fix inline code blocks
Add zero-width space because emphasis blocks can't start/end with
a comma, an apostrophe or a quote.
2016-03-01 18:51:13 +01:00
Eivind Fonn
2442431d92 Further improve helm-descbinds documentation 2016-02-25 20:33:05 +01:00
Th. Rikl
4c2d5b9d7e Explain helm-descbind prompt more detailed 2016-02-25 20:32:36 +01:00
Balaji Sivaraman
e19abfc559 Fix/delete dead references to HOWTOs.org file 2016-01-31 23:04:47 -05:00
justbur
32f523e062 spacemacs-helm: New layer
Collect helm configuration from spacemacs and spacemacs-base into one
place. The purpose is to allow choice between this layer and
spacemacs-ivy.
2016-01-09 13:36:03 -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
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
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
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