writegood.vim


Ⅰ. 插件描述

Vim plugin for Matt Might's '3 shell scripts that can improve your writing'

Ⅱ. 基本信息

创建日期:  2012-04-22
使用用户:  29
Github星:  69
插件作者:  David Beckingsale

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:
Plugin 'davidbeckingsale/writegood-vim'
… 然后在Vim中运行以下命令:
:source %
:PluginInstall

对于Vundle版本 < 0.10.2,请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:
NeoBundle 'davidbeckingsale/writegood-vim'
… 然后在Vim中运行以下命令:
:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:
Plug 'davidbeckingsale/writegood-vim'
… 然后在Vim中运行以下命令:
:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:
cd ~/.vim/bundle
git clone https://github.com/davidbeckingsale/writegood.vim

Ⅳ. 文档说明

# Writegood.vim

Writegood is a plugin to highlight common writing problems.

The plugin uses the Error group to highlight errors, so I assume it will work
on both gvim and terminal vim.

Features

  • Detects duplicate words (even over newlines)
  • Highlights use of passive voice
  • Highlights common "weasel words"

Screenshot

Writegood mode in action

About

After reading Matt Might's blog post about a year ago, I was thrilled when I
came across Benjamin Beckwith's writegood mode for Emacs, my editor of choice at
the time. However, people change, and after jumping on the vim bandwagon about
six months ago I forgot about both the plugin and Matt's post.

Eventually I found myself in the position to be doing some academic writing
again, and was frustrutated when I couldn't find a similar plugin for vim, so
after reading Steve Losh's 'Learn Vimscript the Hard Way' I decided to write one
for myself.

Installation

  • Pathogen

    • git clone https://github.com/davidbeckingsale/writegood.vim ~/.vim/bundle/writegood.vim
  • vim-plug

    • Plug 'davidbeckingsale/writegood.vim'
  • NeoBundle

    • NeoBundle 'davidbeckingsale/writegood.vim'
  • Vundle

    • Plugin 'davidbeckingsale/writegood.vim'
  • Vim packages

    • git clone https://github.com/davidbeckingsale/writegood.vim ~/.vim/pack/plugins/start/writegood.vim

Usage

Writegood.vim introduces three commands to enable, disable, or toggle its functionality:

  • :WritegoodEnable
  • :WritegoodDisable
  • :WritegoodToggle

Links

Credits

  • Matt Might for writing the original scripts.
  • Benjamin Beckwith for the emacs mode and catchy title I've borrowed.
  • Steve Losh for 'Learn Vimscript the Hard Way'.
  • Nathaniel Kane for the vim-indent-guides plugin, which I used as a
    reference for structuring and documentation.

Contact

  • Twitter: @dabeckingsale

If anyone has any suggestions for improving my dodgy match usage, it would be
much appreciated.

添加新评论