Skip to content

Commit 89aa968

Browse files
committed
Fix markdown lint issues in the upgrade guide
Wrap long lines, fix table alignment, use reference-style link for the tree-sitter grammar URL.
1 parent 3040e04 commit 89aa968

File tree

1 file changed

+44
-22
lines changed

1 file changed

+44
-22
lines changed

README.md

Lines changed: 44 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -128,47 +128,64 @@ The [super-save](https://github.com/bbatsov/super-save) package also used to be
128128

129129
## Upgrading to Prelude 2.0
130130

131-
Prelude 2.0 is a major release that modernizes the entire distribution around Emacs 29+ features. Here's what you need to know:
131+
Prelude 2.0 is a major release that modernizes the entire
132+
distribution around Emacs 29+ features. Here's what you need to know:
132133

133134
### Emacs 29.1 is now required
134135

135-
Prelude no longer supports Emacs 28 or older. If you haven't upgraded yet, now's the time. Emacs 29 brings built-in tree-sitter, Eglot (LSP client), `use-package`, and many other improvements that Prelude 2.0 takes full advantage of.
136+
Prelude no longer supports Emacs 28 or older. If you haven't
137+
upgraded yet, now's the time. Emacs 29 brings built-in tree-sitter,
138+
Eglot (LSP client), `use-package`, and many other improvements that
139+
Prelude 2.0 takes full advantage of.
136140

137141
### Tree-sitter support
138142

139-
For built-in modes that ship both classic and tree-sitter variants (e.g., `python-mode` / `python-ts-mode`), Prelude automatically selects the tree-sitter version when a grammar is available and falls back to the classic mode when it isn't. Some modules use tree-sitter modes unconditionally (e.g., `prelude-ocaml` uses `neocaml` which is tree-sitter-only), though such modes typically auto-install their grammars.
143+
For built-in modes that ship both classic and tree-sitter variants
144+
(e.g., `python-mode` / `python-ts-mode`), Prelude automatically
145+
selects the tree-sitter version when a grammar is available and falls
146+
back to the classic mode when it isn't. Some modules use tree-sitter
147+
modes unconditionally (e.g., `prelude-ocaml` uses `neocaml` which is
148+
tree-sitter-only), though such modes typically auto-install their
149+
grammars.
140150

141-
To install tree-sitter grammars, use `M-x treesit-install-language-grammar`. See the [Emacs manual](https://www.gnu.org/software/emacs/manual/html_node/emacs/Language-Grammar.html) for details.
151+
To install tree-sitter grammars, use
152+
`M-x treesit-install-language-grammar`. See the
153+
[Emacs manual][ts-grammar] for details.
154+
155+
[ts-grammar]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Language-Grammar.html
142156

143157
### Built-in LSP via Eglot
144158

145-
Prelude 2.0 adds LSP support to most language modules using Eglot (built-in since Emacs 29) as the default client. If you were previously using `prelude-lsp` with lsp-mode, note that:
159+
Prelude 2.0 adds LSP support to most language modules using Eglot
160+
(built-in since Emacs 29) as the default client. If you were
161+
previously using `prelude-lsp` with lsp-mode, note that:
146162

147163
- The module has been renamed to `prelude-lsp-mode`.
148-
- Set `(setq prelude-lsp-client 'lsp-mode)` in your personal config to keep using lsp-mode.
164+
- Set `(setq prelude-lsp-client 'lsp-mode)` in your personal
165+
config to keep using lsp-mode.
149166
- The default is now Eglot -- no extra packages needed.
150167
- Eglot keybindings live under `C-c C-l` (rename, code actions, format, etc.).
151168

152169
### Removed packages and modules
153170

154171
Several outdated packages have been replaced by built-in alternatives:
155172

156-
| Removed | Replacement |
157-
|---------|-------------|
158-
| `nlinum` | Built-in `display-line-numbers-mode` |
159-
| `anzu` | Built-in `isearch-lazy-count` |
160-
| `epl` | Built-in `package-upgrade-all` / `package-upgrade` |
161-
| `smex` (binding) | `execute-extended-command` |
162-
| `anaconda-mode` | LSP (Eglot/lsp-mode) |
163-
| `js2-mode` | `js-ts-mode` + LSP |
164-
| `tide` | `typescript-ts-mode` + LSP |
165-
| `alchemist` | LSP |
166-
| `go-projectile` | Removed (unmaintained) |
167-
| `prelude-selectrum` | Use `prelude-vertico` instead |
173+
| Removed | Replacement |
174+
|---------------------|--------------------------------------|
175+
| `nlinum` | Built-in `display-line-numbers-mode` |
176+
| `anzu` | Built-in `isearch-lazy-count` |
177+
| `epl` | Built-in `package-upgrade-all` |
178+
| `smex` (binding) | `execute-extended-command` |
179+
| `anaconda-mode` | LSP (Eglot/lsp-mode) |
180+
| `js2-mode` | `js-ts-mode` + LSP |
181+
| `tide` | `typescript-ts-mode` + LSP |
182+
| `alchemist` | LSP |
183+
| `go-projectile` | Removed (unmaintained) |
184+
| `prelude-selectrum` | Use `prelude-vertico` instead |
168185

169186
### Keybinding changes
170187

171-
- `C-x p` no longer opens `proced` (this prefix is now reserved for `project.el`).
188+
- `C-x p` no longer opens `proced` (reserved for `project.el`).
172189
- `C-x C-m` runs `execute-extended-command` instead of `smex`.
173190
- `C-c c` is bound to `org-capture`.
174191
- `C-c C-l` prefix is used for Eglot commands in programming modes.
@@ -177,9 +194,14 @@ Several outdated packages have been replaced by built-in alternatives:
177194

178195
1. **Update Emacs** to 29.1 or newer.
179196
2. **Pull the latest Prelude** and restart Emacs. Packages will be updated automatically.
180-
3. **Review your `prelude-modules.el`** -- if you had `prelude-lsp` enabled, rename it to `prelude-lsp-mode`. If you want Eglot (recommended), you don't need any LSP module enabled.
181-
4. **Install tree-sitter grammars** for your languages of choice (optional but recommended).
182-
5. **Check your personal config** for references to removed packages (`nlinum`, `anzu`, `epl`, `anaconda-mode`, `js2-mode`, `tide`, `alchemist`).
197+
3. **Review your `prelude-modules.el`** -- if you had `prelude-lsp`
198+
enabled, rename it to `prelude-lsp-mode`. If you want Eglot
199+
(recommended), you don't need any LSP module enabled.
200+
4. **Install tree-sitter grammars** for your languages of choice
201+
(optional but recommended).
202+
5. **Check your personal config** for references to removed packages
203+
(`nlinum`, `anzu`, `epl`, `anaconda-mode`, `js2-mode`, `tide`,
204+
`alchemist`).
183205

184206
## Known issues
185207

0 commit comments

Comments
 (0)