Introduction

Welcome to Check Yo Self.

Check Yo Self is a site to check the grammar and spelling of your markdown blog posts/texts.

Frustrated by Grammarly and Hemingway apps' inability to process markdown blog posts, I decided to make my own site to process markdown blog posts or other texts. I settled on Materialize.css a Material Design Lite library for the UI because I like colorful things.

Installation

You'll need to install dev dependencies.

Development setup

There are a few dependencies and I want to thank @btford for his awesome library which without him this wouldn't be as easy.

Fork the repo, and add your own package.json file with:

npm init

and fill in all the gritty details.

The site uses Brian Ford's write-good linter for native English and @danakt's spell-checker-js for the spellchecker I am using.

To install write-good:

npm install write-good

...and spell-checker:

npm install spell-checker

Usage example

You can basically do what you like with this. I am using MEN stack with Mongo, Express, and Node, using RESTful routes and hosting on Heroku. It is up to you how you want to build on top of what I have here.

Using the write-good library

You need to require it in your app.js or whatever you're going to use to route interaction through the app (if you're using MEAN or MEN). Your script could look something like:

const writeGood = require('write-good');

let suggestions = writeGood('So the toilet paper was eaten by my cat');

// Will return an array of suggestions

suggestions:
[{
    suggestion: "omit 'So' from the beginning of sentences",
    index: 0, offset: 2
 }, {
     suggestion: "' was eaten' is passive voice",
     index: 20, offset: 19
 }]

You can also disable checks for certain properties:

const writeGood = require('write-good');

let suggestions = writeGood('So the toilet paper was eaten by my cat', { passive: false });

// suggestions: [ ]

Using the spell-checker-js library

You can easily use this spell-checker library in this project by requiring it and invoking it with something like:

const spell = require('spell-checker-js')

// Load dictionary
spell.load('en')

// Check spelling
const check = spell.check('Some **text** to chec!');

console.log(check)

// Returns an array of spell-checked words
// ['chec']