Petrify 静态站点生成器技术文档

1. 安装指南

1.1 安装 Node.js

首先，确保你已经安装了最新版本的 Node.js。Node.js 是 Petrify 的运行环境，因此必须先安装。

1.2 克隆项目仓库

使用 Git 克隆 Petrify 项目仓库到本地：

git clone https://github.com/your-repo/petrify.git

1.3 初始化子模块

进入项目目录并初始化子模块：

cd petrify
git submodule update --init --recursive

2. 项目的使用说明

2.1 生成静态站点

进入 examples 目录并运行构建脚本：

cd examples
node build.js

这将会在 www 目录下生成一系列 HTML 文件，这些文件就是你生成的静态站点内容。

2.2 自定义内容

你可以使用 Markdown 格式编写内容，并将其放置在项目目录中的适当位置。Petrify 会自动解析这些 Markdown 文件并生成对应的 HTML 文件。

3. 项目API使用文档

3.1 内容解析

Petrify 使用 JavaScript 来解析内容。你可以通过编写自定义的 JavaScript 脚本来处理内容解析逻辑。

3.2 视图渲染

Petrify 允许你使用 JavaScript 编写视图模板。你可以根据需要自定义视图的渲染逻辑。

4. 项目安装方式

4.1 通过 Git 安装

如前所述，你可以通过 Git 克隆项目仓库并初始化子模块来安装 Petrify。

4.2 通过 npm 安装

你也可以通过 npm 安装 Petrify：

npm install petrify

安装完成后，你可以通过命令行工具使用 Petrify 生成静态站点。

---

通过以上步骤，你应该能够顺利安装并使用 Petrify 静态站点生成器。如果你有任何问题或需要进一步的帮助，请参考项目的 GitHub Wiki 或联系项目维护者。