Skip to content
Instant Github-flavored Markdown/Org preview using grip
Emacs Lisp
Branch: master
Clone or download
Latest commit eb574c8 Sep 9, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
LICENSE
README.md
grip-mode.el

README.md

grip-mode

MELPA MELPA Stable License

Table of Contents

Instant Github-flavored Markdown/Org preview using grip (Github README Instant Preview).

Prerequisite

Install

Manual

From melpa, M-x package-install RET grip-mode RET.

;; Make a keybinding: `C-c C-c g'
(define-key markdown-mode-command-map (kbd "g") #'grip-mode)

;; Or start grip when opening a markdown/org buffer
(add-hook 'markdown-mode-hook #'grip-mode)
(add-hook 'org-mode-hook #'grip-mode)

Use-package

;; Use keybindings
(use-package grip-mode
  :ensure t
  :bind (:map markdown-mode-command-map
         ("g" . grip-mode)))

;; Or using hooks
(use-package grip-mode
  :ensure t
  :hook ((markdown-mode org-mode) . grip-mode))

Run M-x grip-mode to preview the markdown and org buffer with the default browser.

Enjoy! 😄

Customize

Run M-x customize-group RET grip RET or set the variables.

;; Path to the grip binary
(setq grip-binary-path "/path/to/grip")

;; A GitHub username for API authentication
(setq grip-github-user "")

;; A GitHub password or auth token for API auth
(setq grip-github-password "")

Screenshots

grip-mode

FAQ

  1. How to resolve the issue: "GitHub Rate Limit Reached"?

    You need to set your GitHub username to grip-github-user, then Creating a personal access token for the command line and set the new token to grip-github-password.

You can’t perform that action at this time.