Skip to content

rnjailamba/PermalinkJS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

NPM npm version build status npm downloads

Permalinks for your html page

Easy creation of permalinks on your html page! [DEMOS - http://goo.gl/Qnkn0N http://goo.gl/zEbKel]

Requirements

Just any html page with h1/h2/h3/h4/h5/h6/p/a/blockquote/header/footer/ul/ol tags and PermalinkJS will add permalinks!

Installation

  npm install permalinkjs --save

After Installation

You will find the permalink.js file in node_modules/permalinkjs/dist/permalink.js.
Please include the permalink.js file after including jQuery.
Please check node_modules/permalinkjs/demo/index.html for a very easy example.
Or just copy stuff from here -> https://goo.gl/LDfvWJ

Usage - Example 1

Just include the following script tag on your HTML page.( after jquery and permalink.js )
All h1,h2,h3,h4,h5,h6,p,a,blockquote,header,footer,ul,ol elements that are direct children of the div with id="element" will get permalinks now.

<script>
	$(document).ready( function() {
		$( "#element" ).permalink( {
			tags: "h1,h2,h3,h4,h5,h6,p,a,blockquote,header,footer,ul,ol"
		} );
		
	} );
</script>

Usage - Example 2

Only h1 elements that are direct children of the div with id="element" will get permalinks now.

<script>
	$(document).ready( function() {
		$( "#element" ).permalink( {
			tags: "h1"
		} );
		
	} );
</script>

Tests

   npm test

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Release History

  • 0.0.0 Initial release
  • 0.0.1 Initial release
  • 0.0.2 Initial release
  • 0.0.3 Initial release
  • 0.0.4 Initial release
  • 0.0.5 Initial release
  • 0.0.6 Initial release
  • 0.0.7 Initial release
  • 0.0.8 Initial release