Fork me on GitHub

Converters

Converters will convert incoming markup to something else, generally HTML. Sculpin ships with two converters, Markdown and Textile.


Markdown Converter

The Markdown Converter will convert .md, .mdown, .mkdn and .markdown files using michelf/php-markdown.

Configuration

The Markdown Converter can be configured by adjusting the following sculpin_kernel.yml settings:

  • sculpin_markdown.parser_class: Can be one of Sculpin\Bundle\MarkdownBundle\PhpMarkdownParser or Sculpin\Bundle\MarkdownBundle\PhpMarkdownExtraParser. Default value is Sculpin\Bundle\MarkdownBundle\PhpMarkdownParser. A custom parser must implement the Sculpin\Core\Converter\ParserInterface.
  • sculpin_markdown.extensions: Default value is ['md', 'mdown', 'mkdn', 'markdown'].

Other Markdown Classes

Third party extensions are available to support other Markdown varieties. See the individual package README files for specific installation information.


Textile Converter

The Textile Converter will convert .textile files using netcarver/textile.

Configuration

The Textile Converter can be configured by adjusting the following sculpin_kernel.yml settings:

  • sculpin_textile.extensions: Default value is ['.textile'].