blob: 9fec35bf9afb610ef85e54911f6bcb320b7f3093 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
#+Title: SX -- Stack Exchange for Emacs
[[https://travis-ci.org/vermiculus/sx.el][https://travis-ci.org/vermiculus/sx.el.svg?branch=master]]
[[http://melpa.org/#/sx][file:http://melpa.org/packages/sx-badge.svg]]
[[http://stable.melpa.org/#/sx][file:http://stable.melpa.org/packages/sx-badge.svg]]
[[https://gitter.im/vermiculus/sx.el?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge][https://badges.gitter.im/Join Chat.svg]]
[[https://www.waffle.io/vermiculus/sx.el][https://badge.waffle.io/vermiculus/sx.el.svg]]
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.
[[file:list-and-question.png]]
* Features
** Viewing Questions
View questions with one of the ~sx-tab-~ commands. These translate to the
different 'tabs' that you can view on the official site. Implemented tabs
include:
- ~sx-tab-all-questions~ :: All questions.
- ~sx-tab-unanswered~ :: Unanswered questions.
- ~sx-tab-unanswered-my-tags~ :: Unanswered questions in your followed tags.
- ~sx-tab-featured~ :: Featured questions.
- ~sx-tab-starred~ :: Your starred questions.
Each of these opens up a list of questions, and you can further customize the
ordering of the list with =O=. Other keys include:
- =s s= :: Switch site.
- =n= and =p= :: Navigate the list.
- =j= and =k= :: Navigate while viewing the question in a separate buffer.
- =v= :: Visit the thing-at-point in your browser
- =w= :: Copy the thing-at-point (usually a link).
- =u= and =d= :: Upvote and downvote.
- =RET= :: Open the question buffer.
As always, =C-h m= is the definitive resource for the functions of this mode.
* Installation
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
#+BEGIN_SRC text
M-x package-install RET sx RET=
#+END_SRC
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.
* Contributing
Please help contribute! Doing any of the following will help us immensely:
- [[https://github.com/vermiculus/sx.el/issues/new][Open an issue]]
- [[https://github.com/vermiculus/sx.el/pulls][Submit a pull request]]
- [[https://gitter.im/vermiculus/sx.el][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 [[http://www.waffle.io/vermiculus/sx.el][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=.
* Resources
- [[http://www.gnu.org/software/emacs/][GNU Emacs]]
- [[https://api.stackexchange.com/docs][Stack Exchange API v2.2]]
** Icons
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.
- [[file:resources/emacs.svg][Emacs icon]]
- [[file:resources/stackexchange.svg][Stack Exchange icon]]
* COMMENT Local Variables
# Local Variables:
# fill-column: 80
# End:
|
