Maven 站点插件 - 代码语法突出显示

问题描述 投票:0回答:1

我正在使用 Maven 站点插件和 MarkDown 页面作为我的项目文档

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-site-plugin</artifactId>
                <version>3.9.0</version>
            </plugin>

但是这个插件不提供代码语法高亮功能,例如:

```java
int a =

代码语法突出显示是本论坛或 GitHub 上 Markdown 页面的标准。

如何将此功能也添加到我的 Maven 项目中?

maven markdown
1个回答
0
投票

我尝试自己回答这个问题。 正如 khmarbaise 提到的,应该使用最新的 Maven 插件。

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-site-plugin</artifactId>
    <version>3.12.1</version>
</plugin>

maven站点插件默认不支持高亮功能。但您可以使用 highlightjs 项目。这是一个 Java 脚本库,它解析 HTML 代码中的

<pre>
标签,并将大量样式表动态应用到代码中。

您唯一需要使用它的就是将

highlight.min.js
和主题 .css 文件之一添加到您的布局中。

如果您使用

site.vm
模板,则highlightjs粘合代码应如下所示:

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    ....
    <style type="text/css" media="all">
    @import url("$relativePath/highlight/default.css");
    </style>
    <script src="${relativePath}/highlight/highlight.min.js"></script>
    <script>hljs.highlightAll();</script>
   ...
  </head>

highlightjs 项目提供了很多不同的样式表,您可以在演示页面上测试布局。

© www.soinside.com 2019 - 2024. All rights reserved.