Service Usage

Basic Injection

Inject the converter interface:

use MarkupCarve\LaravelCarve\Service\CarveConverterInterface;

class ArticleController extends Controller
{
    public function __construct(
        private CarveConverterInterface $carve,
    ) {}

    public function show(Article $article): View
    {
        $html = $this->carve->toHtml($article->body);
        $plainText = $this->carve->toText($article->body);

        return view('article.show', [
            'article' => $article,
            'bodyHtml' => $html,
            'bodyText' => $plainText,
        ]);
    }
}

Available Methods

toHtml(string $carve): string

Converts Carve markup to HTML.

$html = $this->carve->toHtml('*Hello* /world/!');
// <p><strong>Hello</strong> <em>world</em>!</p>

toText(string $carve): string

Converts Carve markup to plain text.

$text = $this->carve->toText('*Hello* /world/!');
// Hello world!

toMarkdown(string $carve): string

Renders Carve markup as Markdown - useful for export or interop with Markdown-only consumers.

$markdown = $this->carve->toMarkdown('*Hello* /world/!');
// **Hello** *world*!

toAnsi(string $carve): string

Renders Carve markup as ANSI terminal output - useful in Artisan commands.

$this->line($this->carve->toAnsi($changelogEntry));

parse(string $carve): Document

Parses Carve markup into an AST (Abstract Syntax Tree). Useful for advanced manipulation.

use MarkupCarve\Carve\Node\Document;

$document = $this->carve->parse('# Heading');

Using Multiple Profiles

Inject the CarveManager to access all registered profiles:

use MarkupCarve\LaravelCarve\Service\CarveManager;

class CommentService
{
    public function __construct(
        private CarveManager $carve,
    ) {}

    public function renderUserComment(string $text): string
    {
        return $this->carve->toHtml($text); // default profile (safe mode)
    }

    public function renderAdminContent(string $text): string
    {
        return $this->carve->toHtml($text, 'trusted');
    }

    public function renderTrustedInline(string $text): string
    {
        return $this->carve->toHtmlRaw($text);
    }
}

You can also grab a specific converter directly:

$docsConverter = $this->carve->converter('docs');
$html = $docsConverter->toHtml($content);

Use Cases

Notifications / Mail

use MarkupCarve\LaravelCarve\Service\CarveConverterInterface;

class NewsletterMail extends Mailable
{
    public function __construct(private string $carveBody)
    {
    }

    public function build(CarveConverterInterface $carve): self
    {
        return $this->html($carve->toHtml($this->carveBody))
            ->text($carve->toText($this->carveBody));
    }
}

Search Indexing

class SearchIndexer
{
    public function __construct(
        private CarveConverterInterface $carve,
    ) {}

    /**
     * @return array<string, mixed>
     */
    public function indexArticle(Article $article): array
    {
        return [
            'id' => $article->id,
            'title' => $article->title,
            'content' => $this->carve->toText($article->body),
            'html' => $this->carve->toHtml($article->body),
        ];
    }
}

API Response

public function show(Article $article): JsonResponse
{
    return response()->json([
        'id' => $article->id,
        'title' => $article->title,
        'body_raw' => $article->body,
        'body_html' => $this->carve->toHtml($article->body),
        'body_text' => $this->carve->toText($article->body),
    ]);
}

Next Steps

• Configuration — set up multiple profiles
• Safe Mode — protect against XSS