README

此模块向生成的页面输出中添加布局处理和模板提示作为 HTML 注释。

它可以被前端开发者用来快速定位当前查看页面的容器、块或 UI 元素。

安装

安装模块

您可以通过 composer 安装 Magento 2 提示模块。

首先，通过 HTTP 协议访问仓库

php composer.phar config repositories.foo vcs https://github.com/aleron75/mage2hints.git

或通过 SSH 协议访问

php composer.phar config repositories.foo vcs git@github.com:aleron75/mage2hints.git

然后添加依赖

php composer.phar require aleron75/mage2hints:~1.0

或者，您也可以手动在您的 composer.json 文件中添加依赖。

通过 HTTPS 协议访问

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/aleron75/mage2hints.git"
        }
    ],
    "require": {
        "aleron75/mage2hints": "~1.0"
    }
}

通过 SSH 协议访问

{
    "repositories": [
        {
            "type": "vcs",
            "url": "git@github.com:aleron75/mage2hints.git"
        }
    ],
    "require": {
        "aleron75/mage2hints": "~1.0"
    }
}

添加模块依赖后，从项目根目录运行以下命令

composer update

启用模块

在 composer update 完成更新依赖后，从项目根目录运行以下命令

bin/magento module:enable Aleron75_Mage2Hints
bin/magento setup:upgrade

如果您处于生产模式，您还需要通过以下命令生成 DI 配置以及所有不存在的拦截器和工厂

bin/magento setup:di:compile

使用方法

要将布局处理和模板提示添加到页面作为 HTML 注释，只需在 URL 中添加一个 html 参数，如下所示

http://magento2.local/?hints=true

然后您可以检查您的 HTML 源代码，并期望看到如下内容

<body ...>
<!-- [LAYOUT_HANDLES] default - cms_index_index - cms_page_view - cms_index_index_id_home [/LAYOUT_HANDLES] -->
<!-- [CONTAINER  name="root"] -->
<!-- [CONTAINER  name="after.body.start" alias="after.body.start" parent_name="root"] -->
<!-- [BLOCK  name="googleoptimizer.experiment.script" alias="googleoptimizer.experiment.script" parent_name="after.body.start" type="Magento\GoogleOptimizer\Block\Code\Page" template_path=""] -->
...    
<!-- [/CONTAINER name="root"] -->
</body>

aleron75 / mage2hints

维护者

详细信息

README

安装

安装模块

启用模块

使用方法