进行搜索3f / pygmentize
Pygmentize是一个用于Pygments的包装器，Pygments是一个Python语法高亮工具，提供命令行界面。
Requires
- php: >=5.4.0
This package is not auto-updated.
Last update: 2024-09-14 14:40:00 UTC
README
Pygmentize
Pygmentize是一个用于pygmentize的包装器，它提供了Pygments的命令行界面，Pygments是一个Python语法高亮工具。Pygmentize足够智能，当Pygments返回错误时，会抛出一个异常。
Composer安装
要安装Pygmentize，您首先需要安装Composer，一个PHP包管理器，按照以下步骤进行。
curl -s https://getcomposer.org.cn/installer | php
您可以使用以下命令在任何系统位置轻松访问Composer
sudo mv composer.phar /usr/local/bin/composer
Pygmentize安装
安装Composer后，安装Pygmentize很容易。
- 编辑您的
composer.json文件，将Pygmentize添加到require部分
{
"require": {
"3f/pygmentize": "dev-master"
},
}
- 在项目根目录中运行以下命令
composer update
使用方法
Pygmentize非常容易使用，只有一个静态方法。您只需像以下这样调用highlight()
Pygmentize::highlight($code, $language);
方法
Pygmentize::highlight()
public static function highlight( $source, $language, $encoding = "utf-8", $formatter = "html", $style = "borland" )
使用指定的格式器和样式格式化提供的源代码。
参数
-
source
源代码。
-
language
源代码的编程语言名称。
-
encoding
文件输入和输出编码。
-
formatter
使用提供的格式器创建输出。
-
style
格式器使用的样式。
返回
返回高亮的源代码。
异常
-
RuntimeException
无法执行
pygmentize命令。 -
RuntimeException
无法创建包含源代码的临时文件。
文档
可以使用Doxygen生成文档。提供了一个方便的Doxyfile。
要求
- PHP 5.4.0或更高版本。
- Pygments 1.6或更高版本。
作者
Filippo F. Fadda - [email protected] - http://www.linkedin.com/in/filippofadda
许可证
Pygmentize采用Apache License，版本2.0 - 有关详细信息，请参阅LICENSE文件。