Bonsai 静态网站生成器技术文档

1. 安装指南

1.1 系统要求

• Ruby 1.8.7 或更高版本
• 支持 MRI、RBX、JRuby 等多种 Ruby 实现

1.2 安装步骤

1. 打开终端或命令行工具。
2. 输入以下命令安装 Bonsai：

   gem install bonsai
   

3. 安装完成后，可以通过以下命令检查是否安装成功：

   bonsai --help
   

2. 项目的使用说明

2.1 生成项目

1. 在终端中输入以下命令生成一个新的 Bonsai 项目：

   bonsai --plant [项目名称]
   

   例如：

   bonsai --plant my_website
   

2. 生成的项目结构如下：

   my_website/
   ├── _layouts/
   ├── _posts/
   ├── _site/
   ├── _config.yml
   └── index.html
   

2.2 启动开发服务器

1. 进入生成的项目目录：

   cd my_website
   

2. 启动开发服务器：

   bonsai --cultivate
   

3. 服务器启动后，可以在浏览器中访问 http://localhost:4000 查看网站。

2.3 生成静态站点

1. 在项目根目录下运行以下命令生成静态站点：

   bonsai --repot
   

2. 生成的静态站点文件位于 output 目录中。

3. 项目API使用文档

3.1 页面结构

• children：当前页面的子页面。
• siblings：当前页面的兄弟页面。
• ancestors：当前页面的父级页面。
• navigation：网站的导航结构。

3.2 生成文件

• sitemap.xml：为搜索引擎生成站点地图。
• robots.txt：生成友好的 robots.txt 文件。

4. 项目安装方式

4.1 本地安装

1. 确保已安装 Ruby 和 RubyGems。
2. 使用以下命令安装 Bonsai：

   gem install bonsai
   

4.2 生产环境部署

1. 生成静态站点：

   bonsai --repot
   

2. 将 output 目录中的内容上传到生产服务器：

   rsync -ave ssh ./output/ [服务器地址]:[目标路径]
   

   例如：

   rsync -ave ssh ./output/ tinytree.info:/var/www/tinytree.info
   

通过以上步骤，您可以轻松安装、使用和部署 Bonsai 静态网站生成器。