Hamlish-jinja 技术文档

本文档将详细介绍如何安装、使用以及API调用Hamlish-jinja项目。Hamlish-jinja 是一个Jinja模板引擎的扩展，它使得用户可以使用类似Haml的语法来编写Jinja模板。

1. 安装指南

安装Hamlish-jinja非常简单，您可以使用easy_install或pip来安装最新版本。

easy_install Hamlish-Jinja
pip install Hamlish-Jinja

2. 项目使用说明

要在项目中使用Hamlish-jinja，您需要将其添加到Jinja环境中，并将模板文件扩展名设置为.haml。

from jinja2 import Environment
from hamlish_jinja import HamlishExtension

env = Environment(extensions=[HamlishExtension])

配置选项

Hamlish-jinja 提供了一些配置选项：

• hamlish_mode：可以是 compact、indented 或 debug，默认为 compact。
• hamlish_file_extensions：预处理器要处理的文件扩展名列表，默认为 ('.haml',)。
• hamlish_enable_div_shortcut：是否启用div简写，默认关闭。
• hamlish_filters：一个字典，映射过滤器名称到调用函数。

使用方式

在Jinja环境中使用 hamlish_from_string 方法可以渲染字符串形式的Haml模板。

tpl = '''
%div
    %p
        test
'''
env.hamlish_from_string(tpl).render()

3. 项目API使用文档

Hamlish-jinja 的API主要是通过Jinja环境进行配置和使用。以下是一些关键点的说明：

• HamlishExtension：这是主扩展类，需要添加到Jinja环境中。
• hamlish_from_string：环境方法，用于从字符串渲染模板。
• 配置选项：如上所述，可以通过Jinja环境对象设置。

4. 项目安装方式

安装方式已在安装指南中说明，可以使用easy_install或pip命令来安装。

easy_install Hamlish-Jinja
pip install Hamlish-Jinja

通过上述文档，用户应能够顺利安装并开始使用Hamlish-jinja，同时了解其API的基本用法和配置选项。