`s they keep their line breaks. * * @param DOMXPath $xpath * @param DOMNode $region * @return void */ protected function blockWrappersToDivs(DOMXPath $xpath, DOMNode $region): void { $wrappers = $xpath->query('.//header | .//footer | .//section | .//article | .//main | .//figure | .//details | .//summary | .//address | .//hgroup', $region); if (!$wrappers) { return; } $list = []; foreach ($wrappers as $node) { $list[] = $node; } foreach ($list as $node) { if (!$node instanceof DOMElement || !$node->parentNode) { continue; } $div = $node->ownerDocument->createElement('div'); while ($node->firstChild) { $div->appendChild($node->firstChild); } $node->parentNode->replaceChild($div, $node); } } /** * A heading that follows inline content in the same parent (a date * `` before the post title, say) would come out of the converter on * the same line as that text, which is no heading in Markdown. A line * break in front of it keeps it a heading. * * @param DOMXPath $xpath * @param DOMNode $region * @return void */ protected function breakBeforeHeadings(DOMXPath $xpath, DOMNode $region): void { $headings = $xpath->query('.//h1 | .//h2 | .//h3 | .//h4 | .//h5 | .//h6', $region); if (!$headings) { return; } foreach ($headings as $heading) { $previous = $heading->previousSibling; while ($previous && $previous->nodeType === XML_TEXT_NODE && trim($previous->textContent) === '') { $previous = $previous->previousSibling; } if ($previous === null) { continue; } $inline = $previous->nodeType === XML_TEXT_NODE || ($previous instanceof DOMElement && !in_array(strtolower($previous->nodeName), ['p', 'div', 'ul', 'ol', 'table', 'pre', 'blockquote', 'section', 'article', 'header', 'footer', 'figure', 'hr', 'br', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'dl', 'form', 'nav', 'aside', 'main'], true)); if ($inline && trim($previous->textContent) !== '') { $heading->parentNode?->insertBefore($heading->ownerDocument->createElement('br'), $heading); } } } /** * A Markdown link to a page: `[Title](https://site/route.md)`. * * @param PageInterface $page * @return string */ protected function link(PageInterface $page): string { $title = trim((string)$page->title()); $title = str_replace(['[', ']'], ['\\[', '\\]'], $title); return '[' . ($title !== '' ? $title : $page->slug()) . '](' . $this->url($page) . ')'; } /** * The neighbouring page in reading order: the one listed just before or * just after this page in the parent's own collection when the parent * defines one (a blog's posts in blog order), else in the parent's child * list. * * "Previous" here is the entry above this page in that listing and * "Next" the one below it, which is how a reader scanning the parent * page sees them. Page::prevSibling() answers the opposite way round. * * @param PageInterface $page * @param int $direction -1 for previous, 1 for next * @return PageInterface|null */ protected function sibling(PageInterface $page, int $direction): ?PageInterface { $parent = $page->parent(); if (!$parent instanceof PageInterface) { return null; } $path = $page->path(); $ordered = null; try { $collection = $parent->collection('content', false); if ($collection instanceof Collection && $collection->offsetExists($path)) { $ordered = $collection; } } catch (Throwable $e) { $ordered = null; } if ($ordered === null) { $children = $parent->children(); if (!$children instanceof Collection) { return null; } $ordered = $children->pages()->published()->routable(); } $paths = array_keys($ordered->toArray()); $index = array_search($path, $paths, true); if ($index === false || !isset($paths[$index + $direction])) { return null; } $sibling = $ordered->offsetGet($paths[$index + $direction]); if (!$sibling instanceof PageInterface || !$sibling->routable() || $sibling->route() === $page->route()) { return null; } return $sibling; } /** * A page's description: its metadata description if it has one, else its * summary as plain text. * * @param PageInterface $page * @return string */ protected function description(PageInterface $page): string { $header = $page->header(); $description = $header->metadata['description'] ?? null; if (is_string($description) && trim($description) !== '') { return trim($description); } $summary = (string)$page->summary(300, true); $summary = trim(preg_replace('/\s+/', ' ', html_entity_decode(strip_tags($summary), ENT_QUOTES | ENT_HTML5)) ?? ''); return $summary; } /** * Turn root-relative `href` and `src` attributes into absolute URLs so an * agent can follow them from wherever it stored the document. * * @param string $html * @return string */ protected function absoluteUrls(string $html): string { /** @var Uri $uri */ $uri = $this->grav['uri']; $base = rtrim((string)$uri->base(), '/'); if ($base === '') { return $html; } return preg_replace('/\b(href|src)=(["\'])\/(?!\/)/i', '$1=$2' . $base . '/', $html) ?? $html; } /** * Apply a text transform to everything except fenced code blocks, whose * whitespace is content. * * @param string $markdown * @param callable $transform * @return string */ protected function outsideFences(string $markdown, callable $transform): string { $chunks = preg_split('/(^[ \t]*(?:```|~~~)[^\n]*\n.*?^[ \t]*(?:```|~~~)[ \t]*$)/ms', $markdown, -1, PREG_SPLIT_DELIM_CAPTURE); if (!is_array($chunks)) { return $transform($markdown); } foreach ($chunks as $i => $chunk) { // Odd offsets are the captured fences. if ($i % 2 === 0) { $chunks[$i] = $transform($chunk); } } return implode('', $chunks); } /** * @return HtmlConverter */ protected function converter(): HtmlConverter { if ($this->converter === null) { $this->converter = new HtmlConverter([ 'header_style' => 'atx', 'strip_tags' => true, 'hard_break' => true, 'suppress_errors' => true, 'preserve_comments' => false, 'strip_placeholder_links' => true, 'remove_nodes' => 'script style noscript template form button input select textarea iframe svg canvas video audio object embed', ]); $this->converter->getEnvironment()->addConverter(new TableConverter()); $this->converter->getEnvironment()->addConverter(new PlainTextConverter()); } return $this->converter; } /** * @param string $name * @param mixed $default * @return mixed */ protected function option(string $name, $default = null) { return $this->grav['config']->get('system.pages.markdown_output.' . $name, $default); } }