You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix all markdownlint warnings across docs and README
- Rewrap long lines to stay under 80 chars (MD013)
- Normalize heading style to atx in README (MD003)
- Move heading before badges in README (MD041)
- Add language specifiers to fenced code blocks (MD040)
- Fix table alignment (MD060)
- Replace non-descriptive "[here]" link text (MD059)
- Disable MD046/MD060 in config (MkDocs admonitions and mixed
table styles conflict with these rules)
curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
60
65
```
61
66
62
67
Note that the installer will back up any existing `.emacs` file or
63
68
`.emacs.d` since it will unpack Prelude's code in `.emacs.d`. If
64
-
you're doing a manual install make sure you don't have a `.emacs` file
65
-
or back up your existing `.emacs.d` directory manually.
69
+
you're doing a manual install make sure you don't have a `.emacs`
70
+
file or back up your existing `.emacs.d` directory manually.
66
71
67
-
**Important:** Don't forget to adjust your `prelude-modules.el` file in your personal directory
72
+
**Important:** Don't forget to adjust your
73
+
`prelude-modules.el` file in your personal directory
68
74
once the installation is done. By default most of the modules
69
75
that ship with Prelude are **not** loaded.
70
76
71
-
###Try Before You "Buy"
77
+
## Try Before You "Buy"
72
78
73
-
If you're using Emacs 29+ there's a simple way to try Prelude (or any other Emacs distro for that matter).
79
+
If you're using Emacs 29+ there's a simple way to try Prelude
80
+
(or any other Emacs distro for that matter).
74
81
Just clone Prelude's repo somewhere and do the following:
75
82
76
83
```shell
@@ -84,61 +91,85 @@ Prelude's philosophy is quite simple:
84
91
- simple
85
92
- easy to understand and extend
86
93
- stable
87
-
- a foundation for you to build upon, as opposed to some end-user product
94
+
- a foundation for you to build upon, as opposed to some
95
+
end-user product
88
96
89
-
This means that it intentionally doesn't pack all the bells and whistles that it could.
90
-
Prelude aims to enhance the classic Emacs experience without deviating a lot from it - e.g.
91
-
it would never enable something like `evil-mode` (vim keybindings) by default and so on.
97
+
This means that it intentionally doesn't pack all the bells
98
+
and whistles that it could. Prelude aims to enhance the classic
99
+
Emacs experience without deviating a lot from it - e.g.
100
+
it would never enable something like `evil-mode`
101
+
(vim keybindings) by default and so on.
92
102
93
-
All the third-party packages that it bundles are carefully vetted and are known to be of
94
-
good quality and to have reliable maintainers. That generally means that Prelude's unlikely
95
-
to immediate adopt some shiny new package, that has established tried and true alternatives.
103
+
All the third-party packages that it bundles are carefully
104
+
vetted and are known to be of good quality and to have reliable
105
+
maintainers. That generally means that Prelude's unlikely
106
+
to immediate adopt some shiny new package, that has established
107
+
tried and true alternatives.
96
108
97
109
In practice this translates to the following:
98
110
99
-
- Prelude is less opinionated than distros like Spacemacs and Doom Emacs (meaning it's closer to the standard Emacs experience)
111
+
- Prelude is less opinionated than distros like Spacemacs and
112
+
Doom Emacs (meaning it's closer to the standard Emacs
113
+
experience)
100
114
- Prelude installs relatively few additional packages by default
101
-
- Most modules in Prelude are opt-in instead of opt-out (you'll notice the default config enables only a handful of modules)
102
-
- Most modules (e.g. modules for programming languages) are pretty short and feature setup only for essential packages (in some cases that be just the major mode for the language in question)
103
-
- You don't really need to track Prelude's upstream - you're encouraged to just fork it and use it as the basis for your own configuration.
104
-
105
-
Remember that the ultimate goal of every Emacs user is to create an Emacs setup that reflects their own experience, needs, goals and ideas. Just like Lisp,
106
-
Emacs is nothing but a raw building material for the perfect editing experience.
107
-
108
-
More installation options are discussed [here](https://prelude.emacsredux.com/en/latest/installation/).
115
+
- Most modules in Prelude are opt-in instead of opt-out
116
+
(you'll notice the default config enables only a handful of
117
+
modules)
118
+
- Most modules (e.g. modules for programming languages) are
119
+
pretty short and feature setup only for essential packages
120
+
(in some cases that be just the major mode for the language
121
+
in question)
122
+
- You don't really need to track Prelude's upstream - you're
123
+
encouraged to just fork it and use it as the basis for your
124
+
own configuration.
125
+
126
+
Remember that the ultimate goal of every Emacs user is to
127
+
create an Emacs setup that reflects their own experience,
128
+
needs, goals and ideas. Just like Lisp, Emacs is nothing but a
129
+
raw building material for the perfect editing experience.
While `use-package` provides a nice way of structuring your
12
-
configuration (especially if you're into single-file setups), it also adds a layer of complexity as it's just a macro
13
-
that expands to some "traditional" configuration code. One aspect of `use-package` that's a bit tricky is where to place cross-package configuration, as it can potentially go to different configuration blocks.
14
-
15
-
Given how modular the structure of Prelude is, there's relatively little to be gained by adopting `use-package` everywhere, but end users are free to use `use-package` for their personal configuration.
13
+
configuration (especially if you're into single-file setups),
14
+
it also adds a layer of complexity as it's just a macro
15
+
that expands to some "traditional" configuration code. One
16
+
aspect of `use-package` that's a bit tricky is where to place
17
+
cross-package configuration, as it can potentially go to
18
+
different configuration blocks.
19
+
20
+
Given how modular the structure of Prelude is, there's
21
+
relatively little to be gained by adopting `use-package`
22
+
everywhere, but end users are free to use `use-package` for
23
+
their personal configuration.
16
24
17
25
!!! Note
18
26
19
-
I have a stripped-down version of Prelude for personal use, based on `use-package` [here](https://github.com/bbatsov/emacs.d).
27
+
I have a stripped-down version of Prelude for personal
28
+
use, based on `use-package`
29
+
[in this repo](https://github.com/bbatsov/emacs.d).
20
30
I guess it might be of interest to some of you.
21
31
22
-
**Update (2023):** There are now plans to include `use-package` in Emacs 29, which will likely increase its prominence. Prelude 1.2 auto-installs `use-package` and newer Prelude modules might make use of `use-package`. `prelude-vertico` is one such example.
32
+
**Update (2023):** There are now plans to include
33
+
`use-package` in Emacs 29, which will likely increase its
34
+
prominence. Prelude 1.2 auto-installs `use-package` and
35
+
newer Prelude modules might make use of `use-package`.
36
+
`prelude-vertico` is one such example.
23
37
24
38
## Why does Prelude use MELPA instead of MELPA Stable by default?
25
39
26
-
Mostly because many package authors/maintainers don't have the habit to cut
27
-
"stable" releases of their projects. It seems that's changing for the better
28
-
in recent years, so Prelude's defaults might change down the road.
40
+
Mostly because many package authors/maintainers don't have
41
+
the habit to cut "stable" releases of their projects. It seems
42
+
that's changing for the better in recent years, so Prelude's
43
+
defaults might change down the road.
29
44
30
45
## Why is Zenburn the default color theme?
31
46
32
-
No particular reason other than the fact that I like it a lot and happen to maintain
33
-
its Emacs port. I believe it's pretty nice improvement over the default Emacs theme, but your perspective might be different.
47
+
No particular reason other than the fact that I like it a lot
48
+
and happen to maintain its Emacs port. I believe it's pretty
49
+
nice improvement over the default Emacs theme, but your
0 commit comments