Retina-Sprites-for-Compass 使用教程
1. 项目的目录结构及介绍
Retina-Sprites-for-Compass 项目的目录结构如下:
Retina-Sprites-for-Compass/
├── src/
│ ├── _retina-sprites.scss
│ ├── _retina-sprites-mixins.scss
│ └── example/
│ ├── images/
│ │ ├── sprites/
│ │ └── sprites2x/
│ ├── index.html
│ └── styles.scss
├── .gitignore
├── README.md
├── bower.json
├── package.json
└── sache.json
目录结构介绍
src/
: 包含主要的 SCSS 文件和示例目录。_retina-sprites.scss
: 用于生成 Retina 精灵图的主要 SCSS 文件。_retina-sprites-mixins.scss
: 包含生成 Retina 精灵图的混合器。example/
: 示例目录,包含示例图片、HTML 和 SCSS 文件。images/
: 包含普通和 Retina 版本的精灵图。index.html
: 示例 HTML 文件。styles.scss
: 示例 SCSS 文件。
.gitignore
: Git 忽略文件。README.md
: 项目说明文档。bower.json
: Bower 配置文件。package.json
: npm 配置文件。sache.json
: Sache 配置文件。
2. 项目的启动文件介绍
项目的启动文件主要是 src/example/index.html
和 src/example/styles.scss
。
index.html
index.html
是一个示例 HTML 文件,展示了如何使用生成的精灵图。
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Retina Sprites Example</title>
<link rel="stylesheet" href="styles.scss">
</head>
<body>
<div class="sprite2"></div>
</body>
</html>
styles.scss
styles.scss
是一个示例 SCSS 文件,展示了如何引入和使用 Retina 精灵图。
@import "retina-sprites";
.sprite2 {
@include use-sprite("sprite2");
}
3. 项目的配置文件介绍
项目的配置文件主要包括 bower.json
和 package.json
。
bower.json
bower.json
是 Bower 的配置文件,用于管理前端依赖。
{
"name": "Retina-Sprites-for-Compass",
"version": "1.0.0",
"description": "Allow to use sprites in retina with Compass",
"main": "src/_retina-sprites.scss",
"keywords": [
"compass",
"retina",
"sprites"
],
"authors": [
"AdamBrodzinski"
],
"license": "MIT",
"homepage": "https://github.com/AdamBrodzinski/Retina-Sprites-for-Compass",
"ignore": [
"**/.*",
"node_modules",
"bower_components",
"test",
"tests"
]
}
package.json
package.json
是 npm 的配置文件,用于管理 Node.js 依赖。
{
"name": "retina-sprites-for-compass",
"version": "1.0.0",
"description": "Allow to use sprites in retina with Compass",
"main": "src/_retina-sprites.scss",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/AdamBrodzinski/