X-Git-Url: https://juplo.de/gitweb/?p=maven-thymeleaf-skin;a=blobdiff_plain;f=src%2Fsite%2Fxhtml%2Findex.xhtml;h=b3c3603128f8f6f491bfc61808e6692d6ceff37c;hp=524a997b4d2df6df9c66dcd3b71dd717e69ca469;hb=d4c40361acb4c1bedf9d5ccd8615f735fc8a3753;hpb=26697cca1a5f86bbec6f08ded69c5a800e71c3a0 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