Gretel 项目技术文档

1. 安装指南

环境要求

• Ruby 版本：2.5 及以上
• Rails 版本：5.0 及以上

安装步骤

1. 打开终端，进入你的 Rails 项目目录。
2. 在 Gemfile 中添加以下内容：

   gem 'gretel'
   

3. 运行以下命令安装 gem：

   bundle install
   

4. 安装完成后，运行以下命令生成配置文件：

   rails generate gretel:install
   

5. 配置文件生成后，你可以在 config/breadcrumbs.rb 中自定义面包屑导航。

2. 项目的使用说明

配置面包屑导航

在 config/breadcrumbs.rb 文件中，你可以定义面包屑导航的路径和显示内容。例如：

crumb :root do
  link "Home", root_path
end

crumb :about do
  link "About", about_path
  parent :root
end

在视图中使用面包屑导航

在需要显示面包屑导航的视图中，使用以下代码：

<%= breadcrumbs pretext: "You are here: ", separator: " &rsaquo; " %>

自定义面包屑样式

你可以通过 CSS 自定义面包屑的样式，例如：

.breadcrumbs {
  list-style: none;
  padding: 0;
}

.breadcrumbs li {
  display: inline;
}

3. 项目API使用文档

生成面包屑

Gretel::Crumbs.render(:crumb_name)

• :crumb_name：你在 config/breadcrumbs.rb 中定义的面包屑名称。

自定义前置文本和分隔符

Gretel::Crumbs.render(:crumb_name, pretext: "You are here: ", separator: " › ")

• pretext：前置文本。
• separator：分隔符。

4. 项目安装方式

通过 Gemfile 安装

1. 在 Gemfile 中添加：

   gem 'gretel'
   

2. 运行 bundle install。

手动安装

1. 下载 Gretel 的源代码。
2. 将源代码放置在你的 Rails 项目中。
3. 在 config/application.rb 中添加：

   require 'gretel'
   

通过以上步骤，你可以成功安装并使用 Gretel 项目来管理你的面包屑导航。