From df65c8fe2dadd7dabbfe2845cba179472cc6b97f Mon Sep 17 00:00:00 2001 From: Craig Jennings Date: Sat, 18 Oct 2025 11:34:57 -0500 Subject: doc: keybindings: better keybindings text --- modules/keybindings.el | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) (limited to 'modules') diff --git a/modules/keybindings.el b/modules/keybindings.el index 438f5b82..491c102c 100644 --- a/modules/keybindings.el +++ b/modules/keybindings.el @@ -1,17 +1,24 @@ ;;; keybindings --- General Keyboard Shortcuts -*- lexical-binding: t; coding: utf-8; -*- ;; author: Craig Jennings - +;; ;;; Commentary: - -;; Commonly used files should be easy to jump to. The "jump-to" keymap has the -;; "C-c j" prefix and immediately opens files defined in user-constants.el. - -;; "Hostile Keybindings" are those that are close to keybindings I use commonly -;; so they're easy to hit by accident, but they have painful results. I'd -;; rather avoid the pain by unsetting they keybindings and view the error ' -;; is undefined' message. Finally, I'm providing messages to train me to use -;; faster keybindings and provide feedback when evaluating buffers. - +;; +;; Global keybinding configuration and custom keymap framework. +;; +;; Main features include: +;; - custom keymap prefix (~C-;~) for all custom commands, +;; - jump-to-file commands (~C-c j ~) for frequently used files +;; - which-key integration for keybinding discovery +;; - free-keys for finding available keybindings +;; - hostile keybinding protection that disables accidental suspend-frame and other dangerous operations +;; - training to encourage faster keybindings +;; +;; Key principles: +;; - avoid keybindings close to commonly-used keys that have painful results +;; - use global-map for truly global bindings +;; - use custom-keymap (~C-;~) for custom functionality +;; - keep ~C-c ~ reserved for user bindings per Emacs conventions +;; ;;; Code: ;; Loaded earlier in init.el -- cgit v1.2.3