Table of Contents

Sentry Maven Skin 6.6.01

Configuration Reference

All settings are configured in src/site/site.xml, the Maven site descriptor[1].

Quick Reference

<project name="${project.name}">

  <skin>
    <groupId>org.sentrysoftware.maven</groupId>
    <artifactId>sentry-maven-skin</artifactId>
    <version>6.6.01</version>
  </skin>

  <custom>
    <bodyClass>sentry-purple</bodyClass>
    <keywords>keyword1, keyword2</keywords>
    <projectVersion>2.0.0</projectVersion>
    <additionalLinks>
      <link>
        <name>Terms of Service</name>
        <href>https://example.com/terms</href>
      </link>
    </additionalLinks>
    <social>
      <twitter>YourHandle</twitter>
      <linkedin>company/YourCompany</linkedin>
    </social>
  </custom>

  <bannerLeft>
    <src>images/logo.png</src>
    <href>https://example.com</href>
  </bannerLeft>

  <body>
    <links>
      <item name="GitHub" href="https://github.com/you/project"/>
    </links>
    <menu name="Documentation">
      <item name="Overview" href="index.html"/>
    </menu>
  </body>

</project>

Configuration Options

<custom> Settings

Setting Description Default
<bodyClass> Color theme: sentry-purple, sentry-green, sentry-orange, or none (blue) Blue
<keywords> Global keywords for all pages (comma-separated) None
<projectVersion> Override the displayed version $project.version
<publishDate> Documentation publish date (ISO format) Build timestamp
<additionalLinks> Footer links (legal, privacy, etc.) None
<social> Social media links in header None

<bannerLeft> and <bannerRight>

Setting Description
<src> Path to logo image
<href> Link URL when clicked
<name> Text to display (alternative to image)
<alt> Alt text for image

<body> Settings

Setting Description
<links> Top navigation bar links
<breadcrumbs> Breadcrumb navigation
<menu> Sidebar navigation menu

See Also

configuration settings options site.xml maven skin doxia
Links:
  • [1] https://maven.apache.org/plugins/maven-site-plugin/examples/sitedescriptor.html
  • [2] nav-links.html
  • [3] nav-menu.html
  • [4] styles.html
  • [5] keywords.html
Searching...
No results.