开源项目 `inline_svg` 使用教程

1. 项目的目录结构及介绍

inline_svg 项目的目录结构如下：

inline_svg/
├── circleci/
│   └── config.yml
├── features/
│   └── support/
├── lib/
│   ├── inline_svg/
│   └── inline_svg.rb
├── test/
│   ├── assets/
│   ├── config/
│   ├── fixtures/
│   ├── functional/
│   ├── integration/
│   ├── test_helper.rb
│   └── unit/
├── .gitignore
├── Gemfile
├── LICENSE.md
├── README.md
├── Rakefile
└── middleman-inline_svg.gemspec

目录介绍

• circleci/: 包含 CircleCI 的配置文件。
• features/: 包含项目的功能测试支持文件。
• lib/: 包含项目的主要代码文件。
  • inline_svg/: 包含项目的核心功能实现。
  • inline_svg.rb: 项目的主文件。
• test/: 包含项目的测试文件。
  • assets/: 测试所需的资源文件。
  • config/: 测试配置文件。
  • fixtures/: 测试用例的固定数据。
  • functional/: 功能测试文件。
  • integration/: 集成测试文件。
  • unit/: 单元测试文件。
  • test_helper.rb: 测试辅助文件。
• .gitignore: Git 忽略文件配置。
• Gemfile: 项目的依赖管理文件。
• LICENSE.md: 项目的许可证文件。
• README.md: 项目的说明文档。
• Rakefile: 项目的 Rake 任务配置文件。
• middleman-inline_svg.gemspec: 项目的 gemspec 文件。

2. 项目的启动文件介绍

项目的启动文件主要是 lib/inline_svg.rb，这个文件负责加载项目的核心功能模块，并提供对外的接口。

require "inline_svg/version"
require "inline_svg/custom_transform"
require "inline_svg/transform_pipeline"
require "inline_svg/transformations"
require "inline_svg/asset_file"
require "inline_svg/static_asset_file"
require "inline_svg/io_asset_file"
require "inline_svg/document"
require "inline_svg/action_view/helpers"
require "inline_svg/railtie" if defined?(Rails)

3. 项目的配置文件介绍

项目的配置文件主要是 config/initializers/inline_svg.rb，这个文件用于配置项目的自定义行为。

InlineSvg.configure do |config|
  config.svg_not_found_css_class = 'svg-not-found'
  config.raise_on_file_not_found = true
end

配置项介绍

• svg_not_found_css_class: 当 SVG 文件找不到时，应用的 CSS 类。
• raise_on_file_not_found: 当 SVG 文件找不到时，是否抛出异常。

以上是 inline_svg 项目的基本使用教程，包括项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。