bcremer/sculpin-commonmark-bundle

Sculpin league/commonmark bundle

Installs: 5 422

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 6

Forks: 2

Open Issues: 0

pkg:composer/bcremer/sculpin-commonmark-bundle

0.5.0 2021-11-08 15:51 UTC

This package is auto-updated.

Last update: 2025-10-09 00:26:45 UTC


README

Software License Latest Version

Sculpin bundle that integrates the league/commonmark markdown parser.

Installation

  • Add the following to your sculpin.json file:
{
    "require": {
        "bcremer/sculpin-commonmark-bundle": "~0.5"
    }
}
  • Run sculpin update.
  • Add the bundle to your kernel app/SculpinKernel.php:
<?php

class SculpinKernel extends \Sculpin\Bundle\SculpinBundle\HttpKernel\AbstractKernel
{
    protected function getAdditionalSculpinBundles()
    {
        return array(
            'Bcremer\Sculpin\Bundle\CommonMarkBundle\SculpinCommonMarkBundle'
        );
    }
}

Extensibility

This bundle provides access to the low level component of the league/commonmark package. For more information about league/commonmark customization please see Advanced Usage & Customization and Community Extensions.

Defined services

This bundle defines the following services in the sculpin DI Container:

  • sculpin_commonmark.environment
  • sculpin_commonmark.docparser
  • sculpin_commonmark.htmlrenderer
  • sculpin_commonmark.league_converter
  • sculpin_commonmark.converter
  • sculpin_commonmark.event.commonmark

Defined DI Tags

This bundle handles the following Dependency Injection Tags:

Example

To add the CommonMark Table Extension add the following to your app/config/sculpin_services.yml:

# app/config/sculpin_services.yml
services:
    league.commonmark.tablextension:
          class: League\CommonMark\Extension\Table\TableExtension
          tags:
            - { name: sculpin_commonmark.extension }

License

The MIT License (MIT). Please see License File for more information.