branch: externals/org-remark
commit 03828f44e4512eec5aa0f1b15ad0a40809744209
Author: Noboru Ota <m...@nobiot.com>
Commit: Noboru Ota <m...@nobiot.com>
docs: README to include use-package setup example
---
README-elpa | 28 ++++++++++++++++++++++++++++
README.org | 26 ++++++++++++++++++++++++++
2 files changed, 54 insertions(+)
diff --git a/README-elpa b/README-elpa
index eca34e0481..9a639b7ec5 100644
--- a/README-elpa
+++ b/README-elpa
@@ -146,6 +146,34 @@ _________________
| (define-key org-remark-mode-map (kbd "C-c n d") #'org-remark-delete))
`----
+ Alternatively, you can use `use-package' to set up Org-remark. The
+ example provided below should be equivalent to the setup described
+ above.
+
+ ,----
+ | (use-package org-remark
+ | :bind (;; :bind keyword also implicitly defers org-remark itself.
+ | ;; Keybindings before :map is set for global-map.
+ | ("C-c n m" . org-remark-mark)
+ | :map org-remark-mode-map
+ | ("C-c n o" . org-remark-open)
+ | ("C-c n ]" . org-remark-view-next)
+ | ("C-c n [" . org-remark-view-prev)
+ | ("C-c n r" . org-remark-remove)
+ | ("C-c n d" . org-remark-delete))
+ | ;; Alternative way to enable `org-remark-global-tracking-mode' in
+ | ;; `after-init-hook'.
+ | ;; :hook (after-init . org-remark-global-tracking-mode)
+ | :init
+ | ;; It is recommended that `org-remark-global-tracking-mode' be
+ | ;; enabled when Emacs initializes. Alternatively, you can put it to
+ | ;; `:after-init-hook' to load it after Emacs has been initialized.
+ | (org-remark-global-tracking-mode +1)
+ | (use-package org-remark-info :after info :config (org-remark-info-mode
+1))
+ | (use-package org-remark-eww :after eww :config (org-remark-eww-mode
+1))
+ | (use-package org-remark-nov :after nov :config (org-remark-nov-mode
+1)))
+ `----
+
[GNU-ELPA] <https://elpa.gnu.org/packages/org-remark.html>
diff --git a/README.org b/README.org
index 7a005d9409..c4d05de3e2 100644
--- a/README.org
+++ b/README.org
@@ -103,6 +103,32 @@ Below are example keybindings you might like to consider:
(define-key org-remark-mode-map (kbd "C-c n d") #'org-remark-delete))
#+end_src
+Alternatively, you can use ~use-package~ to set up Org-remark. The example
provided below should be equivalent to the setup described above.
+
+#+begin_src emacs-lisp
+ (use-package org-remark
+ :bind (;; :bind keyword also implicitly defers org-remark itself.
+ ;; Keybindings before :map is set for global-map.
+ ("C-c n m" . org-remark-mark)
+ :map org-remark-mode-map
+ ("C-c n o" . org-remark-open)
+ ("C-c n ]" . org-remark-view-next)
+ ("C-c n [" . org-remark-view-prev)
+ ("C-c n r" . org-remark-remove)
+ ("C-c n d" . org-remark-delete))
+ ;; Alternative way to enable `org-remark-global-tracking-mode' in
+ ;; `after-init-hook'.
+ ;; :hook (after-init . org-remark-global-tracking-mode)
+ :init
+ ;; It is recommended that `org-remark-global-tracking-mode' be
+ ;; enabled when Emacs initializes. Alternatively, you can put it to
+ ;; `:after-init-hook' to load it after Emacs has been initialized.
+ (org-remark-global-tracking-mode +1)
+ (use-package org-remark-info :after info :config (org-remark-info-mode +1))
+ (use-package org-remark-eww :after eww :config (org-remark-eww-mode +1))
+ (use-package org-remark-nov :after nov :config (org-remark-nov-mode +1)))
+#+end_src
+
* Contributing and Feedback
Create issues, discussion, and/or pull requests in the GitHub repository. All
welcome.
