https://github.com/dyng/ycommentreader

Read your favorite novel in comment blocks
https://github.com/dyng/ycommentreader

Last synced: 6 days ago
JSON representation

Read your favorite novel in comment blocks

• Host: GitHub
• URL: https://github.com/dyng/ycommentreader
• Owner: dyng
• Created: 2012-07-05T04:04:14.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2013-09-07T15:22:20.000Z (about 11 years ago)
• Last Synced: 2024-04-22T05:10:10.445Z (7 months ago)
• Language: Python
• Size: 141 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
CommentReader

=============

Read your favorite novel in Vim as comment ( Don't let your boss know :P )

Requirements

============

- Vim 7.3+

- Python support for Vim

Installation

=============

Just drop all files in `plugin/` to `$HOME/.vim/plugin/` directory and enjoy!

Although I recommend using [vundle](https://github.com/gmarik/vundle/) or [pathogen](https://github.com/tpope/vim-pathogen/) to manage your vim plugins.

Usage and Configuration

=============

At first you should open novel with `:CRopen path/to/your/novel`, note that the novel file need to be `plain text` with encoding `UTF-8`, then you can try `:CRnextpage` and `:CRprepage` to page, `:CRnextblock` and `:CRpreblock` to move around among comment blocks where your novel's content is in. Also, there are some handy keymaps for it by default.

Commands

-------------

- *CRopen*:      open novel file and initiate.

- *CRnextpage*:  load next page and render.

- *CRprepage*:   back to the previous page.

- *CRnextblock*: jump to the next comment block.

- *CRprepage*:   jump to the previous comment block.

- *Crclear*:     Clear all 'novel' blocks.

Maps

-------------

- *<leader>d*: next page

- *<leader>a*: previous page

- *<leader>s*: next comment block

- *<leader>w*: previous comment block

all above are in normal mode, and by default the `` is `\`

Configs

-------------

- *g:creader_chars_per_line*:  the character numbers per line.

- *g:creader_lines_per_block*: the line numbers in an individual comment block.