This is a fork of https://github.com/vermiculus/sx.el until all my pull requests
to that project are merged, so that others may benefit early from those pull
requests. The version here fixes the display of stackexchange notifications
(C-u s i
by default), prettifies the display of all inboxes (s i
), and for
inbox links that are not yet supported by either the stackexchange API or by
sx.el
, allows the user to open those links in their emacs-default browser
(press RETURN while on an inbox item).
SX is a full-featured Stack Exchange mode for GNU Emacs 24+. Using the official API, it provides a versatile experience for the Stack Exchange network within Emacs itself.
As always, C-h m
is the definitive resource for functionality, but here are a
few highlights:
View questions with one of the sx-tab-
commands. These translate roughly to
the different ‘tabs’ that you can view on the official site. Implemented tabs
include:
sx-tab-all-questions
- All questions.
sx-tab-unanswered
u
Unanswered questions.sx-tab-unanswered-my-tags
U
Unanswered questions in your followed tags.sx-tab-featured
f
Featured questions.sx-tab-starred
*
Your starred questions.sx-tab-frontpage
h
The frontpage of the site.sx-tab-meta-or-main
m
Toggle between the meta and main sites.sx-tab-newest
n
Newest questions first.sx-tab-topvoted
v
Highest-scoring questions first.sx-tab-week
w
Hot questions of the week.
Inside SX buffers, you can switch to other tabs by typing s
followed by the key
listed with the tab above. You can also use sx-tab-switch
(s t
) to switch
between tabs with completion. Each of these opens up a list of questions, and
you can further customize the ordering of the list with O
. Other keys
include:
n
andp
- Navigate the list.
j
andk
- Navigate while viewing the question in a separate buffer.
s s
- Switch site.
v
- Visit the
thing-at-point
in your browser. w
- Copy the
thing-at-point
(usually a link). u
andd
- Upvote and downvote.
RET
- Open the question buffer.
u
andd
- Upvote and downvote the question, answer, or comment at point.
a
- Add an answer.
e
- Edit the question or answer (or comment if it’s yours; the usual rules apply)
*
- Star the question.
K
- Delete the question/answer/comment if you are able.
w
- Copy code at point.
sx-inbox
- View your inbox
RET
- Visit inbox item
SX is now available on MELPA! Both the stable release and the development version can be found there. Install it via the Package Menu or just run
M-x package-install RET sx RET=
If you are going to be doing any
asking/answering/commenting/upvoting/downvoting/ etc., you must use
sx-authenticate
to provide SX with an authentication token to act on your
behalf.
After authentication, you will be redirected to the project page. This page will prominently display your authentication token. Keep this secret! It’s as good as your password as far as StackExchange is concerned. Copy and paste the token into the prompt in Emacs.
SX will store this authentication token in plain text in the
sx
folder of your.emacs.d
. Please take any and all steps necessary to protect the security of your account. This token is as good as a password.
(require 'use-package)
(use-package sx
:config
(bind-keys :prefix "C-c s"
:prefix-map my-sx-map
:prefix-docstring "Global keymap for SX."
("q" . sx-tab-all-questions)
("i" . sx-inbox)
("o" . sx-open-link)
("u" . sx-tab-unanswered-my-tags)
("a" . sx-ask)
("s" . sx-search)))
Shamelessly stolen from Endless Parentheses.
(define-prefix-command 'launcher-map)
(global-set-key (kbd "s-l") 'launcher-map)
(define-key launcher-map "qq" #'sx-tab-all-questions)
(define-key launcher-map "qi" #'sx-inbox)
(define-key launcher-map "qo" #'sx-open-link)
(define-key launcher-map "qu" #'sx-tab-unanswered-my-tags)
(define-key launcher-map "qa" #'sx-ask)
(define-key launcher-map "qs" #'sx-search)
Please help contribute! Doing any of the following will help us immensely:
- Open an issue
- Submit a pull request
- Suggest a package or library in our Chat on Gitter (or just hang out
:)
) - Spread the word!
For a better view of all of the open issues, take a look at our lovely Waffle
board. Feel free to take the torch on anything in backlog
or ready
. If you
have thoughts on any other issues, don’t hesitate to chime in!
See also CONTRIBUTING.org
.
SX has no explicit need for an icon, although standard SVG files
have been gathered in resources/
if anyone would fancy a crack at
it.