Jeet Grid System 技术文档

1. 安装指南

Jeet 是一个基于 Sass 和 Stylus 的简单分数网格系统。要开始使用 Jeet，请按照以下步骤进行安装：

npm install -D jeet

确保您已经安装了 Node.js 和 npm。安装完成后，Jeet 将被添加到您的项目中。

2. 项目使用说明

2.1 Sass 使用方法

在您的 Sass 文件中，您需要导入 Jeet 的模块。以下是一个基本的使用示例：

@import 'node_modules/jeet/jeet';

.container {
  @include center();
}

.container div {
  @include column(1/3);
}

在这个示例中，.container 类将使用 Jeet 的 center() 函数进行居中，而 .container div 类将占用三分之一的宽度。

2.2 Stylus 使用方法

在 Stylus 文件中，使用 Jeet 的方式与 Sass 类似，但语法略有不同：

@import 'node_modules/jeet/jeet'

.container
  center()
  
.container div
  column(1/3)

如上所示，Stylus 中的 @include 关键字被省略，直接使用函数名。

3. 项目API使用文档

Jeet 提供了多种函数来帮助您创建网格系统。以下是一些常用的 API 函数：

• column(fraction): 创建一个指定宽度的列。
• columns(fraction, count): 创建多个相同宽度的列。
• center(): 居中容器。
• span(fraction): 创建一个指定宽度的列，并自动计算左右边距。

例如，要创建一个三分之一的列：

.column-third
  @include column(1/3)

要创建三个等宽的列：

.columns-three
  @include columns(1/3, 3)

更多 API 文档，请参考 Jeet 的官方文档。

4. 项目安装方式

Jeet 可以通过 npm 进行安装，这是最推荐的安装方式。确保您的项目中已经安装了 Node.js 和 npm，然后运行以下命令：

npm install -D jeet

这将把 Jeet 作为项目依赖项安装到 node_modules 目录中，并在 package.json 文件中记录。

请按照以上步骤进行操作，以开始使用 Jeet Grid System。如果您在安装或使用过程中遇到任何问题，请查阅官方文档或寻求社区支持。