Skip to content

joeyism/autolinker

Repository files navigation

Automatically generates link from URL within div

A gentle wrapper that turns non-links into links

Dependencies

  • AngularJS

Install

  1. download the files
    1. Bower
      1. add "angular-autolinker": "latest" to your bower.json file then run bower install OR run bower install angular-autolinker
  2. include the files in your app
    1. autolinker.min.js
    2. autolinker.less OR autolinker.min.css OR autolinker.css
  3. include the module in angular (i.e. in app.js) - Joeyism.angular-autolinker

See the gh-pages branch, files bower.json and index.html for a full example.

Documentation

See the autolinker.js file top comments for usage examples and documentation https://github.com/joeyism/autolinker/blob/master/autolinker.js

Development

  1. git checkout gh-pages
    1. run npm install && bower install
    2. write your code then run grunt
    3. git commit your changes
  2. copy over core files (.js and .css/.less for directives) to master branch
    1. git checkout master
    2. git checkout gh-pages autolinker.js autolinker.min.js autolinker.less autolinker.css autolinker.min.css
  3. update README, CHANGELOG, bower.json, and do any other final polishing to prepare for publishing
    1. git commit changes
    2. git tag with the version number, i.e. git tag v1.0.0
  4. create github repo and push
    1. [if remote does not already exist or is incorrect] git remote add origin [github url]
    2. git push origin master --tags (want to push master branch first so it is the default on github)
    3. git checkout gh-pages
    4. git push origin gh-pages
  5. (optional) register bower component
    1. bower register angular-autolinker [git repo url]

About

A simple directive that turns all URLs within its div into links

Resources

Stars

Watchers

Forks

Packages

No packages published