如何在 Maven 上生成文档？答案

【问题标题】：How generate documentation on maven?如何在 Maven 上生成文档？
【发布时间】：2022-01-31 22:46:28
【问题描述】：

我是 Maven 新手，现在我正在尝试生成项目文档。直到现在，我发现我只需要运行命令

mvn site

或

mvn clean site

这就是所有这些命令将在目标文件夹内生成文件夹站点，并且会生成一些文件，主要是 index.html，这就是问题所在，命令不会生成这些文件，只会生成文件夹

我希望文件 index.html 看起来像

这些文件夹有文件，如图像和文件 *.css，所以我不知道我之前是否需要做一些步骤？另外，如果您可以向我推荐有关它的教程或文档，谢谢

【问题讨论】：

最好从这里开始：maven.apache.org/plugins/maven-site-plugin/index.html 另一个问题是：你想达到什么目标？
谢谢，我正在关注一个教程，该部分指定在我运行命令后，我应该找到文件 index.html，它应该看起来像我更新的图像

标签： maven maven-site-plugin

【解决方案1】：

我找到了正确的方法，因为我所遵循的教程并不完整，这就是我感到困惑的原因。但我找到了 maven 的指南来做这件事。在这里查看Creating a site。所以我需要在 src 路径中创建文件夹 site ，这个文件夹应该包含文件 site.xml ，它与网站的不同组件相关联，可以在不同的文档类型中开发，在页面中有一些链接知道如何做。所以这是我的 site.xml

<?xml version="1.0" encoding="UTF-8"?>
<project>
    <body>
        <menu name="Overview">
            <item name="Introduction" href="index.html"/>
            <item name="Goals" href="plugin-info.html"/>
        </menu>
    </body>
</project>

我使用的是 xDoc 类型，所以我在站点内创建了 xdoc 文件夹，其中包含 site.xml 中相关的所有文件（例如 index.xml 和 plgin-info.xml）

然后运行命令 mvn site 并在 targe\site 中得到它

【讨论】：