From d4c40361acb4c1bedf9d5ccd8615f735fc8a3753 Mon Sep 17 00:00:00 2001 From: Kai Moritz Date: Sat, 16 Jul 2016 13:20:12 +0200 Subject: [PATCH] Added minimal documentation --- pom.xml | 2 +- src/site/xhtml/index.xhtml | 26 ++++++++++++++++++++++++-- src/site/xhtml/usage.xhtml | 15 ++++++++++++++- 3 files changed, 39 insertions(+), 4 deletions(-) diff --git a/pom.xml b/pom.xml index 94d1a40..ad8706f 100644 --- a/pom.xml +++ b/pom.xml @@ -8,7 +8,7 @@ Apache-Maven Thymeleaf-Skin A maven skin, that renders the site as templates, that can be styled without restrictions with the help of thymeleaf. - http://juplo.de/maven-thymeleaf-skin + http://juplo.de/maven-thymeleaf-skin/index.html scm:git:http://juplo.de/git/maven-thymeleaf-skin diff --git a/src/site/xhtml/index.xhtml b/src/site/xhtml/index.xhtml index 524a997..b3c3603 100644 --- a/src/site/xhtml/index.xhtml +++ b/src/site/xhtml/index.xhtml @@ -6,10 +6,32 @@

${project.name}

${project.description}

TODO...

+ The Apache-Maven Thymeleaf-Skin is an Apache Maven site skin, aimed at + giving you full freedom in styling and structuring + your website, while using the comfortable mechanisms provided by maven + to build the documentation of your projects. +

+ 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. +

+ See the usage-page for a full explanation, on + how to use the skin. +

Releases

current version
current version
${project.version} (this version)

diff --git a/src/site/xhtml/usage.xhtml b/src/site/xhtml/usage.xhtml index 3c573e4..9487b3e 100644 --- a/src/site/xhtml/usage.xhtml +++ b/src/site/xhtml/usage.xhtml @@ -5,6 +5,19 @@

Usage

TODO...

+ To use this skin in your project, use the skin element of + the site.xml site descriptor: +

<project name="xxx">
+  [...]
+  <skin>
+    <groupId>${project.groupId}</groupId>
+    <artifactId>${project.artifactId}</artifactId>
+    <version>${project.version}</version>
+  </skin>
+  [...]
+</project>
+

-- 2.20.1