ki.js 项目使用教程

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

ki.js/
├── Gruntfile.js
├── LICENSE.txt
├── README.md
├── bower.json
├── dist/
│   ├── ki.js
│   ├── ki.min.js
│   └── ki.ie8.min.js
├── package.json
└── src/
    ├── ki.coffee
    └── ki.js

• Gruntfile.js: Grunt 构建配置文件。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目说明文档。
• bower.json: Bower 包管理配置文件。
• dist/: 编译后的文件目录，包含未压缩和压缩版本。
• package.json: npm 包管理配置文件。
• src/: 源代码目录，包含 CoffeeScript 和 JavaScript 源文件。

2. 项目的启动文件介绍

项目的启动文件位于 dist/ 目录下，主要包括：

• ki.js: 未压缩的开发版本。
• ki.min.js: 压缩的生产版本。
• ki.ie8.min.js: 支持 IE8 的压缩版本。

在 HTML 文件中引入 ki.min.js 即可开始使用 ki.js：

<script src="path/to/ki.min.js"></script>

3. 项目的配置文件介绍

• Gruntfile.js: 用于配置 Grunt 任务，包括编译、压缩等。
• package.json: 包含项目的依赖信息和脚本命令。
• bower.json: 用于 Bower 包管理，定义项目信息和依赖。

Gruntfile.js

module.exports = function(grunt) {
  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'),
    uglify: {
      options: {
        banner: '/*! <%= pkg.name %> <%= grunt.template.today("yyyy-mm-dd") %> */\n'
      },
      build: {
        src: 'src/ki.js',
        dest: 'dist/ki.min.js'
      }
    }
  });

  grunt.loadNpmTasks('grunt-contrib-uglify');
  grunt.registerTask('default', ['uglify']);
};

package.json

{
  "name": "ki.js",
  "version": "1.0.0",
  "description": "A super-tiny jQuery-like API JavaScript library",
  "main": "dist/ki.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "dciccale",
  "license": "MIT",
  "devDependencies": {
    "grunt": "^1.0.1",
    "grunt-contrib-uglify": "^4.0.0"
  }
}

bower.json

{
  "name": "ki.js",
  "version": "1.0.0",
  "description": "A super-tiny jQuery-like API JavaScript library",
  "main": "dist/ki.js",
  "authors": [
    "dciccale"
  ],
  "license": "MIT",
  "homepage": "https://github.com/dciccale/ki.js",
  "ignore": [
    "**/.*",
    "node_modules",
    "bower_components",
    "test",
    "tests"
  ]
}

以上是 ki.js 项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你更好地理解和使用 ki.js 项目。