https://github.com/mike-zarandona/acrogrow.js

A jQuery plug-in that makes (non)sense of internet acronyms.
https://github.com/mike-zarandona/acrogrow.js

Last synced: about 2 months ago
JSON representation

A jQuery plug-in that makes (non)sense of internet acronyms.

• Host: GitHub
• URL: https://github.com/mike-zarandona/acrogrow.js
• Owner: mike-zarandona
• License: mit
• Created: 2014-04-15T15:49:55.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-04-18T19:40:10.000Z (over 10 years ago)
• Last Synced: 2023-08-07T13:11:23.754Z (over 1 year ago)
• Language: CSS
• Homepage: http://acrogrowjs.com
• Size: 164 KB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
AcroGrow.js

===========

A jQuery plug-in that makes (non)sense of internet acronyms.

[http://acrogrowjs.com](http://acrogrowjs.com)

 

## Features

- Replaces acronyms within specified elements with random nonsense words OR actual definitions.

- Define custom acronyms list & associated definitions.

- Separate name-spaced CSS file for easy customization & debugging.

 

## Getting Started

1. Include the AcroGrow CSS

1. Include jQuery

1. Include acrogrow.randomWords.js (optional)

1. Include acrogrow.js

1. Call acroGrow() when the document is ready

For example:

*Head area of document*

	

*Body area of document*

	

	

	

		$(document).ready(function() {

			$('.foo').acroGrow();

		});

	

To see more examples of usage, visit [the project page](http://acrogrowjs.com).

 

## How it Works

AcroGrow evaluates each specified element and wraps each acronym match in a ``…``.  After the initial identification stage, the wrapped matches are either replaced with their proper definitions, or dynamically replaced with randomly generated replacements depending on the options set.

 

## Author

[Mike Zarandona](http://twitter.com/mikezarandona) | [http://mikezarandona.com](http://mikezarandona.com)