首页
/ CSS Crush 技术文档

CSS Crush 技术文档

2024-12-20 21:22:51作者:胡易黎Nicole

1. 安装指南

1.1 使用 Composer 安装(PHP)

如果你使用 Composer,可以通过以下命令在你的项目中安装 CSS Crush:

composer require css-crush/css-crush:dev-master

1.2 手动安装(PHP)

如果你不使用 Composer,可以直接下载库文件并将其放置在一个方便的位置,然后通过以下代码引入:

<?php require_once 'path/to/CssCrush.php'; ?>

1.3 使用 npm 安装(JavaScript)

如果你使用 npm,可以通过以下命令安装 CSS Crush:

npm install csscrush

2. 项目的使用说明

2.1 基本用法(PHP)

以下是一个基本的 PHP 使用示例:

<?php

echo csscrush_tag('css/styles.css');

?>

该代码将编译 css/styles.css 文件,并输出以下链接标签:

<link rel="stylesheet" href="css/styles.crush.css" media="all" />

2.2 基本用法(JavaScript)

以下是一个基本的 JavaScript 使用示例:

const csscrush = require('csscrush');

// 编译文件,返回 Promise
csscrush.file('./styles.css', {sourceMap: true});

// 编译 CSS 字符串,返回 Promise
csscrush.string('* {box-sizing: border-box;}');

// 编译并监视文件,返回事件发射器(触发 'data' 事件)
csscrush.watch('./styles.css');

3. 项目API使用文档

3.1 PHP API

  • csscrush_tag($file, $options):编译 CSS 文件并输出链接标签。
  • csscrush_file($file, $options):返回编译后文件的 URL。
  • csscrush_string($css, $options):编译原始 CSS 字符串并返回结果。
  • csscrush_inline($file, $options, $tag_attributes):返回编译后的 CSS 并将其嵌入到内联样式标签中。

3.2 JavaScript API

  • csscrush.file(filePath, options):编译指定路径的 CSS 文件,返回 Promise。
  • csscrush.string(cssString, options):编译 CSS 字符串,返回 Promise。
  • csscrush.watch(filePath, options):编译并监视指定路径的 CSS 文件,返回事件发射器。

4. 项目安装方式

4.1 PHP 安装方式

  • Composer 安装:使用 composer require css-crush/css-crush:dev-master 命令。
  • 手动安装:下载库文件并引入 CssCrush.php

4.2 JavaScript 安装方式

  • npm 安装:使用 npm install csscrush 命令。

通过以上步骤,你可以轻松安装并使用 CSS Crush 项目,享受其提供的现代化 CSS 工作流程。

登录后查看全文
热门项目推荐