Real-time grammar and word usage feedback with Markdown
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
.gitignore
Gruntfile.js
LICENSE
README.md
index.js
package.json

README.md

WordSmith

WordSmith is a document authoring tool for real-time grammar and word usage feedback when writing Markdown documents, by using the Write-Good npm module.

To get real-time monitoring, point WordSmith at your Markdown file, and every time you save your document you will see a suggestions report.

Installation

Install from GitHub by cloning the repository:

$ git clone https://github.com/paulja/wordsmith.git

Install the npm modules:

$ npm install

Install the shortcut into your path by using a Grunt task:

$ grunt install

This installs WordSmith as ws in your $PATH.

Usage

Invoke WordSmith from the console with ws with no options to get the help:

Usage: ws [options]

Options:

   -h, --help         output usage information
   -V, --version      output the version number
   -f, --file <path>  Input markdown file

Usage Example

Specify the Markdown file you would like work with:

$ wc -f README.md

Every time you save, WordSmith will provide suggestions to improve your document:

Suggestions (130 words checked):

WordSmith is a document authoring tool for real time grammar and word usage feed
^^^^^^^^^
"WordSmith" is repeated on line 2 at column 0
-------------
Install the shortcut into your path by using a Grunt task:
^^^^^^^
"Install" is repeated on line 18 at column 0

To stop WordSmith from watching a file, press CTRL+C.