mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-09-18 07:15:52 +00:00
57ea2e92ec
- Removed ZIP system for now, until the idea can be fleshed out. - Added testing to cover. - Upgraded used library. - Added custom handling for BookStack callouts. - Added HTML cleanup to better produce output for things like code blocks.
77 lines
2.9 KiB
PHP
77 lines
2.9 KiB
PHP
<?php namespace BookStack\Entities\Tools\Markdown;
|
|
|
|
use League\HTMLToMarkdown\Converter\BlockquoteConverter;
|
|
use League\HTMLToMarkdown\Converter\CodeConverter;
|
|
use League\HTMLToMarkdown\Converter\CommentConverter;
|
|
use League\HTMLToMarkdown\Converter\DivConverter;
|
|
use League\HTMLToMarkdown\Converter\EmphasisConverter;
|
|
use League\HTMLToMarkdown\Converter\HardBreakConverter;
|
|
use League\HTMLToMarkdown\Converter\HeaderConverter;
|
|
use League\HTMLToMarkdown\Converter\HorizontalRuleConverter;
|
|
use League\HTMLToMarkdown\Converter\ImageConverter;
|
|
use League\HTMLToMarkdown\Converter\LinkConverter;
|
|
use League\HTMLToMarkdown\Converter\ListBlockConverter;
|
|
use League\HTMLToMarkdown\Converter\ListItemConverter;
|
|
use League\HTMLToMarkdown\Converter\PreformattedConverter;
|
|
use League\HTMLToMarkdown\Converter\TextConverter;
|
|
use League\HTMLToMarkdown\Environment;
|
|
use League\HTMLToMarkdown\HtmlConverter;
|
|
|
|
class HtmlToMarkdown
|
|
{
|
|
protected $html;
|
|
|
|
public function __construct(string $html)
|
|
{
|
|
$this->html = $html;
|
|
}
|
|
|
|
/**
|
|
* Run the conversion
|
|
*/
|
|
public function convert(): string
|
|
{
|
|
$converter = new HtmlConverter($this->getConverterEnvironment());
|
|
$html = $this->prepareHtml($this->html);
|
|
return $converter->convert($html);
|
|
}
|
|
|
|
/**
|
|
* Run any pre-processing to the HTML to clean it up manually before conversion.
|
|
*/
|
|
protected function prepareHtml(string $html): string
|
|
{
|
|
// Carriage returns can cause whitespace issues in output
|
|
$html = str_replace("\r\n", "\n", $html);
|
|
// Attributes on the pre tag can cause issues with conversion
|
|
return preg_replace('/<pre .*?>/', '<pre>', $html);
|
|
}
|
|
|
|
/**
|
|
* Get the HTML to Markdown customized environment.
|
|
* Extends the default provided environment with some BookStack specific tweaks.
|
|
*/
|
|
protected function getConverterEnvironment(): Environment
|
|
{
|
|
$environment = new Environment(['header_style' => 'atx']);
|
|
|
|
$environment->addConverter(new BlockquoteConverter());
|
|
$environment->addConverter(new CodeConverter());
|
|
$environment->addConverter(new CommentConverter());
|
|
$environment->addConverter(new DivConverter());
|
|
$environment->addConverter(new EmphasisConverter());
|
|
$environment->addConverter(new HardBreakConverter());
|
|
$environment->addConverter(new HeaderConverter());
|
|
$environment->addConverter(new HorizontalRuleConverter());
|
|
$environment->addConverter(new ImageConverter());
|
|
$environment->addConverter(new LinkConverter());
|
|
$environment->addConverter(new ListBlockConverter());
|
|
$environment->addConverter(new ListItemConverter());
|
|
$environment->addConverter(new CustomParagraphConverter());
|
|
$environment->addConverter(new PreformattedConverter());
|
|
$environment->addConverter(new TextConverter());
|
|
|
|
return $environment;
|
|
}
|
|
}
|