Git Product home page Git Product logo

htmllint-spellcheck's Introduction

htmllint-spellcheck

This is a htmllint plugin that uses aspell to spellcheck any text that might be viewable or read by the user.

NOTE: not currently completed, do not use (will be integrated shortly)

Install

Just run a simple npm install to get this module:

$ npm install htmllint-spellcheck
# to save this as a devDependency
$ npm install -D htmllint-spellcheck

Usage

If you are using grunt, then you should install this module as a dependency:

$ npm install -D htmllint-spellcheck

You also need to install aspell to use this module.

After doing so, add the following to your Gruntfile.js:

grunt.initConfig({
// ... wherever your target is for htmllint that you want to add the plugin to:
  htmllint: {
    a_target: {
	  options: {
	    // add the 'htmllint-spellcheck' plugin to the list
	    plugins: ['htmllint-spellcheck'],
		// ... rest of your options
		spellcheck: true
    }
  }
// ...
});

If you are using the htmllint npm module, you can add the plugin to a linter instance by doing the following:

var htmllint = require('htmllint');

var linter = htmllint.create();
// add the htmllint-spellcheck plugin
linter.use(require('htmllint-spellcheck'));
// or you can do this:
linter.use('htmllint-spellcheck');

htmllint-spellcheck's People

Contributors

coalman avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.