mindkomm / commonmark-searchhighlight-extension
用于在 Markdown 文件中突出显示搜索字符串的 CommonMark PHP 实现扩展
2.0.0
2019-12-05 06:26 UTC
Requires
- php: ^5.5|^7.0
- league/commonmark: ^1.0
This package is auto-updated.
Last update: 2024-09-05 17:01:30 UTC
README
SearchHighlight 是 CommonMark PHP 实现的一个扩展,可用于突出显示与搜索字符串匹配的 Markdown 文本。
该扩展在匹配搜索字符串的字符串周围添加一个 <span class="search-highlight">
。
"something" 的示例
安装
此项目可以通过 Composer 安装
composer require mindkomm/commonmark-searchhighlight-extension
使用方法
use League\CommonMark\Environment; use League\CommonMark\CommonMarkConverter; use Mind\CommonMark\SearchHighlightExtension\SearchHighlightExtension; $searchstring = 'Your search string'; $config = []; $environment = Environment::createCommonMarkEnvironment(); if (!empty($searchstring)) { // Pass the search string to the constructor. $environment->addExtension(new SearchHighlightExtension($searchstring)); } $converter = new CommonMarkConverter($config, $environment); echo $converter->convertToHtml('A text that contains your search string.');