projects / maven-thymeleaf-skin / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: cef56a6)
Added minimal documentation
authorKai Moritz <kai@juplo.de>
Sat, 16 Jul 2016 11:20:12 +0000 (13:20 +0200)
committerKai Moritz <kai@juplo.de>
Sat, 16 Jul 2016 11:55:24 +0000 (13:55 +0200)
pom.xml patch | blob | history
src/site/xhtml/index.xhtml patch | blob | history
src/site/xhtml/usage.xhtml patch | blob | history

diff --git a/pom.xml b/pom.xml
index 94d1a40..ad8706f 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -8,7 +8,7 @@
 
   <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>
 
   <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>
 
   <scm>
     <connection>scm:git:http://juplo.de/git/maven-thymeleaf-skin</connection>
diff --git a/src/site/xhtml/index.xhtml b/src/site/xhtml/index.xhtml
index 524a997..b3c3603 100644 (file)
--- a/src/site/xhtml/index.xhtml
+++ b/src/site/xhtml/index.xhtml
@@ -6,10 +6,32 @@
  <body>
   <h1>${project.name}</h1>
   <h2>${project.description}</h2>
  <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>
   <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>
     <li>${project.version} (this version)</li>
   </ul>
  </body>
diff --git a/src/site/xhtml/usage.xhtml b/src/site/xhtml/usage.xhtml
index 3c573e4..9487b3e 100644 (file)
--- a/src/site/xhtml/usage.xhtml
+++ b/src/site/xhtml/usage.xhtml
@@ -5,6 +5,19 @@
  </head>
  <body>
   <h1>Usage</h1>
  </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">&lt;project name="xxx"&gt;
+  [...]
+  &lt;skin&gt;
+    &lt;groupId&gt;${project.groupId}&lt;/groupId&gt;
+    &lt;artifactId&gt;${project.artifactId}&lt;/artifactId&gt;
+    &lt;version&gt;${project.version}&lt;/version&gt;
+  &lt;/skin&gt;
+  [...]
+&lt;/project&gt;
+  </code></pre>
  </body>
 </html>
  </body>
 </html>
Unnamed repository; edit this file 'description' to name the repository.