Commit Graph

43 Commits

Author SHA1 Message Date
69ce5d5ea0 docs/getting_started: update ToC 2020-07-26 02:59:05 -04:00
135929d4ae docs/getting_started: fix heading hierarchy 2020-07-26 02:58:15 -04:00
8c2026b4ab docs/getting_started: revise & expand "Writing your own modules" 2020-07-26 02:56:27 -04:00
976a601750 docs/getting_started: add install guides for Windows
Closes #3444
Closes #2575
2020-07-24 01:49:59 -04:00
87d17fab8c docs/getting_started: general revision
An effort to make our documentation clearer, more concise in places,
simpler where possible and highlight caveats so folks aren't caught by
surprise by strange behavior.

- Remove --with-modern-cg433n-icon (#3554), as the default icon is a
  reasonable default, and I'd like to keep things simple.
- Mention "could not find package in recipe repositories" error and what
  to do about it.
- Mention that 'doom sync -u' is necessary for Doom's package manager to
  see recipe changes.
- Mention :no-byte-compile for installing local packages; to save you
  the hassle of running 'doom sync' every time you change them.
- Clarify Emacs 27 install instructions where possible (particularly for
  nixOS and Ubuntu)
2020-07-24 01:49:58 -04:00
fc2634d67b docs/getting_started: fix doom/help-{modules,autodefs} keybinds
Relevant to #3580
2020-07-17 20:13:14 -04:00
9518852597 docs/getting_started: update help keybinds
Closes #3580

Co-authored-by: Logan Barnett <logustus@gmail.com>
2020-07-17 19:40:24 -04:00
c280480262 Fix links to work on github and on code 2020-07-13 20:24:35 -03:00
73e439084d Update Mac Install for emacs-plus
The parameter is wrong. It must be --with-modern-cg433n-icon and not --with-modern-icon-cg433n

You can check it on the github repo site https://github.com/d12frosted/homebrew-emacs-plus
2020-07-05 21:39:19 +02:00
a15d31c9d4 Fix link to screenshots + minor correction in "Getting started" 2020-06-19 22:17:02 +02:00
b5be860033 Change emacs-plus icon
Change the emacs-plus icon from spacemac's logo to a more neutral modern emacs icon.
2020-06-17 19:41:38 +02:00
b445038817 Fix scoop install instructions
Just tried installing on Windows, you need to use "scoop bucket add extras" not "scoop enable extras"
2020-05-19 21:42:58 +01:00
d0a3e9260c add openSUSE installation section to getting started guide 2020-05-18 15:10:34 +08:00
a4f4937931 Add --with-modules to emacs-mac documenation
Default options for brew install emacs-mac compile wihtout
modules preventing to use vterm.
2020-05-17 00:44:52 +02:00
f2d6230736 Fix use-packages! typo in getting started 2020-05-12 13:41:13 -06:00
e8040c29b0 Adding Fedora dependencies in getting_started doc 2020-05-04 21:24:12 +02:00
be396655c4 Render 'export PATH' line correctly in docs
Github renders double quotes in blockquotes with fancy curly (unicode)
quotes. If folks copy this to their shell configs, they'll get weird
PATH bugs!

Seems neither org nor github can handle ~...~ syntax if either tilde is
adjacent to a non-alphanumeric (like double quotes), so I just did away
with them altogether.
2020-05-03 21:30:41 -04:00
916ef0fbbe Rename unmap! to undefine-key!
unmap! gives the false impression that it is related or similar to map!,
but it isn't.
2020-04-23 23:56:17 -04:00
508f6f5594 Merge pull request #2851 from tbille/patch-1
Fix install link
2020-04-08 15:35:58 -04:00
63a71ec90f Discourage unpinning all packages 2020-04-08 15:30:04 -04:00
fe458a214d Fix install link 2020-04-08 16:54:44 +01:00
776c010cb5 Fix internal documentation links containing "%20"
These links to org headers didn't work for me when they contain %20
instead of space.
2020-03-09 15:31:57 -04:00
72d3d894fd Fix for the package-management link in README. 2020-02-27 17:46:14 -05:00
3e733b88e7 Add install instructions for scoop emacs 2020-02-18 10:50:07 -08:00
2350e266c0 Clarify scoop install instructions 2020-02-18 00:20:35 -05:00
665b627b7c Update & revise docs
+ Getting Started
  + Add "Using/loading local packages" section
  + Add "Pinning packages to specific commits" section
  + Clarify prereqs & revise install docs
  + Revise package-management section
+ FAQ
  + Add package management section
2020-01-28 05:36:42 -05:00
9fa78f6a64 Update discord link again
First link wasn't a permanent link. Whoops!
2020-01-27 23:58:32 -05:00
d27ff78444 Update discord links 2020-01-27 23:36:39 -05:00
ea7a51de8b use updated brew package name to get clang 2020-01-26 00:49:26 +08:00
3308fb3718 Minor updates to documentation
- Update the keybinding for +doom/help-autodefs
- Remove silver_search from the lookup module. Ripgrep is the supported
dependency.
2020-01-13 09:54:22 +01:00
9bc3d05cb5 docs/getting_started: add macports install docs 2019-12-27 14:14:31 -05:00
10ccf27d20 docs/getting_started: revise Chemacs install guide 2019-12-13 14:21:01 -05:00
5751f8c5a5 Typo 2019-11-24 13:21:49 +02:00
27277c17e5 docs/getting_started: remove reddit link in windows instructions
The reddit post contains outdated information that shouldn't be used.

Mentioned in #2030
2019-11-12 15:24:02 -05:00
5b5c7cbaff docs/getting_started: remove markdown-isms 2019-11-09 11:51:49 -05:00
2f62d9fd00 Merge pull request #2008 from bennofs/doc-doomdir-modules
docs/getting_started: mention $DOOMDIR/modules
2019-11-05 18:48:11 -05:00
1141f724b3 Update links to Customize links and a bit 2019-11-06 05:52:49 +09:00
1a8875a175 Mention $DOOMDIR/modules explicitly in docs 2019-11-03 21:05:06 +01:00
366ac383e9 Merge pull request #1980 from ebv-gh/patch-1
docs/getting_started: fix code quoting
2019-11-01 13:15:52 -04:00
a7e8e50c40 Correct some typos 2019-10-30 14:41:10 +00:00
412674b165 docs/getting_started: remove redundant section
And mark unfinished sections with TODO.
2019-10-29 23:44:45 -04:00
2ab221cc89 fix markdown formatting 2019-10-29 15:52:40 -07:00
73e50e1bcb Add docs/getting_started.org 2019-10-29 01:10:24 -04:00