Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 47 Commits
.github		.github
src		src
tests		tests
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.scrutinizer.yml		.scrutinizer.yml
.styleci.yml		.styleci.yml
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
CONDUCT.md		CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
README.md		README.md
composer.json		composer.json
phpunit.xml.dist		phpunit.xml.dist

Repository files navigation

URL and email autolinking extension for`league/commonmark`

DEPRECATED

This extension has been deprecated. All of its functionality now exists inleague/commonmark 1.3+ under theLeague\CommonMark\Extension\Autolink namespace, so you should upgrade to that version and use that bundled extension instead of this one.

Overview

This extension addsGFM-style autolinking to theleague/commonmark Markdown parser for PHP. It automatically link URLs and email addresses even when the CommonMark<...> autolink syntax is not used.

It also provides a parser to autolink@mentions to Twitter, Github, or any custom service you wish, though this is disabled by default.

Install

Via Composer

$ composer require league/commonmark-ext-autolink

Usage

Configure yourEnvironment as usual and simply add theAutolinkExtension provided by this package:

useLeague\CommonMark\CommonMarkConverter;useLeague\CommonMark\Environment;useLeague\CommonMark\Ext\Autolink\AutolinkExtension;// Obtain a pre-configured Environment with all the CommonMark parsers/renderers ready-to-go$environment = Environment::createCommonMarkEnvironment();// Add this extension$environment->addExtension(newAutolinkExtension());// Instantiate the converter engine and start converting some Markdown!$converter =newCommonMarkConverter([],$environment);echo$converter->convertToHtml('I successfully installed the https://github.com/thephpleague/commonmark-ext-autolink extension!');

`@mention` Autolinking

This extension also provides functionality to automatically link "mentions" like@colinodell to Twitter, Github, or any other site of your choice!

For Twitter:

useLeague\CommonMark\Environment;useLeague\CommonMark\Ext\Autolink\InlineMentionParser;$environment = Environment::createCommonMarkEnvironment();$environment->addInlineParser(InlineMentionParser::createTwitterHandleParser());// TODO: Instantiate your converter and convert some Markdown

For GitHub:

useLeague\CommonMark\Environment;useLeague\CommonMark\Ext\Autolink\InlineMentionParser;$environment = Environment::createCommonMarkEnvironment();$environment->addInlineParser(InlineMentionParser::createGithubHandleParser());// TODO: Instantiate your converter and convert some Markdown

Or configure your own custom one:

useLeague\CommonMark\Environment;useLeague\CommonMark\Ext\Autolink\InlineMentionParser;$environment = Environment::createCommonMarkEnvironment();$environment->addInlineParser(newInlineMentionParser('https://www.example.com/users/%s/profile'));// TODO: Instantiate your converter and convert some Markdown

When creating your own, you can provide two parameters to the constructor:

A URL template where%s is replaced with the username (required)
A regular expression to parse and validate the username (optional - defaults to'/^[A-Za-z0-9_]+(?!\w)/')