Skip to content

Commit

Permalink
docs: explain lazy-loading
Browse files Browse the repository at this point in the history
Closes #235.
  • Loading branch information
jinnovation committed Sep 22, 2024
1 parent 2460094 commit ce12adb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ce12adb

Please sign in to comment.