From ce12adbfee0287cc1de13671ea8ae47903bb1eb3 Mon Sep 17 00:00:00 2001 From: Jonathan Jin Date: Sun, 22 Sep 2024 11:03:03 -0400 Subject: [PATCH] docs: explain lazy-loading Closes #235. --- docs/index.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/index.md b/docs/index.md index 7a104d6..4021e58 100644 --- a/docs/index.md +++ b/docs/index.md @@ -70,6 +70,19 @@ with Kele. (bind-key (kbd "s-k") kele-command-map kele-mode-map)) ``` +By default this will load the package eagerly. This can be useful if you would +like [modeline integration](./how-tos/integrations.md) to be always present. If, +instead, you'd like to lazily load the package, try the following, which will +only load the package when you invoke the prefix keybinding: + +```emacs-lisp +(use-package kele + :config + (kele-mode 1) + :bind-keymap + ("s-k" . kele-command-map)) +``` + ## About the Name The name Kele comes from the Mandarin term for cola, 可乐 (*kě lè*). It is