Skip to content

Commit 084b528

Browse files
committed
docs: update README with custom theme details and add inspector section
1 parent 986ded6 commit 084b528

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Please ensure that your Magento installation meets this requirement before insta
2525
| 🔄 Hyvä Fallback | ✅ Fully Supported |
2626
| 🎨 Custom TailwindCSS (no Hyvä) | ✅ Fully Supported |
2727
| 💼 Avanta B2B | ✅ Fully Supported |
28-
| 🥰 Your Custom Theme | [Create your own Builder](./docs/custom_theme_builders.md) |
28+
| 🥰 Your Custom Theme (`css`, `sass`, `less`, ... ) | [Create your own Builder](./docs/custom_theme_builders.md) |
2929

3030
---
3131

@@ -43,8 +43,6 @@ Please ensure that your Magento installation meets this requirement before insta
4343
| `mageforge:system:version` | Shows current and latest version of the module | `system:version` |
4444
| `mageforge:system:check` | Get system information (OS, PHP, Database, Node.js, etc.) | `system:check` |
4545

46-
---
47-
4846
## Getting Started
4947

5048
### Installation
@@ -93,6 +91,43 @@ Please ensure that your Magento installation meets this requirement before insta
9391

9492
5. Enjoy automatic CSS rebuilding as you work on your theme files!
9593

94+
---
95+
96+
### Frontend Inspector 🕵️
97+
98+
The **MageForge Inspector** is a powerful developer tool that allows you to inspect Magento blocks, templates, and performance metrics directly in your browser.
99+
100+
**Key Features:**
101+
- **Structure Analysis**: View template paths, block classes, and module names for any element.
102+
- **Performance Metrics**: See PHP render times and cache status (lifetime, tags).
103+
- **Web Vitals**: Monitor LCP, CLS, and INP metrics per element.
104+
- **Accessibility Checks**: Inspect ARIA roles, contrast ratios, and alt text.
105+
106+
**How to use:**
107+
108+
1. **Enable the Inspector in the CLI**:
109+
```bash
110+
bin/magento mageforge:theme:inspector enable
111+
```
112+
*(Note: Requires Magento Developer Mode)*
113+
114+
115+
2. **Enable the Inspector in Magento Admin Settings**
116+
You can activate the Inspector in Magento Admin under `Stores > Configuration > MageForge > Frontend Inspector`.
117+
118+
3. **Usage in Browser**:
119+
- **Toggle**: Press `Ctrl+Shift+I` (Windows/Linux) or `Cmd+Option+I` (macOS).
120+
- **Inspect**: Hover over elements to see details. Click to lock the inspector on a specific block.
121+
122+
To disable the inspector:
123+
```bash
124+
bin/magento mageforge:theme:inspector disable
125+
```
126+
127+
128+
129+
---
130+
96131
## Additional Documentation
97132

98133
- [Advanced Usage Guide](./docs/advanced_usage.md) - Tips, tricks and troubleshooting

0 commit comments

Comments
 (0)