From 862b6dc253615da2681257aa410d91c2e0359519 Mon Sep 17 00:00:00 2001 From: James Cherti <60946298+jamescherti@users.noreply.github.com> Date: Fri, 5 Sep 2025 08:34:45 -0400 Subject: [PATCH] Update README.md --- README.md | 138 +++++++++++++++++++++++++++--------------------------- 1 file changed, 69 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index bf613a0..28422e5 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The **minimal-emacs.d** project is a lightweight and optimized Emacs base (`init Building the *minimal-emacs.d* `init.el` and `early-init.el` was the result of **extensive research and testing** to fine-tune the best parameters and optimizations for an Emacs configuration. *(More information about the *minimal-emacs.d* features can be found here: [Features](#features).)* -If this enhances your workflow, please show your support by **⭐ starring minimal-emacs.d GitHub** to help more Emacs users discover its benefits. +If this enhances your workflow, please show your support by **⭐ starring minimal-emacs.d on GitHub** to help more Emacs users discover its benefits.

@@ -52,74 +52,74 @@ In addition to *minimal-emacs.d*, startup speed is influenced by your computer's ## Table of Contents - [*minimal-emacs.d* - A Customizable Emacs `init.el` and `early-init.el` that Provides Better Defaults and Faster Startup](#minimal-emacsd---a-customizable-emacs-initel-and-early-initel-that-provides-better-defaults-and-faster-startup) - - [Introduction](#introduction) - - [Looking for the ideal starter kit to customize Emacs? You have found it.](#looking-for-the-ideal-starter-kit-to-customize-emacs-you-have-found-it) - - [Startup](#startup) - - [Install minimal-emacs.d](#install-minimal-emacsd) - - [Install minimal-emacs.d into `~/.emacs.d`](#install-minimal-emacsd-into-emacsd) - - [Alternative: Install minimal-emacs.d into `~/.minimal-emacs.d`](#alternative-install-minimal-emacsd-into-minimal-emacsd) - - [Update minimal-emacs.d](#update-minimal-emacsd) - - [Customizations: Never modify init.el and early-init.el. Modify these instead...](#customizations-never-modify-initel-and-early-initel-modify-these-instead) - - [Debug on error](#debug-on-error) - - [Customizations: UI (pre-early-init.el)](#customizations-ui-pre-early-initel) - - [How to enable the menu-bar, the tool-bar, dialogs, the contextual menu, and tooltips?](#how-to-enable-the-menu-bar-the-tool-bar-dialogs-the-contextual-menu-and-tooltips) - - [Reducing clutter in `~/.emacs.d` by redirecting files to `~/.emacs.d/var/`](#reducing-clutter-in-emacsd-by-redirecting-files-to-emacsdvar) - - [Customizations: Packages (post-init.el)](#customizations-packages-post-initel) - - [Optimization: Native Compilation](#optimization-native-compilation) - - [How to activate recentf, savehist, saveplace, and auto-revert?](#how-to-activate-recentf-savehist-saveplace-and-auto-revert) - - [Activating autosave](#activating-autosave) - - [auto-save-mode (Prevent data loss in case of crashes)](#auto-save-mode-prevent-data-loss-in-case-of-crashes) - - [auto-save-visited-mode (Save file buffers after a few seconds of inactivity)](#auto-save-visited-mode-save-file-buffers-after-a-few-seconds-of-inactivity) - - [Code completion with corfu](#code-completion-with-corfu) - - [Configuring Vertico, Consult, and Embark](#configuring-vertico-consult-and-embark) - - [Code folding](#code-folding) - - [Changing the default theme](#changing-the-default-theme) - - [Automatic removal of trailing whitespace on save](#automatic-removal-of-trailing-whitespace-on-save) - - [Enhancing undo/redo](#enhancing-undoredo) - - [Configuring Vim keybindings using Evil?](#configuring-vim-keybindings-using-evil) - - [Configuring LSP Servers with Eglot (built-in)](#configuring-lsp-servers-with-eglot-built-in) - - [Persisting and Restoring all buffers, windows/split, tab-bar, frames...](#persisting-and-restoring-all-buffers-windowssplit-tab-bar-frames) - - [Configuring org-mode](#configuring-org-mode) - - [Configuring markdown-mode (e.g., README.md syntax)](#configuring-markdown-mode-eg-readmemd-syntax) - - [Tree-sitter Integration (Better Syntax Highlighting)](#tree-sitter-integration-better-syntax-highlighting) - - [Auto upgrade Emacs packages](#auto-upgrade-emacs-packages) - - [Safely terminating unused buffers](#safely-terminating-unused-buffers) - - [Treemacs, a tree layout file explorer (Sidebar file explorer)](#treemacs-a-tree-layout-file-explorer-sidebar-file-explorer) - - [Inhibit the mouse](#inhibit-the-mouse) - - [Spell checker](#spell-checker) - - [Efficient jumps for enhanced productivity](#efficient-jumps-for-enhanced-productivity) - - [Asynchronous code formatting without cursor disruption](#asynchronous-code-formatting-without-cursor-disruption) - - [Efficient template expansion with snippets](#efficient-template-expansion-with-snippets) - - [A better Emacs *help* buffer](#a-better-emacs-help-buffer) - - [Enhancing the Elisp development experience](#enhancing-the-elisp-development-experience) - - [Showing the tab-bar](#showing-the-tab-bar) - - [Changing the Default Font](#changing-the-default-font) - - [Persist Text Scale](#persist-text-scale) - - [Loading the custom.el file](#loading-the-customel-file) - - [Which other customizations can be interesting to add?](#which-other-customizations-can-be-interesting-to-add) - - [Customizations: pre-early-init.el](#customizations-pre-early-initel) - - [Configuring straight.el](#configuring-straightel) - - [Configuring Elpaca (package manager)](#configuring-elpaca-package-manager) - - [Frequently asked questions](#frequently-asked-questions) - - [Customizing Scroll Recentering](#customizing-scroll-recentering) - - [How to display Emacs startup duration?](#how-to-display-emacs-startup-duration) - - [How to get the latest version of all packages? (unstable)](#how-to-get-the-latest-version-of-all-packages-unstable) - - [How to use MELPA stable?](#how-to-use-melpa-stable) - - [How to load a local lisp file for machine-specific configurations?](#how-to-load-a-local-lisp-file-for-machine-specific-configurations) - - [How to load Emacs customizations?](#how-to-load-emacs-customizations) - - [How to increase gc-cons-threshold?](#how-to-increase-gc-cons-threshold) - - [How to prevent Emacs from loading .dir-locals.el files?](#how-to-prevent-emacs-from-loading-dir-localsel-files) - - [How to make minimal-emacs.d use an environment variable to change ~/.emacs.d to another directory?](#how-to-make-minimal-emacsd-use-an-environment-variable-to-change-emacsd-to-another-directory) - - [Are post-early-init.el and pre-init.el the same file in terms of the logic?](#are-post-early-initel-and-pre-initel-the-same-file-in-terms-of-the-logic) - - [Why is the menu bar disabled by default?](#why-is-the-menu-bar-disabled-by-default) - - [Why did the author develop minimal-emacs.d?](#why-did-the-author-develop-minimal-emacsd) - - [How to keep minimal-emacs.d pre-\*.el and post-\*.el files in a separate directory?](#how-to-keep-minimal-emacsd-pre-el-and-post-el-files-in-a-separate-directory) - - [How to make *minimal-emacs.d* install packages in the early-init phase instead of the init phase?](#how-to-make-minimal-emacsd-install-packages-in-the-early-init-phase-instead-of-the-init-phase) - - [Testimonials from users](#testimonials-from-users) - - [Minimal-emacs.d configurations from users](#minimal-emacsd-configurations-from-users) - - [Features](#features) - - [Author and license](#author-and-license) - - [Links](#links) + - [Introduction](#introduction) + - [Looking for the ideal starter kit to customize Emacs? You have found it.](#looking-for-the-ideal-starter-kit-to-customize-emacs-you-have-found-it) + - [Startup](#startup) + - [Install minimal-emacs.d](#install-minimal-emacsd) + - [Install minimal-emacs.d into `~/.emacs.d`](#install-minimal-emacsd-into-emacsd) + - [Alternative: Install minimal-emacs.d into `~/.minimal-emacs.d`](#alternative-install-minimal-emacsd-into-minimal-emacsd) + - [Update minimal-emacs.d](#update-minimal-emacsd) + - [Customizations: Never modify init.el and early-init.el. Modify these instead...](#customizations-never-modify-initel-and-early-initel-modify-these-instead) + - [Debug on error](#debug-on-error) + - [Customizations: UI (pre-early-init.el)](#customizations-ui-pre-early-initel) + - [How to enable the menu-bar, the tool-bar, dialogs, the contextual menu, and tooltips?](#how-to-enable-the-menu-bar-the-tool-bar-dialogs-the-contextual-menu-and-tooltips) + - [Reducing clutter in `~/.emacs.d` by redirecting files to `~/.emacs.d/var/`](#reducing-clutter-in-emacsd-by-redirecting-files-to-emacsdvar) + - [Customizations: Packages (post-init.el)](#customizations-packages-post-initel) + - [Optimization: Native Compilation](#optimization-native-compilation) + - [How to activate recentf, savehist, saveplace, and auto-revert?](#how-to-activate-recentf-savehist-saveplace-and-auto-revert) + - [Activating autosave](#activating-autosave) + - [auto-save-mode (Prevent data loss in case of crashes)](#auto-save-mode-prevent-data-loss-in-case-of-crashes) + - [auto-save-visited-mode (Save file buffers after a few seconds of inactivity)](#auto-save-visited-mode-save-file-buffers-after-a-few-seconds-of-inactivity) + - [Code completion with corfu](#code-completion-with-corfu) + - [Configuring Vertico, Consult, and Embark](#configuring-vertico-consult-and-embark) + - [Code folding](#code-folding) + - [Changing the default theme](#changing-the-default-theme) + - [Automatic removal of trailing whitespace on save](#automatic-removal-of-trailing-whitespace-on-save) + - [Enhancing undo/redo](#enhancing-undoredo) + - [Configuring Vim keybindings using Evil?](#configuring-vim-keybindings-using-evil) + - [Configuring LSP Servers with Eglot (built-in)](#configuring-lsp-servers-with-eglot-built-in) + - [Persisting and Restoring all buffers, windows/split, tab-bar, frames...](#persisting-and-restoring-all-buffers-windowssplit-tab-bar-frames) + - [Configuring org-mode](#configuring-org-mode) + - [Configuring markdown-mode (e.g., README.md syntax)](#configuring-markdown-mode-eg-readmemd-syntax) + - [Tree-sitter Integration (Better Syntax Highlighting)](#tree-sitter-integration-better-syntax-highlighting) + - [Auto upgrade Emacs packages](#auto-upgrade-emacs-packages) + - [Safely terminating unused buffers](#safely-terminating-unused-buffers) + - [Treemacs, a tree layout file explorer (Sidebar file explorer)](#treemacs-a-tree-layout-file-explorer-sidebar-file-explorer) + - [Inhibit the mouse](#inhibit-the-mouse) + - [Spell checker](#spell-checker) + - [Efficient jumps for enhanced productivity](#efficient-jumps-for-enhanced-productivity) + - [Asynchronous code formatting without cursor disruption](#asynchronous-code-formatting-without-cursor-disruption) + - [Efficient template expansion with snippets](#efficient-template-expansion-with-snippets) + - [A better Emacs *help* buffer](#a-better-emacs-help-buffer) + - [Enhancing the Elisp development experience](#enhancing-the-elisp-development-experience) + - [Showing the tab-bar](#showing-the-tab-bar) + - [Changing the Default Font](#changing-the-default-font) + - [Persist Text Scale](#persist-text-scale) + - [Loading the custom.el file](#loading-the-customel-file) + - [Which other customizations can be interesting to add?](#which-other-customizations-can-be-interesting-to-add) + - [Customizations: pre-early-init.el](#customizations-pre-early-initel) + - [Configuring straight.el](#configuring-straightel) + - [Configuring Elpaca (package manager)](#configuring-elpaca-package-manager) + - [Frequently asked questions](#frequently-asked-questions) + - [Customizing Scroll Recentering](#customizing-scroll-recentering) + - [How to display Emacs startup duration?](#how-to-display-emacs-startup-duration) + - [How to get the latest version of all packages? (unstable)](#how-to-get-the-latest-version-of-all-packages-unstable) + - [How to use MELPA stable?](#how-to-use-melpa-stable) + - [How to load a local lisp file for machine-specific configurations?](#how-to-load-a-local-lisp-file-for-machine-specific-configurations) + - [How to load Emacs customizations?](#how-to-load-emacs-customizations) + - [How to increase gc-cons-threshold?](#how-to-increase-gc-cons-threshold) + - [How to prevent Emacs from loading .dir-locals.el files?](#how-to-prevent-emacs-from-loading-dir-localsel-files) + - [How to make minimal-emacs.d use an environment variable to change ~/.emacs.d to another directory?](#how-to-make-minimal-emacsd-use-an-environment-variable-to-change-emacsd-to-another-directory) + - [Are post-early-init.el and pre-init.el the same file in terms of the logic?](#are-post-early-initel-and-pre-initel-the-same-file-in-terms-of-the-logic) + - [Why is the menu bar disabled by default?](#why-is-the-menu-bar-disabled-by-default) + - [Why did the author develop minimal-emacs.d?](#why-did-the-author-develop-minimal-emacsd) + - [How to keep minimal-emacs.d pre-\*.el and post-\*.el files in a separate directory?](#how-to-keep-minimal-emacsd-pre-el-and-post-el-files-in-a-separate-directory) + - [How to make *minimal-emacs.d* install packages in the early-init phase instead of the init phase?](#how-to-make-minimal-emacsd-install-packages-in-the-early-init-phase-instead-of-the-init-phase) + - [Testimonials from users](#testimonials-from-users) + - [Minimal-emacs.d configurations from users](#minimal-emacsd-configurations-from-users) + - [Features](#features) + - [Author and license](#author-and-license) + - [Links](#links)