README

Highlight.js 是一个用 JavaScript 编写的语法高亮工具。它可以在浏览器和服务器上运行。它可以与几乎任何标记语言一起使用，不依赖于任何框架，并且具有自动语言检测功能。

入门指南

在网页上使用 highlight.js 的最低要求是链接到库以及其中一个样式，并调用 initHighlightingOnLoad

<link rel="stylesheet" href="/path/to/styles/default.css">
<script src="/path/to/highlight.pack.js"></script>
<script>hljs.initHighlightingOnLoad();</script>

这将找到并突出显示 <pre><code> 标签内的代码；它试图自动检测语言。如果自动检测不适用于您，您可以在 class 属性中指定语言

<pre><code class="html">...</code></pre>

支持的类列表可以在 类参考 中找到。类也可以用 language- 或 lang- 前缀。

要完全禁用突出显示，请使用 nohighlight 类

<pre><code class="nohighlight">...</code></pre>

自定义初始化

当您需要对 highlight.js 的初始化有更多控制时，您可以使用 highlightBlock 和 configure 函数。这允许您控制要突出显示的内容和时机。

以下是如何使用 jQuery 调用 initHighlightingOnLoad 的等效方式

$(document).ready(function() {
  $('pre code').each(function(i, block) {
    hljs.highlightBlock(block);
  });
});

您可以使用任何标签来标记代码，而不是 <pre><code>。如果您不使用保留换行符的容器，则需要配置 highlight.js 以使用 <br> 标签

hljs.configure({useBR: true});

$('div.code').each(function(i, block) {
  hljs.highlightBlock(block);
});

有关其他选项，请参阅 configure 的文档。

获取库

您可以将 highlight.js 作为托管、自定义构建的浏览器脚本或作为服务器模块获取。浏览器脚本直接支持 AMD 和 CommonJS，因此如果您愿意，您可以使用 RequireJS 或 Browserify 而不必从源代码构建。服务器模块也与 Browserify 完美配合使用，但您可以选择使用针对浏览器而不是针对服务器的特定构建。请访问 下载页面 了解所有选项。

注意：该库不应直接从 GitHub 的源代码运行；它需要构建。如果您所有预包装的选项都不适用，请参阅 构建文档。

许可

Highlight.js 在 BSD 许可证下发布。有关详细信息，请参阅 LICENSE 文件。

链接

该库的官方网站是 https://highlightjs.org/。

有关 API 和其他主题的更深入文档，请参阅 http://highlightjs.readthedocs.org/。

作者和贡献者列在 AUTHORS.en.txt 文件中。