Bootstrap Generators 技术文档

1. 安装指南

首先，确保您的项目已安装Ruby和Rails环境。在您的Gemfile中添加以下依赖项：

gem 'bootstrap-generators', '~> 3.3.4'

或者，您可以从最新构建中安装：

gem 'bootstrap-generators', git: 'git://github.com/decioferreira/bootstrap-generators.git'

然后，运行以下命令安装依赖项：

bundle install

2. 项目的使用说明

使用以下命令启动Bootstrap安装过程：

rails generate bootstrap:install

如果要覆盖已存在的文件，请使用--force（或-f）选项。

安装后，每次生成控制器或脚手架时，都会自动获取Bootstrap模板。

对于Rails 4.1及以上版本，您需要运行以下命令以确保Rails预加载器知道新模板：

spring stop

3. 项目API使用文档

安装选项

• -e, [--template-engine=TEMPLATE_ENGINE]：指定生成的模板引擎。默认为erb。
• -se, [--stylesheet-engine=STYLESHEET_ENGINE]：指定生成的样式表引擎。默认为scss。
• --skip-turbolinks（或--no-skip-turbolinks）：指定是否在生成的布局中省略turbolinks引用。

运行时选项

• -f, [--force]：覆盖已存在的文件。
• -p, [--pretend]（或--no-pretend）：运行但不做任何更改。
• -q, [--quiet]（或--no-quiet）：抑制状态输出。
• -s, [--skip]（或--no-skip）：跳过已存在的文件。

模板引擎

支持的模板引擎包括：

• ERB
• Haml
• Slim

Haml

在Gemfile中添加依赖项：

gem 'haml-rails'

然后运行：

rails generate bootstrap:install --template-engine=haml

Slim

在Gemfile中添加依赖项：

gem 'slim-rails'

然后运行：

rails generate bootstrap:install --template-engine=slim

样式表引擎

支持的样式表引擎包括：

• CSS
• SCSS
• LESS

SCSS

确保在Gemfile中有sass-rails依赖项：

gem 'sass-rails'

然后运行：

rails generate bootstrap:install --stylesheet-engine=scss

LESS

在Gemfile中添加以下依赖项：

gem 'therubyracer', platforms: :ruby
gem 'less-rails'

然后运行：

rails generate bootstrap:install --stylesheet-engine=less

跳过turbolinks

使用--skip-turbolinks选项运行生成器，以从生成的布局中删除turbolinks引用。

4. 项目安装方式

请遵循以下步骤安装Bootstrap Generators：

1. 在Gemfile中添加依赖项。
2. 运行bundle install安装依赖项。
3. 使用rails generate bootstrap:install命令安装Bootstrap。

根据需要，您可以自定义模板引擎和样式表引擎，然后重新运行安装命令以应用更改。