Provide an example `use-package’ declaration.
authorJoe Wreschnig <joe.wreschnig@gmail.com>
Fri, 18 Aug 2017 20:52:36 +0000 (22:52 +0200)
committerJoe Wreschnig <joe.wreschnig@gmail.com>
Fri, 18 Aug 2017 20:52:36 +0000 (22:52 +0200)
README.md
pelican-mode.el

index e29499dc234944af92bcee2273bb4df3be97325d..8bbca6af6e6578e93f87b155608275e6fd72e22d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -18,8 +18,19 @@ AsciiDoc, and Org. It also assumes you've set up Pelican with
 
 To enable by default on all text files in a Pelican site:
 
-    (require 'pelican-mode)
-    (pelican-global-mode)
+``` emacs-lisp
+(require 'pelican-mode)
+(pelican-global-mode)
+```
+
+Or with `use-package` and deferred loading:
+
+``` emacs-lisp
+(use-package pelican-mode
+  :after (:any org rst markdown-mode adoc-mode)
+  :config
+  (pelican-global-mode))
+```
 
 Or, register `pelican-mode` or `pelican-mode-enable-if-site`
 as hook functions for more direct control.
index 881da69d38173c07f2eb98d5d2c292669b34a1f8..1b608bea1bd1e13423175d13812f940f3d812122 100644 (file)
 ;;     (require 'pelican-mode)
 ;;     (pelican-global-mode)
 ;;
+;; Or with ``use-package'' and deferred loading:
+;;
+;;     (use-package pelican-mode
+;;       :after (:any org rst markdown-mode adoc-mode)
+;;       :config
+;;       (pelican-global-mode))
+;;
 ;; Or, register `pelican-mode' or `pelican-mode-enable-if-site'
 ;; as hook functions for more direct control.