Adopt an uniform style across all Markdown files in the project

Author: bbatsov

.markdownlint-cli2.yaml

@@ -0,0 +1,8 @@
+config:
+  default: true
+  MD004:
+    style: dash
+  MD007:
+    indent: 2
+  MD029:
+    style: ordered

CHANGELOG.md

@@ -4,74 +4,74 @@
 
 ### New features
 
-* Enable `org-habits`.
-* Neatly track `TODO` state changes in a drawer (LOGBOOK), thereby improving readability.
-* Add a module to enable Literate Programming (`prelude-literal-programming.el`).
-* Add a Racket module.
-* Add a Lua module.
-* Auto-install `racket-mode` if needed.
-* Add a F# module.
-* Auto-install `use-package`.
-* Add `prelude-vertico` module. Vertico a simpler alternative to `ivy-mode` and supersedes Selectrum.
-* [#1421](https://github.com/bbatsov/prelude/issues/1421): Make it possible to configure the TypeScript format action using `prelude-ts-format-action`.
-* [#1354](https://github.com/bbatsov/prelude/issues/1354): Remove default `C--` and `C-+` keybindings to increase/decrease the font size.
+- Enable `org-habits`.
+- Neatly track `TODO` state changes in a drawer (LOGBOOK), thereby improving readability.
+- Add a module to enable Literate Programming (`prelude-literal-programming.el`).
+- Add a Racket module.
+- Add a Lua module.
+- Auto-install `racket-mode` if needed.
+- Add a F# module.
+- Auto-install `use-package`.
+- Add `prelude-vertico` module. Vertico a simpler alternative to `ivy-mode` and supersedes Selectrum.
+- [#1421](https://github.com/bbatsov/prelude/issues/1421): Make it possible to configure the TypeScript format action using `prelude-ts-format-action`.
+- [#1354](https://github.com/bbatsov/prelude/issues/1354): Remove default `C--` and `C-+` keybindings to increase/decrease the font size.
 
 ### Changes
 
-* Bind all essential `avy` commands to their recommended keybindings.
-* Remove `company-lsp`.
-* Replace `yank-pop` key-binding to `counse-yank-pop` for `ivy-mode`.
-* The keybinding for `proced` is now enabled unconditionally.
-* Replace prelude-go backend with `lsp` instead of unmaintained tools.
-* Use `rust-analyzer` as language server for prelude-rust and provide nicer syntax highlighting with `tree-sitter`.
-* Use `js2-mode` for Node.js specific `.cjs` and `.mjs` extensions.
-* Add `prelude-undo-tree` custom variable: allows user disable
+- Bind all essential `avy` commands to their recommended keybindings.
+- Remove `company-lsp`.
+- Replace `yank-pop` key-binding to `counse-yank-pop` for `ivy-mode`.
+- The keybinding for `proced` is now enabled unconditionally.
+- Replace prelude-go backend with `lsp` instead of unmaintained tools.
+- Use `rust-analyzer` as language server for prelude-rust and provide nicer syntax highlighting with `tree-sitter`.
+- Use `js2-mode` for Node.js specific `.cjs` and `.mjs` extensions.
+- Add `prelude-undo-tree` custom variable: allows user disable
   undo-tree integration. Enabled by default to maintain backward-compatibility.
 
 ### Bugs fixed
 
-* Fix `company` still being visible in the mode line.
-* [#1335](https://github.com/bbatsov/prelude/issues/1335): Workaround
+- Fix `company` still being visible in the mode line.
+- [#1335](https://github.com/bbatsov/prelude/issues/1335): Workaround
   for `which-key` bug causing display issues in clients to `emacs --daemon`.
-* Fix **Edit on GitHub** link in ReadTheDocs site.
-* Fix fall back to sample `prelude-modules.el` not working if user has installed to non-default location.
-* Stop requiring `helm-config` since upstream has removed the module.
-* Require `typescript-mode` using `prelude-require-packages` to avoid error upon inclusion in `personal/prelude-modules.el`.
-* Turn off `super-save` in `rust-mode` to prevent severe hangs during autocomplete.
-* Update `prelude-dart.el` to use `lsp-dart-dap-setup` instead of deprecated `dap-dart-setup` function.
+- Fix **Edit on GitHub** link in ReadTheDocs site.
+- Fix fall back to sample `prelude-modules.el` not working if user has installed to non-default location.
+- Stop requiring `helm-config` since upstream has removed the module.
+- Require `typescript-mode` using `prelude-require-packages` to avoid error upon inclusion in `personal/prelude-modules.el`.
+- Turn off `super-save` in `rust-mode` to prevent severe hangs during autocomplete.
+- Update `prelude-dart.el` to use `lsp-dart-dap-setup` instead of deprecated `dap-dart-setup` function.
 
 ## 1.1.0 (2021-02-14)
 
 ### New features
 
-* Enable `nlinum-mode` or `display-line-numbers-mode` by default. Can be disabled by setting `prelude-minimalistic-ui` to `t`.
-* Enable site-wide installation for Prelude.
-* Auto-installs `julia-mode` if needed.
-* Auto-install `adoc-mode` for AsciiDoc files.
-* Add the `ag` package. It provides a nice alternative to `grep` and has nice Projectile integration.
-* Added additional configuration modules for WSL (`prelude-wsl`) and Windows (`prelude-windows`).
-* Add `prelude-selectrum` module. Selectrum a simpler alternative to `ivy-mode`.
+- Enable `nlinum-mode` or `display-line-numbers-mode` by default. Can be disabled by setting `prelude-minimalistic-ui` to `t`.
+- Enable site-wide installation for Prelude.
+- Auto-installs `julia-mode` if needed.
+- Auto-install `adoc-mode` for AsciiDoc files.
+- Add the `ag` package. It provides a nice alternative to `grep` and has nice Projectile integration.
+- Added additional configuration modules for WSL (`prelude-wsl`) and Windows (`prelude-windows`).
+- Add `prelude-selectrum` module. Selectrum a simpler alternative to `ivy-mode`.
 
 ### Changes
 
-* [#1292](https://github.com/bbatsov/prelude/issues/1292): Add `prelude-python-mode-set-encoding-automatically` defcustom inn `prelude-python.el` module with nil default value.
-* [#1278](https://github.com/bbatsov/prelude/issues/1278): Don't disable `menu-bar-mode` unless `prelude-minimalistic-ui` is enabled.
-* [#1277](https://github.com/bbatsov/prelude/issues/1277): Make it possible to disable the creation of `Super`-based keybindings via `prelude-super-keybindings`.
-* Removed deprecated alias `prelude-ensure-module-deps`.
-* Remove `prelude-fullscreen`, as these days people can use `toggle-frame-fullscreen` instead. (it was introduced in Emacs 24.4)
-* Removed `beacon-mode`.
-* Added `transient/` to `.gitignore`.
-* Fallback to `sample/prelude-modules.el` in the absence of a `prelude-modules.el` in one's personal folder.
-* [Ruby] Don't auto-insert coding comments.
-* Hide (via `diminish`) `editorconfig-mode`, `super-save`, `company`, `abbrev` and `ivy` in the modeline.
-* Use `lsp-workspace-restart` function instead of deprecated `lsp-restart-workspace`.
-* Bind all online search commands under `C-c C-/` to avoid a conflict with `counsel-git` or `magit-file-dispatch`.
-* Bound `magit-file-mode` to `C-c g` (it's also bound to `C-c M-g` if you decide to utilize this keybinding for something else.
-* Added `.cache/` and `lsp-session*` to `.gitignore`. These are generated by `lsp`.
+- [#1292](https://github.com/bbatsov/prelude/issues/1292): Add `prelude-python-mode-set-encoding-automatically` defcustom inn `prelude-python.el` module with nil default value.
+- [#1278](https://github.com/bbatsov/prelude/issues/1278): Don't disable `menu-bar-mode` unless `prelude-minimalistic-ui` is enabled.
+- [#1277](https://github.com/bbatsov/prelude/issues/1277): Make it possible to disable the creation of `Super`-based keybindings via `prelude-super-keybindings`.
+- Removed deprecated alias `prelude-ensure-module-deps`.
+- Remove `prelude-fullscreen`, as these days people can use `toggle-frame-fullscreen` instead. (it was introduced in Emacs 24.4)
+- Removed `beacon-mode`.
+- Added `transient/` to `.gitignore`.
+- Fallback to `sample/prelude-modules.el` in the absence of a `prelude-modules.el` in one's personal folder.
+- [Ruby] Don't auto-insert coding comments.
+- Hide (via `diminish`) `editorconfig-mode`, `super-save`, `company`, `abbrev` and `ivy` in the modeline.
+- Use `lsp-workspace-restart` function instead of deprecated `lsp-restart-workspace`.
+- Bind all online search commands under `C-c C-/` to avoid a conflict with `counsel-git` or `magit-file-dispatch`.
+- Bound `magit-file-mode` to `C-c g` (it's also bound to `C-c M-g` if you decide to utilize this keybinding for something else.
+- Added `.cache/` and `lsp-session*` to `.gitignore`. These are generated by `lsp`.
 
 ### Bugs fixed
 
-* [#1302](https://github.com/bbatsov/prelude/issues/1302): `C-a` should be bound to `org-beginning-of-line` in org-mode buffers.
+- [#1302](https://github.com/bbatsov/prelude/issues/1302): `C-a` should be bound to `org-beginning-of-line` in org-mode buffers.
 
 ## 1.0.0 (2020-09-15)
 

CONTRIBUTING.md

@@ -7,23 +7,23 @@ try to follow these guidelines when you do so.
 
 ## Issue reporting
 
-* Check that the [issue has not already been reported][2].
-* Check that the issue has not already been fixed in the latest code
+- Check that the [issue has not already been reported][2].
+- Check that the issue has not already been fixed in the latest code
   (a.k.a. `master`).
-* Be clear, concise and precise in your description of the problem.
-* Open an issue with a descriptive title and a summary in grammatically correct,
+- Be clear, concise and precise in your description of the problem.
+- Open an issue with a descriptive title and a summary in grammatically correct,
   complete sentences.
-* Include any relevant code to the issue summary.
+- Include any relevant code to the issue summary.
 
 ## Pull requests
 
-* Read [how to properly contribute to open source projects on GitHub][3].
-* Use a topic branch to easily amend a pull request later, if necessary.
-* Write [good commit messages][4].
-* Update the [changelog][5].
-* Use the same coding conventions as the rest of the project.
-* Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
-* Open a [pull request][6] that relates to *only* one subject with a clear title
+- Read [how to properly contribute to open source projects on GitHub][3].
+- Use a topic branch to easily amend a pull request later, if necessary.
+- Write [good commit messages][4].
+- Update the [changelog][5].
+- Use the same coding conventions as the rest of the project.
+- Verify your Emacs Lisp code with `checkdoc` (<kbd>C-c ? d</kbd>).
+- Open a [pull request][6] that relates to *only* one subject with a clear title
   and description in grammatically correct, complete sentences.
 
 [1]: https://github.com/bbatsov/prelude/issues

README.md

@@ -23,12 +23,12 @@ You can support the development of Prelude via
 
 ## Features
 
-* Improved UX, that's still in line with Emacs traditions
-* Sane defaults of baseline Emacs functionality
-* Automatic installation of many major programming modes on demand
-* A curated set of 3rd party packages to enhance the base functionality
-* Simple modular architecture
-* Easy customization
+- Improved UX, that's still in line with Emacs traditions
+- Sane defaults of baseline Emacs functionality
+- Automatic installation of many major programming modes on demand
+- A curated set of 3rd party packages to enhance the base functionality
+- Simple modular architecture
+- Easy customization
 
 Check out our [user manual](https://prelude.emacsredux.com) for more information.
 
@@ -40,7 +40,7 @@ can skip the whole manual and just type in your favorite shell the
 following command:
 
 ```shellsession
-$ curl -L https://git.io/epre | sh
+curl -L https://git.io/epre | sh
 ```
 
 You can now power up your Emacs, sit back and enjoy Prelude.
@@ -50,13 +50,13 @@ source repository and the installation directory. To change the
 installation directory:
 
 ```shellsession
-$ export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
+export PRELUDE_INSTALL_DIR="$HOME/.emacs.d" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
 ```
 
 To change the source repository:
 
 ```shellsession
-$ export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
+export PRELUDE_URL="https://github.com/yourname/prelude.git" && curl -L https://github.com/bbatsov/prelude/raw/master/utils/installer.sh | sh
 ```
 
 Note that the installer will back up any existing `.emacs` file or
@@ -74,17 +74,17 @@ If you're using Emacs 29+ there's a simple way to try Prelude (or any other Emac
 Just clone Prelude's repo somewhere and do the following:
 
 ```shellsession
-$ emacs --init-dir ~/path/to/prelude
+emacs --init-dir ~/path/to/prelude
 ```
 
 ## Philosophy
 
 Prelude's philosophy is quite simple:
 
-* simple
-* easy to understand and extend
-* stable
-* a foundation for you to build upon, as opposed to some end-user product
+- simple
+- easy to understand and extend
+- stable
+- a foundation for you to build upon, as opposed to some end-user product
 
 This means that it intentionally doesn't pack all the bells and whistles that it could.
 Prelude aims to enhance the classic Emacs experience without deviating a lot from it - e.g.
@@ -96,11 +96,11 @@ to immediate adopt some shiny new package, that has established tried and true a
 
 In practice this translates to the following:
 
-* Prelude is less opinionated than distros like Spacemacs and Doom Emacs (meaning it's closer to the standard Emacs experience)
-* Prelude installs relatively few additional packages by default
-* Most modules in Prelude are opt-in instead of opt-out (you'll notice the default config enables only a handful of modules)
-* 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)
-* 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.
+- Prelude is less opinionated than distros like Spacemacs and Doom Emacs (meaning it's closer to the standard Emacs experience)
+- Prelude installs relatively few additional packages by default
+- Most modules in Prelude are opt-in instead of opt-out (you'll notice the default config enables only a handful of modules)
+- 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)
+- 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.
 
 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,
 Emacs is nothing but a raw building material for the perfect editing experience.
@@ -137,9 +137,9 @@ and send me a pull request. :-)
 
 Support is available via several channels:
 
-* Prelude's Google Group <emacs-prelude@googlegroups.com>
-* Prelude's Freenode channel (`#prelude-emacs`)
-* [Gitter](https://gitter.im/bbatsov/prelude)
+- Prelude's Google Group <emacs-prelude@googlegroups.com>
+- Prelude's Freenode channel (`#prelude-emacs`)
+- [Gitter](https://gitter.im/bbatsov/prelude)
 
 ## Contributors
 

docs/configuration.md

@@ -62,6 +62,7 @@ Or you can use another theme altogether by adding something in `personal/preload
 ```emacs-lisp
 (setq prelude-theme 'solarized-dark)
 ```
+
 in `personal/preload`.
 
 Finally, if you don't want any theme at all, you can add this to your
@@ -78,10 +79,10 @@ personalization.  There is no single special personal config file --
 any files you create in the `personal/` directory will be loaded in
 lexicographical order.  The overall loading precedence is:
 
-1.  `personal/preload/*`
-2.  `core/`
-3.  `personal/prelude-modules.el` (or deprecated `prelude-modules.el`)
-4.  `personal/*`
+1. `personal/preload/*`
+2. `core/`
+3. `personal/prelude-modules.el` (or deprecated `prelude-modules.el`)
+4. `personal/*`
 
 ### Personalization Example
 
@@ -163,8 +164,8 @@ Currently this only affects automated formatting of Typescript files.
 
 Out-of-the-box Prelude will create two versions of many keybindings in `prelude-mode`:
 
-* One "traditional" version with a prefix like `Control`
-* One "alternative" version with a prefix like `Super`
+- One "traditional" version with a prefix like `Control`
+- One "alternative" version with a prefix like `Super`
 
 The reason for this is that there are generally more options for short keybindings with `Super` - e.g. you can
 have `s-p`, `s-g`, etc. There's, however, a problem lying here as well - some operating systems and

docs/contributing.md

@@ -41,8 +41,8 @@ You can install `MkDocs` locally and use the command `mkdocs serve` to
 see the result of changes you make to the manual locally:
 
 ```sh
-$ cd path/to/prelude/repo
-$ mkdocs serve
+cd path/to/prelude/repo
+mkdocs serve
 ```
 
 If you want to make changes to the manual's page structure you'll have to edit

docs/faq.md

@@ -19,7 +19,7 @@ Given how modular the structure of Prelude is, there's relatively little to be g
     I have a stripped-down version of Prelude for personal use, based on `use-package` [here](https://github.com/bbatsov/emacs.d).
     I guess it might be of interest to some of you.
 
-**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.
+**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.
 
 ## Why does Prelude use MELPA instead of MELPA Stable by default?