Feature suggestion : highlighting text

[Grishkaone]

Hello

Problem

As I share some text, I often use bold, emphasis and bloc quote. But sometimes, I want something more explicit and visual, like highlighting some specific word or sentence.

Details

Some markdown flavor can highlight parts of the text with this syntax :

• This is ==my important text==

« my important text » will render with a colored background, usually a pale yellow.

• This is my important text

The HTML rendered text will use the <mark>my important text</mark> tag.

Can it be added to the existing parser ?

[nodiscc]

Hi, Shaarli uses https://github.com/erusev/parsedown and https://github.com/erusev/parsedown-extra for markdown rendering. It seems support for mark has already been requested in erusev/parsedown-extra#3 but rejected since it's not part of the specification. It's also mentioned in erusev/parsedown#414 with a link to instructions on how to create an extension.

[Grishkaone]

@nodiscc thanks for this information, I'll take a look at it and try to create an extension. 😊

[Grishkaone]

I have something that works, but it's definitely not the cleanest way to do it!

1. Create a file called ShaarliParsedownExtra.php (only valid if you're using the extra variant, of course) and put this content in it:

   <?php

namespace Shaarli\Formatter\Parsedown;

/**
 * ParsedownExtra extension for Shaarli.
 *
 * Extension for both Parsedown and ParsedownExtra centralized in ShaarliParsedownTrait.
 */
class ShaarliParsedownExtra extends \ParsedownExtra
{
    use ShaarliParsedownTrait;

    /**
     * add support for ==
     */
    public function __construct()
    {
        parent::__construct();
        $this->InlineTypes['='][] = 'Mark';
        $this->inlineMarkerList .= '=';
    }

    /**
     * Take == and transform to <mark>
     */
    protected function inlineMark($excerpt)
    {
        if (strpos($excerpt['text'], '==') !== 0) {
            return null;
        }
        
        $closingPosition = strpos($excerpt['text'], '==', 2);
        
        if ($closingPosition === false) {
            return null;
        }
        
        $text = substr($excerpt['text'], 2, $closingPosition - 2);
        
        return [
            'extent' => $closingPosition + 2,
            'element' => [
                'name' => 'mark',
                'handler' => 'line',
                'text' => $text,
            ],
        ];
    }
}

2. Upload the file /var/www/shaarli/application/formatter/Parsedown/ShaarliParsedownExtra.php to a file on the host
3. Modify the style of the <mark> tag in /var/www/shaarli/assets/common/css/markdown.css. To make the change permanent, I also uploaded the file to the host.

The handling of the == tag was OK, but not the style, because the file /var/www/shaarli/tpl/default/css/markdown.min.css is used. I modified the style in it, for lack of a better solution, but I think I should redo it in the future.

This is sufficient for me, but I imagine it is possible to do something more permanent, perhaps via a Shaarli plugin, if somebody want to build on that.

🖖