s1syphos/kirby-highlight

该软件包已被废弃，不再维护。未建议替代软件包。

为 Kirby 提供主题化服务器端语法高亮

维护者

详细信息

github.com/S1SYPHOS/kirby-highlight

源代码

问题

安装: 14

依赖项: 0

建议者: 0

安全: 0

星标: 14

关注者: 2

分叉: 0

开放问题: 1

语言:CSS

类型:kirby 插件

0.6.1 2019-03-25 10:46 UTC

Requires

MIT 7d2bf2020e1d5647c2f0cd1b86d7549b1d3e94ae

This package is auto-updated.

Last update: 2021-12-25 19:10:37 UTC

README

Release License Issues

此插件在服务器端突出显示您的代码片段 - 无需外部依赖。

  • 为所有人提供代码高亮 - 无需 JavaScript
  • 全面：支持 176 种语言
  • 可定制：包括 79 种不同的样式

screenshot of the kirby-highlight plugin

目录

入门

使用以下方法之一安装和使用 kirby-highlight

Git 子模块

如果您熟悉 Git，可以将此插件作为 子模块 下载

git submodule add https://github.com/S1SYPHOS/kirby-highlight.git site/plugins/kirby-highlight

Composer

composer require S1SYPHOS/kirby-highlight:dev-composer

克隆或下载

  1. 克隆 或 下载 此存储库。
  2. 解压缩 / 将文件夹移动到 site/plugins。

激活插件

在您的 config.php 中使用以下行来激活插件

c::set('plugin.kirby-highlight', true);

现在已为您代码片段添加了适当的类，使其具有 '可主题化' 的功能。要这样做，请转到 样式 部分。如果您只想在特定域上激活 kirby-highlight，请阅读有关 多环境设置 的信息。

配置

更改 kirby-highlight 选项以满足您的需求

选项 类型 默认值 描述
plugin.kirby-highlight.class 字符串 'hljs' 设置围绕 pre 容器的类。
plugin.kirby-highlight.languages 数组 ['html', 'php'] 定义要自动检测的语言（目前支持 176 种语言）。
plugin.kirby-highlight.escaping 布尔值 false 启用字符转义（将 < 转换为 &lt;，将 > 转换为 &gt; 等），请参阅 htmlspecialchars() 文档。

样式

所有 highlight.js 样式都与 kirby-highlight 完全兼容。只需使用 css() 辅助程序 包含它即可。

<?php echo css('assets/plugins/kirby-highlight/css/zenburn.css') ?>

故障排除

如有疑问，请检查相关语言的正确拼写——否则将破坏 kirbytext() 的功能（见 #2）。

致谢 / 许可证

kirby-highlight 基于 Geert Bergman 的 highlight.php 库（highlight.js 的 PHP 版本）。它采用 MIT 许可证，但在生产环境中使用 Kirby 需要购买许可证。你准备好进入下一步了吗？（下一步）

特别感谢

我想感谢所有正在制作优秀软件的人们——你们真是太棒了。另外，我总是感激大家的反馈和错误报告：）