将文档添加到我的 Maven 站点报告

Question

我们有一个 Markdown 文档，我们希望在我们的 Maven 站点报告中可用。我找到了一个将 Markdown 翻译成 HTML 的插件，我将生成的 HTML 文档放在 target/documents/README.html 中。我想将此文档包含在生成站点报告中，但是 maven-site-plugin 的文档有点稀疏：

How do I Integrate static (X)HTML pages into my Maven site? You can integrate your static pages by following these steps:

Put your static pages in the resources directory, ${basedir}/src/site/resources

Create your site.xml and put it in ${basedir}/src/site

Link to the static pages by modifying the menu section, create items and map them to the filenames of the static pages

哇，太清楚了！

此文档存储在 ${basedir}/src/markdown/README.md 中，并在 target/documents/README.html 中生成为 HTML 文档。我可以更改发生一切的目录，但我不想将生成的 HTML 文档写入 ${basedir}/src/site.

如何生成自己的 site.xml？我可以让 site.xml 从 target 下的另一个目录中提取文档吗？

Answer 1

最终并没有我想象的那么难。 site.xml 文档很糟糕，但我找到了一个示例，尝试了一下，并弄清楚了如何去做：

首先，我听从了khmarbaise的建议，将文档放在了src/site/markdown/README.md下。在 site 运行时生成了 target/site/README.html 文档。但是，没有link。

接下来我要做的是制作一个 src/site/site.xml 文件。我所要做的就是创建所需的 link 而不是整个 index.html 页面：

<?xml version="1.0" encoding="ISO-8859-1"?>
<project>
    <body>
        <menu name="Configuration">
            <item name="Using this library" href="README.html"/>
        </menu>
        <menu ref="reports"/>
    </body>
</project>

需要 <menu ref="reports"/> 来保留其他报告菜单。

你可以在这里看到结果：

注意添加的配置部分。

我唯一做的另一件事就是使用 Rule of Tech markdown plugin。这样，我可以 link 生成的 HTML 到 Jenkins 中的存档工件 link。

将文档添加到我的 Maven 站点报告

Adding document to my Maven site report

maven

maven-site-plugin