Table of Contents

Sentry Maven Skin 6.6.01

Quick Start

Get your documentation site up and running in 5 minutes.

Prerequisites

  • A Maven project[1] with pom.xml
  • Maven 3.x installed
  • Java 8 or later

Step 1: Project Structure

Create this directory structure:

my-project/
├── pom.xml
└── src/
    └── site/
        ├── site.xml
        ├── markdown/
        │   └── index.md
        └── resources/
            ├── css/
            │   └── site.css (optional)
            └── images/
                └── logo.png (optional)

Step 2: Configure pom.xml

Add the Maven Site Plugin with the required dependency:

<build>
  <plugins>
    <plugin>
      <artifactId>maven-site-plugin</artifactId>
      <version>3.12.1</version>
      <dependencies>
        <dependency>
          <groupId>org.sentrysoftware.maven</groupId>
          <artifactId>maven-skin-tools</artifactId>
          <version>1.6.00</version>
        </dependency>
      </dependencies>
    </plugin>
  </plugins>
</build>

Important: Use maven-site-plugin version 3.12.x. Later versions use a different site decoration model that is not yet supported.

Step 3: Configure site.xml

Create src/site/site.xml:

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

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

  <bannerLeft>
    <name>${project.organization.name}</name>
    <href>${project.organization.url}</href>
  </bannerLeft>

  <body>
    <menu name="Documentation">
      <item name="Overview" href="index.html"/>
    </menu>
  </body>

</project>

Step 4: Write Your First Page

Create src/site/markdown/index.md:

# Welcome

This is my documentation built with **Sentry Maven Skin**.


- Easy to write in Markdown
- Beautiful output
- Full-text search included

Step 5: Build and Preview

Generate your site:

mvn clean site

The site is generated in target/site/. Open target/site/index.html in your browser.

Live Preview

For real-time preview while editing:

mvn site:run

Then open http://localhost:8080[2]. Changes to Markdown files are reflected immediately.

Note: Changes to site.xml or pom.xml require restarting mvn site:run.

Next Steps

Now that your site is running, continue with:

Setup

Writing

Reference

setup quickstart installation getting started maven skin doxia
Links:
  • [1] https://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html
  • [2] http://localhost:8080
  • [3] styles.html
  • [4] nav-menu.html
  • [5] nav-links.html
  • [6] page-structure.html
  • [7] code.html
  • [8] images.html
  • [9] settings.html
  • [10] features.html
Searching...
No results.