grip-mode

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #golang #go #rust #macos #java #kubernetes #security #ios #openai #open-source

(★ 316)

Instant Github-flavored Markdown/Org preview using grip

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
.gitignore
Cask
grip-mode.el
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# grip-mode

[![CI](https://github.com/seagle0128/grip-mode/actions/workflows/ci.yml/badge.svg)](https://github.com/seagle0128/grip-mode/actions/workflows/ci.yml)
[![Release Tag](https://img.shields.io/github/tag/seagle0128/grip-mode.svg?label=releases)](https://github.com/seagle0128/grip-mode/releases)
[![License](http://img.shields.io/:License-GPL3-blue.svg)](https://raw.githubusercontent.com/seagle0128/grip-mode/master/License)
[![MELPA](https://melpa.org/packages/grip-mode-badge.svg)](https://melpa.org/#/grip-mode)
[![MELPA Stable](https://stable.melpa.org/packages/grip-mode-badge.svg)](https://stable.melpa.org/#/grip-mode)

## Table of Contents

- [Prerequisite](#prerequisite)
- [Install](#install)
  - [Manual](#manual)
  - [Use-package](#use-package)
- [Customize](#customize)
- [Screenshots](#screenshots)
- [Limitations](#limitations)
- [FAQ](#faq)
- [Donate](#donate)

Instant Github-flavored Markdown/Org preview using [Grip](https://github.com/joeyespo/grip)
(GitHub Readme Instant Preview), [mdopen](https://github.com/immanelg/mdopen) or [go-grip](https://github.com/chrishrb/go-grip).

## Prerequisite

### Grip
- [Python](https://www.python.org/)
- [Grip](https://github.com/joeyespo/grip): `pip install grip`

### Alternative markdown preview without accessing GitHub API
- [mdopen](https://github.com/immanelg/mdopen) (`>=0.6.0` for `grip-theme` support): `cargo install mdopen`
- [go-grip](https://github.com/chrishrb/go-grip): `go install github.com/chrishrb/go-grip@latest`

## Install

### Manual

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

```emacs-lisp
;; 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

```emacs-lisp
;; Use keybindings
(use-package grip-mode
  :ensure t
  :config (setq grip-command 'auto) ;; auto, grip, go-grip or mdopen
  :bind (:map markdown-mode-command-map
         ("g" . grip-mode)))

;; Or using hooks
(use-package grip-mode
  :ensure t
  :config (setq grip-command 'go-grip) ;; auto, grip, go-grip or mdopen
  :hook ((markdown-mode org-mode) . grip-mode))
```

⚠️ NOTE: `mdopen` and `go-grips` locally, does not use the github API, and supports emacs webkit preview. ⚠️

Run `M-x grip-mode` to preview the markdown and org buffers in the embedded
webkit browser if Emacs supports (built with `--with-xwidgets`), or in the
default browser (Chrome, Firefox, etc.).

[ox-gfm](https://github.com/larstvei/ox-gfm) is optional, but it brings better
rendering for org files.

Enjoy! :smile:

## Customize

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

```emacs-lisp
;; Command: auto, grip, go-grip or mdopen
(setq grip-command 'auto)

;; Use embedded webkit to preview
;; This requires GNU/Emacs version >= 26 and built with the `--with-xwidgets` option.
;; mdopen doesn't support webkit preview.
(setq grip-preview-in-webkit t)

;; You can use this variable to define another browser
;; to use when loading previews. By default this value is `nil`
;; meaning use default browser defined by your system.
;; It respects `grip-preview-in-webkit'.
(setq grip-url-browser "custom_browser")

;; If you want to pass arguements to your custom browser then use
(setq grip-url-args '("arg1" "arg2" "etc"))

;; A base URL to another GitHub API.
;; Only available for `grip'.
(setq grip-github-api-url "")

;; A GitHub username for API authentication
;; Only available for `grip'.
(setq grip-github-user "")

;; A GitHub password or auth token for API auth
;; Only available for `grip'.
(setq grip-github-password "")

;; Preview hostname
;; Only available for `grip'.
(setq grip-preview-host "localhost")

;; Sleep seconds to ensure the server starts
(setq grip-sleep-time 2)

;; Set to allow real-time refresh
(setq grip-real-time-refresh t)
```

If you don't set them you may have limitation to access Github APIs. Please
visit [Grip Access](https://github.com/joeyespo/grip#access) for details.

You can get the user name and password from `~/.authinfo` like this.

```emacs-lisp
(require 'auth-source)
(let ((credential (auth-source-user-and-password "api.github.com")))
  (setq grip-github-user (car credential)
        grip-github-password (cadr credential)))
```

## Screenshots

![default_browser](https://user-images.githubusercontent.com/140797/62999172-28333480-bea0-11e9-86a3-10ef1be54c16.png "Preview in browser")

![xwidget_webkit](https://user-images.githubusercontent.com/140797/72371426-52369e80-373f-11ea-920a-5b6154852c57.png "Preview in embedded webkit")

## Limitations

- Need to save to preview org buffers due to the performance trade-off.

## 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](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
   and set the new token to `grip-github-password`.

## Donate

If you think the it's helpful for you, please consider paying a cup of coffee
for me. Thank you! :smile:

grip-mode

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

grip-mode

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README