s1syphos / kirby3-highlight
此包已废弃,不再维护。未建议替代包。
为 Kirby v3 提供主题化的服务器端语法高亮
1.0.0
2019-03-18 18:09 UTC
Requires
- getkirby/composer-installer: ^1.1
- scrivo/highlight.php: ^9.15
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.14
This package is auto-updated.
Last update: 2021-12-19 04:00:45 UTC
README
此插件可以在服务器端高亮代码片段 - 无需外部依赖。
目录
入门
使用以下方法之一安装和使用 kirby3-highlight
Git 子模块
如果您熟悉 Git,您可以将其作为子模块下载此插件
git submodule add https://github.com/S1SYPHOS/kirby3-highlight.git site/plugins/kirby-highlight
Composer
composer require s1syphos/kirby3-highlight
克隆或下载
现在已为您的代码片段添加了正确的类,使其可主题化。为此,请转到样式部分。
配置
更改 kirby-highlight
选项以满足您的需求
选项 | 类型 | 默认 | 描述 |
---|---|---|---|
s1syphos.highlight.class |
字符串 | 'hljs' |
为前面的 pre 元素添加一个或多个类。 |
s1syphos.highlight.languages |
数组 | ['html', 'php'] |
定义要自动检测的语言(目前支持 176 种语言)。 |
s1syphos.highlight.escaping |
布尔值 | false |
启用字符转义(将 < 转换为 < ,将 > 转换为 > 等),请参阅 htmlspecialchars() 文档。 |
样式
所有 highlight.js
样式都与 kirby3-highlight
完全兼容。只需使用 css()
助手 包含它即可。
<?= css('/media/plugins/s1syphos/highlight/css/zenburn.css') ?>
故障排除
如果不确定,请检查相关语言的正确拼写 - 否则可能会破坏 kirbytext()
。
致谢 / 许可证
kirby3-highlight
基于 Geert Bergman 的 highlight.php
库(highlight.js 的 PHP 版本)。它采用 MIT 许可证,但 在生产环境中使用 Kirby 需要您 购买许可证。
特别感谢
我想感谢所有正在制作优秀软件的人们——你们真是太棒了。此外,我始终对反馈和错误报告表示感谢 :)