我目前正在开始为我们的一个项目编写文档。为简单起见,我们选择使用几乎纯文本 (APT) 格式,请在此处查看更多信息: http ://maven.apache.org/doxia/references/apt-format.html
APT 是一种很好的文档格式,因为它使用最少的语法,因此在不了解 APT 的情况下很容易创建和更改文档。
但是,我找不到以一种好的方式格式化代码的方法。是否有代码标签或类似的东西,可以用来包含一些源代码?我知道我可以使用 FML,但这不太理想。
谢谢
我目前正在开始为我们的一个项目编写文档。为简单起见,我们选择使用几乎纯文本 (APT) 格式,请在此处查看更多信息: http ://maven.apache.org/doxia/references/apt-format.html
APT 是一种很好的文档格式,因为它使用最少的语法,因此在不了解 APT 的情况下很容易创建和更改文档。
但是,我找不到以一种好的方式格式化代码的方法。是否有代码标签或类似的东西,可以用来包含一些源代码?我知道我可以使用 FML,但这不太理想。
谢谢
对于那些仍然想知道如何在 APT 中截取代码的人:
This is regular text
+---------------------
This is a code snippet
+---------------------
More regular text
Apache Maven Fluido Skin 突出了开箱即用的语法。在这里你可以找到一个例子。关于 Fluido 中语法高亮的信息:“源代码部分由 Google Code Prettify 增强,用户可以选择启用行号渲染(默认禁用)”来自 Fluido 网站。
这
+---------------------
code
+---------------------
语法正确。正如其他人提到的那样,Fluido 确实强调了开箱即用的Prettify 。
然而,站点插件 3.3 中的 Doxia 更改破坏了 Fluido。 MSKINS-86修复了这个问题,但尚未发布。
解决方法
<body>
<head>
<script type="text/javascript">
$(document).ready(function () {
$("div.source pre").addClass("prettyprint");
prettyPrint();
});
</script>
</head>
</body>
我最终使用了 Doxia 宏指南中的片段宏:http ://maven.apache.org/doxia/macros/index.html#Snippet_Macro
它将代码片段文件中的代码放在逐字框中。但是它不提供语法高亮。
doxia 1.0 版包含宏不在 maven 中心,但以下版本是: http ://mvnrepository.com/artifact/org.tinyjee.dim/doxia-include-macro