Commit graph

34 commits

Author SHA1 Message Date
casswedson
120ce6959d
Fix some typos (#14832) 2021-06-06 23:43:22 +00:00
emacspace
8fff0ea4ee documentation formatting: Sat Oct 3 18:54:32 UTC 2020 2020-10-03 22:24:57 +03:00
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
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
jaremko
247830ab40 fix links 2019-11-10 16:13:13 +02: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
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
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
Anton-Latukha
f6660f82d4
Switch to the new layers generator 2019-05-15 21:08:21 +03: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
JAremko
cd39f80c24 Reformat documentation 2018-10-11 00:13:43 +03:00
John Eismeier
5e3c96562a Propose a couple of spelling corrections 2018-08-02 00:20:06 +03:00
Olivier Verdier
ef36dbb2a4 Key sequence to access FAQ 2018-02-24 19:49:38 -05:00
J. Patrick Lanigan
955f828cd4 Fix links in BEGINNERS_TUTORIAL.org
See #9346
2017-08-06 04:50:43 +03:00
JAremko
6c5a0b2b14 update docs to the new toc-org format 2017-05-22 18:35:37 +03:00
Nikolai Myllymäki
3b4aff8cdb Remove redundant installation instructions
The readme.md documents the first startup comprehensively, so the duplicate
information is removed from the beginners tutorial.
2017-05-03 22:47:58 -04:00
Darkhan
a488a56e8e Fix a typo in beginners tutorial 2017-04-28 23:09:52 -04:00
Nikolai Myllymäki
419fc605ec Add commands for font install on macOS
Add brew commands for Source Code Pro installation to installation instructions
in README.md, describe command usage and add missing capitalisation.

Concentrate installation instructions

Make installation instructions more beginner-friendly, concise and thorough:
- Add Git to prerequisites
- Move specific git clone instructions for Windows users from beginners
tutorial to README.md
- Move fallback font installation instructions and info from beginners tutorial
to README.md
- Remove redundant install steps from beginners tutorial
- Misc. typo fixes and wording improvements
2017-04-20 22:29:25 -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
Nikolai Myllymäki
ec08c9d734 Fix links and instructions in beginners tutorial
- Fix broken org link, make links relative as in other documentation and get
them to work correctly in github, spacemacs.org and Spacemacs.

- Add instructions for copying the tutorial and editing it for org mode intro
purposes. The instructions for testing org-mode did not work when the tutorial
was opened in read-only mode.

- The link to the FAQ was said to be online while it would open inside
Spacemacs when clicked. The wording is improved to reflect the actual
behaviour.

- Replace instances of "enter" with "~RET~".
2017-04-17 23:18:35 -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
smile13241324
84c36ade86 Fix links in documentation which breaks org html export
Since org 9 internal links must be declared either as #customID
or textTargetOrFullTextSearch. Relative path links must
be either file:relative/path or ./relative/path. Many links
are using the #customID form to trigger a full text search which is not
defined as to the org documentation. In addition relative file paths are
declared as relative/path which is also not defined. If this is done
the html export can fail. Therefore these links must be corrected
for the files where they break the html export.
Fixes #8054 for all spacemacs documentation files.
2017-01-12 22:48:57 -05:00
Nikolai Myllymäki
f4368bc092
Add info about the fallback fonts 2017-01-04 20:27:52 +02:00
Nikolai Myllymäki
0265aca91a
Add explanation of menu usage and accessing files 2017-01-04 20:27:49 +02:00
Nikolai Myllymäki
c5a6006563
Direct font installation link to the right section 2017-01-04 20:27:45 +02:00
Nikolai Myllymäki
2dd0befc6a
Add Spacemacs ABC and Gitter chat to further info 2017-01-04 20:27:40 +02:00
Nikolai Myllymäki
4de3611648
Improved link formatting, minor text edits
Also fixed a broken link
2017-01-04 20:27:30 +02:00
Leandro Lisboa Penz
998f5dcf9a
Fix a link on beginner's tutorial 2017-01-04 20:26:17 +02:00
Rory O’Kane
31bc9425ff Fix typo in beginner’s tutorial – “differend” 2016-11-20 18:54:48 -05:00
syl20bnr
c379cd46cd Beginnier tutorial: refill paragraphs to respect 80col/line 2016-11-07 10:05:27 -05:00
Nikolai Myllymäki
8dd2eb410f Add beginners tutorial - further amendments
Amend suggested fixes:
- Add chapter on key notation
- Fix document structure according to conventions
- Add note on emacs path on Windows
- Expand on evil and emacs mode explanations
- Expand on first startup procedure
- Various typo fixes and clarifications
2016-11-07 10:02:45 -05:00