PyJade 技术文档

1. 安装指南

首先，确保您的环境中已安装pip工具。然后，通过以下命令安装PyJade：

pip install pyjade

或者，您也可以使用以下命令：

python setup.py install

安装完成后，确保将模板文件命名为.jade扩展名，这样PyJade编译器才能正确处理它们。

2. 项目使用说明

PyJade 是一个性能卓越的 Jade-lang Python 版本，能够将 .jade 源文件转换为各种模板语言（如 Django、Jinja2、Mako 或 Tornado）。

命令行使用

要输出转换结果到控制台，可以使用以下命令：

pyjade [-c django|jinja|mako|tornado] input.jade [output.html]

或者：

pyjade [-c django|jinja|mako|tornado] [-o output.html] < input.jade

Python 脚本内部使用

在 Python 脚本中直接转换，可以这样做：

import pyjade
jade_text = '''!!! 5
html
head
    body foo bar!
'''
print pyjade.simple_convert(jade_text)

3. 项目API使用文档

PyJade 提供了丰富的 API 供开发者使用，以下是一些基本用法：

• pyjade.simple_convert(jade_text): 简单地将 Jade 文本转换为 HTML 字符串。
• pyjade.register_filter('filter_name'): 注册一个新的过滤器。

开发者可以根据需要查阅更多 API 文档和示例。

4. 项目安装方式

除了使用 pip 安装外，开发者也可以从源代码安装。首先克隆项目仓库，然后执行以下命令：

git clone https://github.com/syrusakbary/pyjade.git
cd pyjade
python setup.py install

安装完成后，您可以按照上述的使用说明开始使用 PyJade。