插件文档

此插件可用的目标:

目标 描述
站点:附加描述符 将站点描述符 ( site.xml) 添加到要安装/部署的文件列表中。
站点:部署 scp使用或 协议将生成的站点部署到 POM 部分中 file指定的站点 URL 。<distributionManagement>

对于scp协议,将网站文件打包成 zip 存档,然后将存档传输到远程主机,然后取消存档。这种部署方法通常比逐个文件复制要快得多。对于 file协议,文件直接复制到目标目录。

站点:有效站点 在继承和插值site.xml.
网站:帮助 显示有关 maven-site-plugin 的帮助信息。
称呼
  mvn site:help -Ddetail=true -Dgoal=<goal-name>
显示参数详细信息。
站点:jar 将站点输出捆绑到 JAR 中,以便可以将其部署到存储库。
站点:运行 启动站点,根据要求呈现文档以加快编辑速度。它使用 Jetty 作为 Web 服务器。
站点:站点 为单个项目生成站点。

请注意,多模块构建中的模块站点之间的链接将不起作用

现场:舞台 <distributionManagement>根据POM 部分中 指定的站点 URL 在本地暂存或模拟目录中生成站点 。

它可用于测试多模块构建中模块站点之间的链接是否有效。

站点:阶段部署 <distributionManagement>将生成的站点部署到POM 部分中指定的站点 URL 的登台或模拟目录 。它支持scp部署file协议。

系统要求

以下指定了运行此 Maven 插件的最低要求:

maven 2.2.0
JDK 1.5
记忆 没有最低要求。
磁盘空间 没有最低要求。

用法

您应该在项目的插件配置中指定版本:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-site-plugin</artifactId>
          <version>2.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>2.2</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

有关详细信息,请参阅“配置插件指南”