README

此小部件适用于 yii2 框架。这是 Highlight.js JavaScript 插件的包装器。

如果您将代码作为网站内容的一部分发布，那么使用此小部件，您的代码将看起来更时尚。

以下图片展示了代码在网站页面上的显示示例。

'Xcode' 主题。

安装

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

运行

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

或在您的 composer.json 文件的 require 部分中添加

"coderius/yii2-highlight-js": "*"

。

使用方法

扩展安装完成后，只需在代码中通过以下方式使用它：

<?php coderius\yii2_highlight_js\HighlightWidget::begin();?>

<?= $content ?>

<?php coderius\yii2_highlight_js\HighlightWidget::end(); ?>

需要使用插件规范化的某些代码必须放在以下块中：

<pre>
...some code
</pre>

如果您需要更改代码块的样式，您可以以这种方式附加您的样式。

<?php coderius\yii2_highlight_js\HighlightWidget::begin(
            [
                'customAsset' => \coderius\yii2_highlight_js\CustomExampleAsset::register($this),

            ]
        ); 
?>

<?= $content ?>

<?php coderius\yii2_highlight_js\HighlightWidget::end(); ?>

在这个例子中，我创建了自己的资产（例如 codev\yii2_highlight_js\NumLineAsset::className()），它包含更改 HighlightWidget 样式的样式和脚本路径。

高级示例

<?php HighlightWidget::begin([
    'theme' => 'Xcode',
    'customAsset' => \coderius\yii2_highlight_js\CustomExampleAsset::register($this),
    'css' => "pre{font-style: italic;}"//any string style css 
    'js' => "alert('ok');",
    'positionJs' => yii\web\View::POS_END,//default value is yii\web\View::POS_READY
]); ?>


    <?= $article->text; ?>


           
<?php HighlightWidget::end(); ?>

在这个例子中，我将主题名称设置为 "Xcode"。但默认主题是 "Default"。

主题列表

• 默认
• Agate
• Androidstudio
• Arduino Light
• Arta
• Ascetic
• Atelier Cave Dark
• Atelier Cave Light
• Atelier Dune Dark
• Atelier Dune Light
• Atelier Estuary Dark
• Atelier Estuary Light
• Atelier Forest Dark
• Atelier Forest Light
• Atelier Heath Dark
• Atelier Heath Light
• Atelier Lakeside Dark
• Atelier Lakeside Light
• Atelier Plateau Dark
• Atelier Plateau Light
• Atelier Savanna Dark
• Atelier Savanna Light
• Atelier Seaside Dark
• Atelier Seaside Light
• Atelier Sulphurpool Dark
• Atelier Sulphurpool Light
• Atom One Dark
• Atom One Light
• Brown Paper
• Codepen Embed
• Color Brewer
• Darcula
• Dark
• Darkula
• Docco
• Dracula
• Far
• Foundation
• Github Gist
• Github
• Googlecode
• Grayscale
• Gruvbox Dark
• Gruvbox Light
• Hopscotch
• Hybrid
• Idea
• Ir Black
• Kimbie Dark
• Kimbie Light
• Magula
• Mono Blue
• Monokai Sublime
• Monokai
• Obsidian
• Ocean
• Paraiso Dark
• Paraiso Light
• Pojoaque
• Purebasic
• Qtcreator Dark
• Qtcreator Light
• Railscasts
• Rainbow
• Routeros
• School Book
• Solarized Dark
• Solarized Light
• Sunburst
• Tomorrow Night Blue
• Tomorrow Night Bright
• Tomorrow Night Eighties
• Tomorrow Night
• Tomorrow
• Vs
• Vs 2015
• Xcode
• Xt 256
• Zenburn

许可

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

此 yii2 扩展小部件是插件 highlight_js 的包装器 https://github.com/isagalaev/highlight.js