Skip to main content
Version: 1.2.x

Smartypants

Description​

Smartypants in ParsedownExtended automatically transforms basic ASCII punctuation marks into their typographically correct HTML entities. This feature enhances the readability and aesthetic appeal of your text by converting straight quotes to curly quotes, dashes to en-dashes and em-dashes, and ellipses to their HTML equivalents. It's particularly useful for ensuring that your Markdown content maintains high typographical standards without manual adjustments.

ASCII to HTML Entity Conversion​

ASCII symbolReplacementsHTML EntitiesSubstitution Keys
''‘ ’‘ ’"left-single-quote", "right-single-quote"
""“ ”“ ”"left-double-quote", "right-double-quote"
<< >>« »&laquo; &raquo;"left-angle-quote", "right-angle-quote"
...…&hellip;"ellipsis"
--–&ndash;"ndash"
---—&mdash;"mdash"

Configuration Syntax​

Configure Smartypants using the setSetting method:

$ParsedownExtended->setSetting('smarty', (boolean|array) $value);

Parameters​

Customize Smartypants with these options:

  • smart_dashes (boolean): Convert dashes to en-dashes and em-dashes.
  • smart_quotes (boolean): Convert straight quotes to curly quotes.
  • smart_angled_quotes (boolean): Convert angled quotes.
  • smart_ellipses (boolean): Convert triple periods to ellipses.
  • substitutions (array): Overwrite default substitutions with custom mappings.

Examples​

Custom Substitutions​

To customize the substitutions for a specific language or style:

$ParsedownExtended->setSetting('smarty', [
    'substitutions' => [
        'left-single-quote' => '&sbquo;', // Single bottom quote
        'right-single-quote' => '&lsquo;', // Single top quote
        'left-double-quote' => '&bdquo;', // Double bottom quote
        'right-double-quote' => '&ldquo;' // Double top quote
    ]
]);

Enable Smartypants​

To enable Smartypants and automatically apply typographical enhancements:

$ParsedownExtended->setSetting('smarty', true);