https://github.com/nystudio107/craft-templatecomments

Adds a HTML comment with performance timings to demarcate `{% block %}`s and each Twig template that is included or extended.
https://github.com/nystudio107/craft-templatecomments

craft-plugin craftcms debugging twig-comments

Last synced: 5 months ago
JSON representation

Adds a HTML comment with performance timings to demarcate `{% block %}`s and each Twig template that is included or extended.

• Host: GitHub
• URL: https://github.com/nystudio107/craft-templatecomments
• Owner: nystudio107
• License: mit
• Created: 2018-10-02T15:28:42.000Z (over 7 years ago)
• Default Branch: develop-v5
• Last Pushed: 2026-01-29T21:44:26.000Z (5 months ago)
• Last Synced: 2026-01-30T09:45:02.858Z (5 months ago)
• Topics: craft-plugin, craftcms, debugging, twig-comments
• Language: PHP
• Homepage: https://nystudio107.com/
• Size: 1.41 MB
• Stars: 20
• Watchers: 1
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/badges/quality-score.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/?branch=v5) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/badges/coverage.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/?branch=v5) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/badges/build.png?b=v5)](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/build-status/v5) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-templatecomments/badges/code-intelligence.svg?b=v5)](https://scrutinizer-ci.com/code-intelligence)

# Template Comments plugin for Craft CMS 5.x

Adds a HTML comment with performance timings to demarcate `{% block %}`s and each Twig template that is included or extended.

![Screenshot](./docs/docs/resources/img/plugin-logo.png)

## Requirements

This plugin requires Craft CMS 5.0.0 or later.

## Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

        cd /path/to/project

2. Then tell Composer to load the plugin:

        composer require nystudio107/craft-templatecomments

3. Install the plugin via `./craft install/plugin templatecomments` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Template Comments.

You can also install Template Comments via the **Plugin Store** in the Craft Control Panel.

## Documentation

Click here -> [Template Comments Documentation](https://nystudio107.com/plugins/template-comments/documentation)

## Template Comments Roadmap

Some things to do, and ideas for potential features:

* Support wrapping macros in comments

Brought to you by [nystudio107](https://nystudio107.com/)