summaryrefslogtreecommitdiff
path: root/modes/devdocs/evil-collection-devdocs.el
blob: 25a6094b4bee9488ffa9f272f388b07ac43a0a6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
;;; evil-collection-devdocs.el --- Evil bindings for devdocs -*- lexical-binding: t -*-

;; Copyright (C) 2021 Zhiwei Chen

;; Author: Zhiwei Chen <condy0919@gmail.com>
;; Maintainer: James Nguyen <james@jojojames.com>
;; Pierre Neidhardt <mail@ambrevar.xyz>
;; URL: https://github.com/emacs-evil/evil-collection
;; Version: 0.0.1
;; Package-Requires: ((emacs "25.1"))
;; Keywords: evil, tools

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:
;; Evil bindings for devdocs.

;;; Code:
(require 'evil-collection)
(require 'devdocs nil t)

(defconst evil-collection-devdocs-maps '(devdocs-mode-map))

;;;###autoload
(defun evil-collection-devdocs-setup ()
  "Set up `evil' bindings for `devdocs'."
  (evil-set-initial-state 'devdocs-mode 'normal)
  (evil-collection-set-readonly-bindings 'devdocs-mode-map)

  (evil-collection-define-key 'normal 'devdocs-mode-map
    ;; motion
    (kbd "SPC")         'scroll-up-command
    (kbd "S-SPC")       'scroll-down-command
    (kbd "<tab>")       'forward-button
    (kbd "<backtab>")   'backward-button

    "[[" 'devdocs-previous-page
    "]]" 'devdocs-next-page
    "gk" 'devdocs-previous-page
    "gj" 'devdocs-next-page

    "g." 'devdocs-goto-target

    ;; history
    (kbd "C-p") 'devdocs-go-back
    (kbd "C-n") 'devdocs-go-forward

    ;; copy
    "C" 'devdocs-copy-url

    ;; search
    "s" 'devdocs-lookup))

(provide 'evil-collection-devdocs)
;;; evil-collection-devdocs.el ends here