Skip to content

Latest commit

 

History

History
36 lines (31 loc) · 1.07 KB

README.md

File metadata and controls

36 lines (31 loc) · 1.07 KB
Raw

Site Inspector

A jQuery plugin to inspect a site's markup.

Development

gem install sass sass-globbing
npm install
bower install
grunt # runs watch command (compass & jshint)
grunt build # minify js to /dist

Usage

// init defaults
$('body').siteInspector();
// init with options
$('body').siteInspector({
  debug: true,
  showTags: true,
  cssPath: '../path/to/your/custom.css'
});
// check if inspection is enabled; returns true|false
$('body').siteInspector('isEnabled');

Options

  • debug true|false : default false
  • showTags true|false : default false - Enable display of element selector and dimensions (i.e. div.container 1024px x 800px)
  • cssPath '../path/to/your/custom.css'|false : default false - Overwrite the default css path with your own (Note: Path is relative)
  • onInit: function() {} - Hook for a method to be triggered after initialization
  • onDestroy: function() {} - Hook for a method to be triggered after destruction

License

MIT License