index.md

文档中心

[why]为何使用Rythm

参见Rythm特性

[get]获取Rythm

两种方式可以获取Rythm：

1. 下载Rythm发行包
2. 使用Maven库

Maven库

将Rythm依赖加入你的pom.xml文件：

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

如果使用SNAPSHOT版本你需要在你的pom.xml文件中加入以下块：

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

[tutorial] 教程

Rythm新用户可以通过教程来逐步了解Rythm

• 环境配置
• hello world程序

[template-guide] 模板指南

为模板作者提供的详尽说明书

• Rythm介绍
• 模板参数声明
• 表达式
• 流控
• 模板调用
• 内联函数
• 包含其他模板
• 宏定义及使用
• 模板继承和布局

[developer-guide] 开发指南

详尽说明如何将Rythm和你的Java程序集成

• 简洁
• 使用模式
• 单例与否
• 配置Rythm
• 模板生成
• 运行时设定
• 运行时上下文
• 其他功能
• 扩展Rythm

[ref] 参考手册

• 配置参考
• 指令参考
• 内置表达式转换器

[misc] 其他文档

• 如何自定义转换器
• 沙箱模式