generator-jekyllrb 项目教程
1. 项目的目录结构及介绍
generator-jekyllrb/
├── app/
│ ├── templates/
│ └── index.js
├── test/
│ ├── app.js
│ └── test-creation.js
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .jshintrc
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── FAQ.md
├── LICENSE
├── README.md
├── package.json
- app/: 包含项目的主要模板和入口文件。
- templates/: 包含Jekyll项目的模板文件。
- index.js: 项目的入口文件。
- test/: 包含项目的测试文件。
- app.js: 应用测试文件。
- test-creation.js: 创建测试文件。
- .editorconfig: 编辑器配置文件。
- .gitattributes: Git属性配置文件。
- .gitignore: Git忽略文件配置。
- .jshintrc: JSHint配置文件。
- .travis.yml: Travis CI配置文件。
- CHANGELOG.md: 变更日志文件。
- CONTRIBUTING.md: 贡献指南文件。
- FAQ.md: 常见问题解答文件。
- LICENSE: 项目许可证文件。
- README.md: 项目说明文件。
- package.json: Node.js项目配置文件。
2. 项目的启动文件介绍
项目的启动文件是 app/index.js
。这个文件是Yeoman生成器的入口点,负责初始化和配置Jekyll项目。
// app/index.js
var generators = require('yeoman-generator');
module.exports = generators.Base.extend({
// 构造函数
constructor: function () {
generators.Base.apply(this, arguments);
},
// 初始化方法
initializing: function () {
this.pkg = require('../package.json');
},
// 提示用户输入
prompting: function () {
var done = this.async();
this.prompt([
{
type: 'confirm',
name: 'someOption',
message: 'Would you like to enable this option?',
default: true
}
], function (answers) {
this.props = answers;
done();
}.bind(this));
},
// 写入文件
writing: function () {
this.fs.copyTpl(
this.templatePath('index.html'),
this.destinationPath('app/index.html'),
{ title: 'Templating with Yeoman' }
);
},
// 安装依赖
install: function () {
this.installDependencies();
}
});
3. 项目的配置文件介绍
- .editorconfig: 定义编辑器配置,确保不同开发者使用不同编辑器时,代码风格一致。
- .gitattributes: 设置Git属性,例如文件换行符等。
- .gitignore: 指定Git忽略的文件和目录。
- .jshintrc: 配置JSHint,用于检查JavaScript代码质量。
- .travis.yml: 配置Travis CI,用于持续集成。
- package.json: 定义Node.js项目的依赖和脚本。
{
"name": "generator-jekyllrb",
"version": "0.1.0",
"description": "Supercharge Jekyll development with Yeoman.",
"keywords": [
"yeoman-generator",
"jekyll",
"static",
"site"
],
"dependencies": {
"yeoman-generator": "^1.0.0"
},
"devDependencies": {
"mocha": "^3.0.0"
},
"scripts": {
"test": "mocha"
}
}
以上是 generator-jekyllrb
项目的基本教程,涵盖了目录结构、启动文件和配置文件的介绍。