<name>Apache-Maven Thymeleaf-Skin</name>
<description>A maven skin, that renders the site as templates, that can be styled without restrictions with the help of thymeleaf.</description>
- <url>http://juplo.de/maven-thymeleaf-skin</url>
+ <url>http://juplo.de/maven-thymeleaf-skin/index.html</url>
<scm>
<connection>scm:git:http://juplo.de/git/maven-thymeleaf-skin</connection>
<body>
<h1>${project.name}</h1>
<h2>${project.description}</h2>
- <p><em>TODO...</em></p>
+ <p>
+ The Apache-Maven Thymeleaf-Skin is an Apache Maven site skin, aimed at
+ giving you <strong>full freedom in styling and structuring</strong>
+ your website, while using the comfortable mechanisms provided by maven
+ to build the documentation of your projects.
+ </p>
+ <p>
+ To achieve this gloal, this skin renders very plain (x)html5 pages, that
+ call a thymelaf layout-template, to give you full control over the
+ decoration of the pages.
+ The skin compiles all available information about the pages, like the
+ position of the page in the menu-structure, the according breadcrumb-path
+ and configured meta-information (an additional title, image and
+ alternative text for the image) of the link in the menu.
+ These information is made available to the called template as a
+ JSON-string.
+ Your template may parse this string and use the information to render a
+ custom menu and other navigation-elements like a breadcrumb-path.
+ </p>
+ <p>
+ See the <a href="usage.html">usage-page</a> for a full explanation, on
+ how to use the skin.
+ </p>
<h2>Releases</h2>
<ul>
- <li><a href="http://juplo.de/maven-thymeleaf-skin/">current version</a></li>
+ <li><a href="index.html">current version</a></li>
<li>${project.version} (this version)</li>
</ul>
</body>
</head>
<body>
<h1>Usage</h1>
- <p><em>TODO...</em></p>
+ <p>
+ To use this skin in your project, use the skin element of
+ <a href="http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html">the <code>site.xml</code> site descriptor</a>:
+ </p>
+ <pre class="prettyprint linenums" id="redirect"><code class="xml"><project name="xxx">
+ [...]
+ <skin>
+ <groupId>${project.groupId}</groupId>
+ <artifactId>${project.artifactId}</artifactId>
+ <version>${project.version}</version>
+ </skin>
+ [...]
+</project>
+ </code></pre>
</body>
</html>
projects / maven-thymeleaf-skin / commitdiff