Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dyng/commentreader
Read novel, weibo, twitter in vim as Comment
https://github.com/dyng/commentreader
Last synced: about 2 months ago
JSON representation
Read novel, weibo, twitter in vim as Comment
- Host: GitHub
- URL: https://github.com/dyng/commentreader
- Owner: dyng
- Created: 2012-08-31T12:48:54.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2013-09-04T05:56:57.000Z (over 11 years ago)
- Last Synced: 2024-04-22T05:10:08.659Z (8 months ago)
- Language: Python
- Size: 730 KB
- Stars: 12
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
CommentReader
=============
Read your favorite content (twitter, weibo, digital novel, etc.) at work by pretending you are reading source code. :P
Requirements
============
- Vim 7.3+
- Python support for Vim
Installation
=============
It can be easily installed by just dropping all files to your `$HOME/.vim/` directory.
However I recommend using [vundle](https://github.com/gmarik/vundle/) or [pathogen](https://github.com/tpope/vim-pathogen/) instead as managing your vim plugins.
Usage and Configuration
=============
Twitter
-------------
1. Open a source file and run
:CRopentwitter
2. If it is the first time you run the command, it will guide you to authorize it. Open the url stored in `+` register in your browser. If you are using gVim, you can paste it by `Ctrl + V`(Windows) or `Commands + V`(Mac) as usual.
3. It should be the twitter authorization page containing a PIN code. Copy it and run
:CRopentwitter
4. If everything goes right, the tweets should appear as comments now!
Weibo
-------------
1. Open a source file and run
:CRopenweibo
2. It will require your authorization at the first time you run it. Open the url in `+` register the same as above.
3. Copy the last part of redirected url. For example, `17e80a3d4fe458da96f8561ab21d32fe` for redirected url as `https://api.weibo.com/oauth2/default.html?code=17e80a3d4fe458da96f8561ab21d32fe`.
4. run
:CRopenweibo
and enjoy!
Novel
-------------
1. Open a source file and run
:CRopenbook
2. If you haven't opened a book ever, it will require you to give the path to the command as argument. Like
:CRopenbook
3. Up to now, CommentReader can read plain text file in *UTF-8* encoding *only*.
Maps
-------------
- l: next page
- h: previous page
- j: next item
- k: previous item
- r: refresh (for twitter and weibo)
- q: quit
There is also a useful command `CRtoggle` you can map to the key as you like, `` for example.
:nnoremap :CRtoggle
Session
-------------
By default, CommentReader will save your profile about API key, novel's file path in `$HOME/.vim_creader_session`. With the profile file, you can run `:CRopentwitter`, `:CRopenweibo`, `:CRopenbook` without argument for easy.
If you want, the profile auto-save can be turned off by adding
let g:creader_auto_save = 0
in your `.vimrc`.
Or, maybe you don't want to turn it off but just to save the profile in another position, you can. Add
let g:creader_session_file = path/to/you/want
in your `.vimrc`.
Commands
-------------
- CRopenbook
- CRopenweibo
- CRopentwitter
- CRtoggle
- CRrefresh
- CRshow
- CRhide
- CRclose
- CRforward
- CRbackward
- CRnext
- CRprevious
- CRsave
Configs
-------------
- g:creader_chars_per_line
- g:creader_lines_per_block
- g:creader_session_file
- g:creader_auto_save
- g:creader_debug_mode
- g:creader_log_file
Snapshots
=============
[](https://raw.github.com/dyng/CommentReader/master/screenshots/full1.png)
[](https://raw.github.com/dyng/CommentReader/master/screenshots/full2.png)