Skip to content

Latest commit

 

History

History
58 lines (43 loc) · 1.54 KB

README.md

File metadata and controls

58 lines (43 loc) · 1.54 KB

Build Status

hexo-autolinker

Automatically transforms URLs into links. This hexo plugin is a wrapper around the Autolinker.js library.

Example:

Visit www.codeblocq.com when you have time.

becomes

Visit <a href="http://www.codeblocq.com" target="_blank">www.codeblocq.com</a> when you have time.

Installation

npm install hexo-autolinker --save

Options

Configure the plugin your blog's main _config.yml

autolinker:
    enable: true
    newWindow: true
    urls: true
    email: true
    tel: false
    twitter: false
    hashtag: instagram
    className: 'test'

Explanations:

Property Default Value Description
enable true Enable the plugin
newWindow true Opens links in new tabs/windows <-> Add target="_blank"
urls true converts urls to links
email true converts email addresses to mailto links
tel false converts telephone numbers to tel links
twitter false converts twitter handles to links
hastag false Use twitter, facebook or instagram to convert hashtags to the links
className false Adds a custom class to the links that were transformed

Checkout Autolinker.js and the Autolinker live examples for more options and examples.

License

MIT