https://github.com/ahungry/md4rd
Emacs Mode for Reddit - Read Reddit from within Emacs interactively.
https://github.com/ahungry/md4rd
Last synced: 6 days ago
JSON representation
Emacs Mode for Reddit - Read Reddit from within Emacs interactively.
- Host: GitHub
- URL: https://github.com/ahungry/md4rd
- Owner: ahungry
- License: gpl-3.0
- Created: 2018-01-19T05:50:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-07-25T23:15:38.000Z (over 1 year ago)
- Last Synced: 2024-08-02T16:44:51.309Z (9 months ago)
- Language: Emacs Lisp
- Homepage:
- Size: 1.6 MB
- Stars: 210
- Watchers: 11
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- my-awesome-github-stars - ahungry/md4rd - Emacs Mode for Reddit - Read Reddit from within Emacs interactively. (Emacs Lisp)
- awesome-starred - md4rd - Emacs Mode for Reddit - Read Reddit from within Emacs interactively. (Emacs Lisp)
README
# md4rd - Mode for Reddit
[](http://melpa.org/#/md4rd)
Read Reddit interactively from within Emacs.
[CHANGELOG.md](CHANGELOG.md "CHANGELOG.md")
# Why the odd name?
See the Reddit TOS/API guide - anything named after that trademark
(reddit) *must* be prefixed with a 'for', so 'mode for reddit' is
fine, however 'reddit mode' is not.
Hopefully you can help your friends find this package as their reddit
need's dictate :)
https://www.reddit.com/wiki/api
# Installation
Clone the repo, then in your Emacs init file:
```lisp
(add-to-list 'load-path "/path/to/repo")
(require 'md4rd)
(md4rd) ;; to launch it
```
## Signing in / authenticated features
### UPDATE 2023-06-03
Reddit is planning to charge API authors for access - I'm not
altruistic enough to pay for all of you to have login features
(upvote/downvote) when this is primarily a reader mode, which doesn't
require login.
You can still use login features, but will require setting up your own
API account with Reddit and configuring OAUTH2 (many guides for this,
I won't detail here).
Essentially, you'll need to set these variables correctly in your
Emacs configs:
```lisp
(defvar md4rd--oauth-client-id "abc123"
"The client ID that links this up to the reddit.com OAuth endpoint.")
(defvar md4rd--oauth-redirect-uri
"http://localhost:12345" ; Or some world facing domain you use for this
"The Oauth2 redirect_uri that links this up to the reddit.com OAuth endpoint.")
```
OAuth integration was just finished, and you can invoke the sign in
with:
```
M-x md4rd-login
```
This will pop up a permission grant page on reddit.com, which will
forward you to my site (reddit requires this redirection and it is easier than
running a localhost:port setup for each Emacs user who may or may not
have the port open, as it must match one single redirect_uri on the
app level config being used for OAuth).
After you see the code, simply paste it into your Emacs' minibuffer
prompt, which will have been waiting for you to finish the process.
It will then fetch your oauth access token and refresh tokens.
Bring on the upvotes!
# Usage
If you're signed in, you can highlight a post in the \*subreddit\*
buffer and upvote or downvote as you like.
# Keys
```lisp
(define-key map (kbd "u") 'tree-mode-goto-parent)
(define-key map (kbd "o") 'md4rd-open)
(define-key map (kbd "v") 'md4rd-visit)
(define-key map (kbd "e") 'tree-mode-toggle-expand)
(define-key map (kbd "E") 'md4rd-widget-expand-all)
(define-key map (kbd "C") 'md4rd-widget-collapse-all)
(define-key map (kbd "n") 'widget-forward)
(define-key map (kbd "j") 'widget-forward)
(define-key map (kbd "h") 'backward-button)
(define-key map (kbd "p") 'widget-backward)
(define-key map (kbd "k") 'widget-backward)
(define-key map (kbd "l") 'forward-button)
(define-key map (kbd "q") 'kill-current-buffer)
(define-key map (kbd "r") 'md4rd-reply)
(define-key map (kbd "u") 'md4rd-upvote)
(define-key map (kbd "d") 'md4rd-downvote)
(define-key map (kbd "t") 'md4rd-widget-toggle-line)
```
# Customization
## Setting your default reddits
You can subscribe to different reddits by customizing your
rm::subreddits-active variable.
```
(setq md4rd-subs-active '(lisp+Common_Lisp emacs prolog))
```
(A cool feature of reddit is you can view multiple reddits combined with
the `+` concatenation).
## Re-authenticating your session on sign in and every hour
Add something like this into your config (sample using use-package):
```
(use-package md4rd :ensure t
:config
(add-hook 'md4rd-mode-hook 'md4rd-indent-all-the-lines)
(setq md4rd-subs-active '(emacs lisp+Common_Lisp prolog clojure))
(setq md4rd--oauth-access-token
"your-access-token-here")
(setq md4rd--oauth-refresh-token
"your-refresh-token-here")
(run-with-timer 0 3540 'md4rd-refresh-login))
```
## Hooks
If you hate the really wide text / no default indent, try this new
function + hook combo.
```
(add-hook 'md4rd-mode-hook 'md4rd-indent-all-the-lines)
```
# Screenshots
See the following (shown in `emacs -nw` mode):
Note - this first one is with the indent-all-the-lines hook enabled:
# License
GPLv3
# Copyright
Matthew Carter