Laravel Packages

Add Debug Comments to Your Rendered Blade Templates

Published
Add Debug Comments to Your Rendered Blade Templates image

With the Laravel Blade Comments package by Spatie, you can add debug comments to your rendered Blade template output:

When looking at the HTML of a rendered page, it might not be obvious to you anymore which Blade view is responsible for which HTML. This package will add HTML before and after each rendered view, so you immediately know to which Blade view/component to go to change the output.

Given the following simple blade template, you will find useful information like which view, route, layout, and files are used to render the page:

@extends('app')
 
@section('body')
<h1>Hello, World!</h1>
@include('example')
@endsection

Given the above simple template, the output might look like the following for an invokable controller rendering a view called hello-world:

<!-- View: hello-world -->
<!-- Route: App\Http\Controllers\HelloWorldController (hello-world) -->
<!-- View extends: app -->
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Hello World</title>
</head>
<body>
<!-- Start section: body -->
<h1>Hello, World!</h1>
<!-- Start include: example -->
<p>This is an example include file.</p>
<!-- End include: example -->
<!-- End section: body -->
</body>
</html>

To use this package, you can check it out at spatie/laravel-blade-comments on GitHub. Freek also wrote about this package, sharing some valuable tips along the way, including the Blade precompiler method.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Sponsored

acquaintsoft logo
Acquaint Softtech

Hire Laravel developers with AI expertise at $20/hr. Get started in 48 hours.

Visit Acquaint Softtech

The latest

View all →
What We Know About Laravel 14 image

What We Know About Laravel 14

Read article
Difflock: Lint Laravel Migrations and Diff Your Schema image

Difflock: Lint Laravel Migrations and Diff Your Schema

Read article
Fresh Package: Laravel Package Skeleton with Testbench, CI, and Boost Integration image

Fresh Package: Laravel Package Skeleton with Testbench, CI, and Boost Integration

Read article
Inertia DevTools Now Available for Firefox image

Inertia DevTools Now Available for Firefox

Read article
Laravel Scalpel Scans for Filesystem Intrusion Evidence image

Laravel Scalpel Scans for Filesystem Intrusion Evidence

Read article
Mercure Broadcasting in Laravel 13.32 image

Mercure Broadcasting in Laravel 13.32

Read article