getherbie / plugin-highlightjs
Herbie 的语法高亮插件
v1.0.0
2016-04-05 15:01 UTC
Requires
- getherbie/herbie: ^1.0.0
This package is auto-updated.
Last update: 2024-09-28 22:34:05 UTC
README
HighlightJS
是一个 Herbie 插件,可以将基于 JavaScript 的代码语法高亮器 Highlight.js 集成到您的网站中。Highlight.js 提供以下功能
- 130 种语言和 65 种样式
- 自动语言识别
- 与任何标记一起使用
- 与任何 JS 框架兼容
- 多语言代码高亮
安装
您可以通过 Composer 安装此插件。
$ composer require getherbie/plugin-highlightjs
然后,在配置文件中激活此插件。
plugins:
enable:
- highlightjs
配置
在 plugins.config.highlightjs
下,您有以下选项可用
# Folder with highlight.js stylesheets. If false, no styles are added.
stylesheets: "@plugin/highlightjs/assets/styles/"
# Highlight.js javascript. If false, no styles are added.
javascript: "@plugin/highlightjs/assets/highlight.pack.js"
# The initializer javascript with pure vanilla-javascript.
javascript_init: "@plugin/highlightjs/assets/highlightjs.js"
# The HTML markup
html: "<pre><code class="{class}">{content}</code></pre>"
# The highlight.js theme.
style: default
应用
该插件提供了 [code] 短代码,您可以在页面内容中使用它。唯一参数是编程语言
[code javascript]
alert("Hello Herbie!");
[/code]
[code php]
echo "Hello Herbie!";
[/code]
支持的语言
Herbie 的 Highlight.js 包支持以下语言
Apache, Bash, C#, C++, CSS, CoffeeScript, Diff, HTML, XML, HTTP, Ini, JSON, Java, JavaScript, Makefile, Markdown, Nginx, Objective C, PHP, Perl, Python, Ruby, SQL, Twig
但您可以使用许多其他语言。您可以在此处创建自己的包 https://highlightjs.org/download/。然后必须调整插件配置。
示例:如果您将文件存放在 site/assets/default
目录中,则配置可能如下所示
stylesheets: "@site/assets/default/highlightjs/styles/"
javascript: "@site/assets/default/highlightjs/highlight.pack.js"