grunt-markdown 项目教程

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

grunt-markdown/
├── Gruntfile.js
├── README.md
├── package.json
├── tasks/
│   └── markdown.js
└── test/
    ├── fixtures/
    │   └── example.md
    └── expected/
        └── example.html

• Gruntfile.js: 项目的配置文件，用于定义任务和加载插件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和元数据信息。
• tasks/markdown.js: 定义 grunt-markdown 任务的具体实现。
• test/fixtures/example.md: 测试用的 Markdown 文件。
• test/expected/example.html: 测试用的预期 HTML 文件。

2. 项目的启动文件介绍

项目的启动文件是 Gruntfile.js。这个文件用于配置和定义 Grunt 任务。以下是 Gruntfile.js 的基本结构：

module.exports = function(grunt) {
  // 项目配置
  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'),
    markdown: {
      all: {
        files: [
          {
            expand: true,
            src: 'test/fixtures/*.md',
            dest: 'test/expected/',
            ext: '.html'
          }
        ]
      }
    }
  });

  // 加载包含 "grunt-markdown" 任务的插件
  grunt.loadNpmTasks('grunt-markdown');

  // 默认任务
  grunt.registerTask('default', ['markdown']);
};

3. 项目的配置文件介绍

项目的配置文件是 package.json。这个文件包含了项目的依赖和元数据信息。以下是 package.json 的基本结构：

{
  "name": "grunt-markdown",
  "version": "1.0.0",
  "description": "A Grunt plugin to convert Markdown files to HTML.",
  "main": "Gruntfile.js",
  "scripts": {
    "test": "grunt test"
  },
  "keywords": [
    "gruntplugin",
    "markdown",
    "html"
  ],
  "author": "Your Name",
  "license": "MIT",
  "dependencies": {
    "grunt": "^1.0.0",
    "marked": "^1.0.0"
  },
  "devDependencies": {
    "grunt-contrib-clean": "^2.0.0",
    "grunt-contrib-nodeunit": "^2.0.0"
  }
}

• name: 项目的名称。
• version: 项目的版本号。
• description: 项目的描述。
• main: 项目的入口文件。
• scripts: 定义一些脚本命令。
• keywords: 项目的关键词。
• author: 项目的作者。
• license: 项目的许可证。
• dependencies: 项目运行时的依赖。
• devDependencies: 项目开发时的依赖。