index.md

@nocompact() {

Document Center

[why]Why Rythm

Check out Rythm features

[get]Get Rythm

You can get Rythm in 2 ways:

1. Download Rythm distribution pack by clicking here. or
2. Use the Maven repository as described below

Maven repository

Add Rythm dependency to your pom.xml file:

<dependency>
    <groupId>org.rythmengine</groupId>
    <artifactId>rythm-engine</artifactId>
    <version>1.1.1-SNAPSHOT</version>
</dependency>

If you are using SNAPSHOT version of Rythm, make sure you have the following section in the pom.xml file also:

<parent>
  <groupId>org.sonatype.oss</groupId>
  <artifactId>oss-parent</artifactId>
  <version>7</version>
</parent>

For a complete maven2 sample application, please find it inside the sample folder of the distribution package, or browse it on the Github

[tutorial]Tutorial

A step by step tutorial for new user.

• Set up your environment
• The hello world
• Duke's Bookstore

[template-guide]Template Author's Guide

A comprehensive template author's guide book.

• Introduction
• Template arguments
• Expression
• Template flow control
• Invoke other template
• Define and use inline tag
• Include other template
• Define and use macro
• Template inheritance and layout management

[developer-guide]Developer's Guide

The document details how to use Rythm in your Java program.

• Introduction
• Common usage pattern
• To Singleton Or Not
• Configuration
• Render Your Templates
• Render Setting
• Render Context
• Other Features
• Extends Rythm

[ref]References

• Configuration reference
• Directive reference
• Built transformer reference

[misc]Miscs topics

• How to define your transformer
• Sandbox mode }