webuni / commonmark-attributes-extension
The attributes extension adds a syntax to define attributes on the various HTML elements in CommonMark PHP implementation.
Installs: 149 775
Dependents: 12
Suggesters: 0
Security: 0
Stars: 33
Watchers: 3
Forks: 15
Open Issues: 0
Type:commonmark-extension
Requires
- php: ^7.1
- league/commonmark: ^1.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.14
- league/commonmark-ext-table: ^1.0|^2.0
- phpstan/phpstan: ~0.11
- phpunit/phpunit: ^7.0|^8.0
- symfony/var-dumper: ^4.3
- vimeo/psalm: ^3.5
README
The Attributes extension adds a syntax to define attributes on the various HTML elements in markdown’s output.
DEPRECATED
This extension has been deprecated. All of its functionality now exists in league/commonmark
1.5+ under the League\CommonMark\Extension\Attributes
namespace, so you should upgrade to that version and use that bundled extension instead of this one.
Installation
This project can be installed via Composer:
composer require webuni/commonmark-attributes-extension
Usage
use League\CommonMark\Converter; use League\CommonMark\DocParser; use League\CommonMark\Environment; use League\CommonMark\HtmlRenderer; use Webuni\CommonMark\AttributesExtension\AttributesExtension; $environment = Environment::createCommonMarkEnvironment(); $environment->addExtension(new AttributesExtension()); $converter = new Converter(new DocParser($environment), new HtmlRenderer($environment)); echo $converter->convertToHtml('# Hello World!');
Syntax
The basic syntax was inspired by Kramdown‘s Attribute Lists feature.
You can assign any attribute to a block-level element. Just directly prepend or follow the block with a block inline attribute list. That consists of a left curly brace, optionally followed by a colon, the attribute definitions and a right curly brace:
> A nice blockquote {: title="Blockquote title"} {#id .class} ## Header
As with a block-level element you can assign any attribute to a span-level elements using a span inline attribute list, that has the same syntax and must immediately follow the span-level element:
This is *red*{style="color: red"}.