Skip to content

Commit d110017

Browse files
CsBigDataHubseagle0128
authored andcommitted
Update README.md - add mdopen support
1 parent c6aa895 commit d110017

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,16 @@
2323
<!-- markdown-toc end -->
2424

2525
Instant Github-flavored Markdown/Org preview using [Grip](https://github.com/joeyespo/grip)
26-
(GitHub Readme Instant Preview).
26+
(GitHub Readme Instant Preview) or [mdopen](https://github.com/immanelg/mdopen).
2727

2828
## Prerequisite
2929

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

33+
### Alternative markdown preview without accessing GitHub API
34+
- [mdopen](https://github.com/immanelg/mdopen): `cargo install mdopen`
35+
3336
## Install
3437

3538
### Manual
@@ -51,12 +54,14 @@ From melpa, `M-x package-install RET grip-mode RET`.
5154
;; Use keybindings
5255
(use-package grip-mode
5356
:ensure t
57+
:config (setq grip-use-mdopen t) ;; to use `mdopen` instead of `grip`
5458
:bind (:map markdown-mode-command-map
5559
("g" . grip-mode)))
5660
5761
;; Or using hooks
5862
(use-package grip-mode
5963
:ensure t
64+
:config (setq grip-use-mdopen t) ;; to use `mdopen` instead of `grip`
6065
:hook ((markdown-mode org-mode) . grip-mode))
6166
```
6267

0 commit comments

Comments
 (0)