## text-autolinker Converts text into HTML, by automatically linking the URLs and twitter elements such as username and hashtags. - Twitter `@usersname` and `#hashtags` into `` links - Twitter photo and video links into `` - URLs into `` - Email addresses into `` - Natural language dates: `today at 4:15pm` into `` linking ## Install npm install text-autolinker ## Run 1. Move into the project directory `$ cd text-autolinker` 2. Run `$ npm install` 3. Run `$ node bin/text-autolinker.js` 4. Connect to the server using `http://localhost:3007` ## Use var autolinker = require('text-autolinker'); var options = { text: 'Meeting @glennjones today at 4:10pm', publishedDate: '2014-08-08' }; autolinker.parse(options, function(err, result){ // do something with data }); #### Available options * `className` - `autoLink` - the class for any link added, the default is `auto-link` - `url` - the class added any web address links, the default is `u-url` - `email` - the class added any web address links, the default is `u-email` - `user` - the class added for twitter username links, the default is `h-x-username` - `tag` - the class added for tag links, the default is `p-category` - `photo` - the class added for twitter photo links, the default is `u-photo` - `video` - the class added for twitter video links, the default is `u-video` - `date` - the class for any time tag added, the default is `auto-date-discovery dt-start` * `escapeHtml` - switch to escape the text, default is `true` * `expandUrls` - switch to expanded any shortened urls, default is `true` * `urls` - JSON object of terms to link as urls ## Twitter usersname and hashtags parsing The module will parse Twitter `@usersname` and `#hashtags` from the text. It wraps these items in `` tags with classes. The text "@glennjones likes #javascript" is parsed into: @glennjones likes #javascript The parser also provides metadata for usersname and hashtags: { "html": "@glennjones likes #javascript", "account": [{ "match": "@glennjones", "username": "glennjones", "domain": "twitter.com" }], "category": ["javascript"] } ## Twitter photo and video link parsing The module will parse Twitter photo and video links from the text. It wraps these items in `` tags with classes. Where possible the links are expanded. The text "I like pic.twitter.com/FzYI36MKFN and vine.co/v/b55LOA1dgJU" is parsed into: I like https://twitter.com/adactio/status/501407682558177282/photo/1 and vine.co/v/b55LOA1dgJU The parser also provides metadata for media types: { "html": "I like https://twitter.com/adactio/status/501407682558177282/photo/1 and vine.co/v/b55LOA1dgJU", "media": [{ "match": "pic.twitter.com/FzYI36MKFN", "type": "image", "url": "https://pic.twitter.com/FzYI36MKFN", "expanded": "https://twitter.com/adactio/status/501407682558177282/photo/1" },{ "match": "vine.co/v/b55LOA1dgJU", "type": "video", "url": "https://vine.co/v/b55LOA1dgJU" }] } ## URL parsing The module will parse any word that looks like a URL. It wraps these items in `` tags with classes. Where possible the links are expanded. The text "I like http://glennjones.net" is parsed into: I like http://glennjones.net The parser also provides metadata for URLs: { "html": "I like http://glennjones.net", "url": [{ "match": "http://glennjones.net", "expanded": "http://glennjones.net" }] } ## Email parsing The module will parse any word that looks like a email address. It wraps these items in `` tags with classes. The text "Contact me at joe.bloggs@eaxmpla.com" is parsed into: Contact me at joe.bloggs@eaxmpla.com The parser also provides metadata for URLs: { "html": "Contact me at joe.bloggs@eaxmpla.com", "email": [{ "address": "joe.bloggs@eaxmpla.com", "local": "joe.bloggs", "domain": "eaxmpla.com" }] } ## Time parsing The module will try and parse any time from natural language. Some examples are: - 15 May 2014 - 15th May 2014 - 14 Jun 2014 - Aug 17 2014 - 9 May 2014 at 16:10 - 9 May 2014 at 4:10pm - 4:10pm - this Monday - yesterday, today, tonight and tomorrow For this function to work well you need to provide a `publishedDate`. This should be in the ISO format and where possible have the correct timezone information i.e `2014-05-15T04:10:00-04:00`. The parser will add date and time using the HTML5 `