README

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一：

php composer.phar require --prefer-dist nezhelskoy/yii2-highlight "*"

或者将以下内容添加到您的 composer.json 文件的 require 部分。

"nezhelskoy/yii2-highlight": "*"

到您的 composer.json 文件的要求部分。

用法

在您的视图脚本中注册资源

nezhelskoy\highlight\HighlightAsset::register($this);

并按照原始的 highlight.js 文档 描述管理内容

<pre><code class="html">...</code></pre>

您可以在配置文件中覆盖样式，例如 config/web.php

    'components' => [
        ...
        'assetManager' => [
            'bundles' => [
                'nezhelskoy\highlight\HighlightAsset' => [
                    'css' => ['dist/styles/zenburn.css'],
                ],
            ]
        ],
        ...
    ],

自定义 selector 或 options 属性的配置示例

    'components' => [
        ...
        'assetManager' => [
            'bundles' => [
                'nezhelskoy\highlight\HighlightAsset' => [
                    'selector' => '.is-highlighted',
                    'options' => [
                        'classPrefix' => 'custom-',
                        'useBR' => true,
                    ],
                    'css' => ['dist/styles/zenburn.css'],
                ],
            ]
        ],
        ...
    ],

使用位于 /js/highlight 中的自定义构建，例如

    'components' => [
        ...
        'assetManager' => [
            'bundles' => [
                'nezhelskoy\highlight\HighlightAsset' => [
                    'sourcePath' => null,
                    'css' => ['/js/highlight/styles/zenburn.css'],
                    'js' => ['/js/highlight/highlight.pack.js'],
                ],
            ]
        ],
        ...
    ],

许可

yii2-highlight 在 BSD 许可下发布。有关详细信息，请参阅 LICENSE.md 文件。

链接

Highlight.js 库的官方网站是 https://highlightjs.org/。