ifdattic/eprism

添加 Prism 语法高亮器的 Yii 扩展

维护者

详细信息

github.com/ifdattic/EPrism

主页

源代码

问题

安装: 8

依赖者: 0

建议者: 0

安全: 0

星标: 3

关注者: 2

分支: 0

开放问题: 0

语言:CSS

类型:yii-extension

dev-master 2014-01-02 16:04 UTC

Requires

MIT c8268ee3a4c3a6554f9e0476f541376c3476221f

extensionsyntaxhighlighteryiiprism

This package is not auto-updated.

Last update: 2024-09-24 02:44:03 UTC

README

EPrism 是一个 Yii 框架的扩展。此扩展是 Prism（由 Lea Verou 提供）的包装。 Prism 是一个轻量级、可扩展的语法高亮器，基于现代网络标准构建。此扩展使用 widget() 方法添加了这个出色的语法高亮器。

要求

  • Yii 1.1 或更高版本（在 1.1.14 上测试过）

安装

Composer

EPrism 可以使用 [Composer][composer-link] 安装。

运行以下命令

php composer.phar require ifdattic/eprism "dev-master"

或者确保你在 composer.json 文件中有以下代码

{
    "require": {
        "ifdattic/eprism": "dev-master"
    }
}

手动安装

下载扩展的最新版本，解压缩并将其放置在项目（extensions 目录或你选择的任何目录）。只需确保调整加载路径。

用法

将以下代码放置在视图文件中

<?php $this->widget('vendor.ifdattic.eprism.EPrism'); ?>

默认选项可以通过发送数组作为第二个参数来更改

<?php $this->widget(
    'vendor.ifdattic.eprism.EPrism',
    [
        // Default values for properties
        'manualHighlight' => false,
        'scriptPosition' => null,
        'cssFile' => null,
        'scriptFile' => null,
    ]
); ?>

选项说明

  • 手动高亮 - 禁用自动高亮的标志。如果禁用自动高亮，则必须手动使用 JavaScript 启动高亮。
  • 脚本位置 - 脚本的位置（registerScriptFile() 方法文档）
  • CSS 文件 - 语法高亮器使用的 CSS 文件。可用选项
    • false - 不会注册 CSS 文件。
    • null - 将注册默认 CSS 文件。
    • string - 将注册定义的文件。
  • 脚本文件 - 语法高亮器使用的 JS 文件。可用选项
    • false - 不会注册 JS 文件。
    • null - 将注册默认 JS 文件。
    • string - 将注册定义的文件。

以下是一个使用不同值扩展的示例

<?php $this->widget(
    'vendor.ifdattic.eprism.EPrism',
    [
        // Only values you want to change need to be sent
        'manualHighlight' => true,
        'scriptPosition' => CClientScript::POS_END,
        'cssFile' => 'prism/prism.css',
        'scriptFile' => false,
    ]
); ?>

资源

备注

  • 为了方便，扩展包含 CSS 和 JS 资产，但你可能需要 生成 这些文件以满足自己的需求并将它们包含在项目中。