BookStack Code Mirror - bookstack/blobdiff - app/Entities/Tools/Markdown/HtmlToMarkdown.php

diff --git a/app/Entities/Tools/Markdown/HtmlToMarkdown.php b/app/Entities/Tools/Markdown/HtmlToMarkdown.php

index c56119fe19cec8eb4437fdf2321236067980388f..473435c7f0cc0371dd14e94d1ea4d5bc80d15ea1 100644 (file)

--- a/app/Entities/Tools/Markdown/HtmlToMarkdown.php

+++ b/app/Entities/Tools/Markdown/HtmlToMarkdown.php

@@ -1,14 +1,14 @@

-<?php namespace BookStack\Entities\Tools\Markdown;

+<?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;

@@ -19,7 +19,7 @@ use League\HTMLToMarkdown\HtmlConverter;

class HtmlToMarkdown

{

- protected $html;

+ protected string $html;

public function __construct(string $html)

{

@@ -27,12 +27,13 @@ class HtmlToMarkdown

}

/**

- * Run the conversion

+ * Run the conversion.

*/

public function convert(): string

{

$converter = new HtmlConverter($this->getConverterEnvironment());

$html = $this->prepareHtml($this->html);

+

return $converter->convert($html);

}

@@ -54,36 +55,38 @@ class HtmlToMarkdown

protected function getConverterEnvironment(): Environment

{

$environment = new Environment([

- 'header_style' => 'atx', // Set to 'atx' to output H1 and H2 headers as # Header1 and ## Header2

- 'suppress_errors' => true, // Set to false to show warnings when loading malformed HTML

- 'strip_tags' => false, // Set to true to strip tags that don't have markdown equivalents. N.B. Strips tags, not their content. Useful to clean MS Word HTML output.

+ 'header_style' => 'atx', // Set to 'atx' to output H1 and H2 headers as # Header1 and ## Header2

+ 'suppress_errors' => true, // Set to false to show warnings when loading malformed HTML

+ 'strip_tags' => false, // Set to true to strip tags that don't have markdown equivalents. N.B. Strips tags, not their content. Useful to clean MS Word HTML output.

'strip_placeholder_links' => false, // Set to true to remove <a> that doesn't have href.

- 'bold_style' => '**', // DEPRECATED: Set to '__' if you prefer the underlined style

- 'italic_style' => '*', // DEPRECATED: Set to '_' if you prefer the underlined style

- 'remove_nodes' => '', // space-separated list of dom nodes that should be removed. example: 'meta style script'

- 'hard_break' => false, // Set to true to turn <br> into `\n` instead of ` \n`

- 'list_item_style' => '-', // Set the default character for each <li> in a <ul>. Can be '-', '*', or '+'

- 'preserve_comments' => false, // Set to true to preserve comments, or set to an array of strings to preserve specific comments

- 'use_autolinks' => false, // Set to true to use simple link syntax if possible. Will always use []() if set to false

- 'table_pipe_escape' => '\|', // Replacement string for pipe characters inside markdown table cells

- 'table_caption_side' => 'top', // Set to 'top' or 'bottom' to show <caption> content before or after table, null to suppress

+ 'bold_style' => '**', // DEPRECATED: Set to '__' if you prefer the underlined style

+ 'italic_style' => '*', // DEPRECATED: Set to '_' if you prefer the underlined style

+ 'remove_nodes' => '', // space-separated list of dom nodes that should be removed. example: 'meta style script'

+ 'hard_break' => false, // Set to true to turn <br> into `\n` instead of ` \n`

+ 'list_item_style' => '-', // Set the default character for each <li> in a <ul>. Can be '-', '*', or '+'

+ 'preserve_comments' => false, // Set to true to preserve comments, or set to an array of strings to preserve specific comments

+ 'use_autolinks' => false, // Set to true to use simple link syntax if possible. Will always use []() if set to false

+ 'table_pipe_escape' => '\|', // Replacement string for pipe characters inside markdown table cells

+ 'table_caption_side' => 'top', // Set to 'top' or 'bottom' to show <caption> content before or after table, null to suppress

]);

$environment->addConverter(new BlockquoteConverter());

$environment->addConverter(new CodeConverter());

$environment->addConverter(new CommentConverter());

- $environment->addConverter(new DivConverter());

+ $environment->addConverter(new CustomDivConverter());

$environment->addConverter(new EmphasisConverter());

$environment->addConverter(new HardBreakConverter());

$environment->addConverter(new HeaderConverter());

$environment->addConverter(new HorizontalRuleConverter());

- $environment->addConverter(new ImageConverter());

+ $environment->addConverter(new CustomImageConverter());

$environment->addConverter(new LinkConverter());

$environment->addConverter(new ListBlockConverter());

$environment->addConverter(new ListItemConverter());

$environment->addConverter(new CustomParagraphConverter());

$environment->addConverter(new PreformattedConverter());

$environment->addConverter(new TextConverter());

+ $environment->addConverter(new CheckboxConverter());

+ $environment->addConverter(new SpacedTagFallbackConverter());

return $environment;

}