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

时间：2015-07-10 21:17:57

标签： maven maven-site-plugin

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

  

如何将静态（X）HTML页面集成到我的Maven站点？   您可以按照以下步骤集成静态页面：

     
      
  • 将静态页面放在资源目录$ {basedir} / src / site / resources
    • 中   
  • 创建您的site.xml并将其放在$ {basedir} / src / site
    • 中   
  • 通过修改菜单部分链接到静态页面，创建项目并将它们映射到静态页面的文件名
    •   
哇，很清楚！

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

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

1 个答案:

答案 0 :(得分：0)

最终没有像我想象的那么困难。 site.xml文档很糟糕，但我找到了一个例子，玩弄了它，并想出了如何做到这一点：

首先，我遵循了khmarbaise的建议并将文件放在src/site/markdown/README.md下。当target/site/README.html运行时，这会生成site文档。但是，没有链接。

我接下来要做的就是制作一个src/site/site.xml文件。我所要做的就是创建所需的链接，而不是整个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"/>来保留其他报告菜单。

您可以在此处查看结果：

Added Markdown document in menu

请注意添加的配置部分。

我做的唯一其他事情也是使用技术规则markdown plugin。这样，我就可以将生成的HTML链接到Jenkins中的归档工件链接。

相关问题
最新问题