esit / enlighter

此 Contao 开源 CMS 扩展程序绑定了 Enlighter.js 脚本,并允许以清晰的方式展示源代码。与内置的 highlight.js 相比,Enlighter.js 提供了行号、行高亮、复制源代码、多种主题等功能。高亮显示将全局应用于该页面上所有的代码标签。详细信息请参阅下面的 配置

安装: 24

依赖: 0

建议: 0

安全: 0

星级: 0

观察者: 1

分支: 0

开放问题: 0

语言:JavaScript

类型:contao-bundle

2.0.3 2023-03-28 06:20 UTC

This package is auto-updated.

Last update: 2024-09-28 09:33:57 UTC


README

描述

此 Contao 开源 CMS 扩展程序绑定了 Enlighter.js 脚本,并允许以清晰的方式展示源代码。与内置的 highlight.js 相比,Enlighter.js 提供了行号、行高亮、复制源代码、多种主题等功能。高亮显示将全局应用于该页面上所有的代码标签。详细信息请参阅下面的 配置

作者

e@sy Solutions IT: Patrick Froch info@easySolutionsIT.de

许可证

该软件在 LGPL 许可下发布。详细信息请参阅 LICENSE 文件。

要求

  • php: ~8.0
  • contao/core-bundle: ~4.9|^5.1

安装

在 Contao Manager 中搜索 esit/enlighter 并安装。

配置

1. 创建模块

为了让语法高亮显示正常工作,需要在“主题”>“模块”中创建一个类型为“Enlighter.js”的模块。在这里可以设置语法高亮显示的设置。

具体来说包括

  • 主题
  • 缩进
  • 鼠标悬停时突出显示行。
  • 显示行号
  • 是否应折行过长的行,或者是否应水平滚动。

2. 绑定模块

现在需要将模块绑定到所需的页面布局中。由于该模块不生成输出,因此绑定位置原则上无关紧要。它将仅绑定到相应的位置(CSS 在头部,JS 在页脚)的脚本。

在相应的页面布局中不得启用 Contao 提供的 highlight.js

高亮显示将全局应用于该页面上所有的代码标签。如果只想在特定页面上应用,则需要使用多个页面布局。如果不想突出显示单个块,则可以不指定语言。这些块将被忽略。

3. 输入代码

高亮显示与内容元素“代码”、Markdown 文本中的代码块以及页面上的所有其他代码标签(作为 CSS 类包含支持的任何一种语言)兼容。这也是为什么在内容元素“代码”中必须选择语法高亮显示的语言的原因。