Handlebars Layouts 项目教程
1. 项目的目录结构及介绍
handlebars-layouts/
├── examples/
│ ├── basic/
│ ├── partials/
│ ├── helpers/
│ └── layouts/
├── lib/
│ ├── handlebars-layouts.js
│ └── index.js
├── test/
│ ├── fixtures/
│ └── handlebars-layouts.test.js
├── .editorconfig
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── package.json
└── yarn.lock
- examples/: 包含各种使用示例,如基本示例、部分示例、助手示例和布局示例。
- lib/: 包含项目的主要代码文件,如
handlebars-layouts.js
和index.js
。 - test/: 包含项目的测试文件和测试数据。
- .editorconfig: 编辑器配置文件。
- .gitignore: Git 忽略文件配置。
- .npmignore: npm 忽略文件配置。
- .travis.yml: Travis CI 配置文件。
- LICENSE: 项目许可证。
- README.md: 项目说明文档。
- package.json: 项目依赖和脚本配置。
- yarn.lock: Yarn 依赖锁定文件。
2. 项目的启动文件介绍
项目的启动文件主要是 lib/index.js
,它导入了 handlebars-layouts.js
并注册了相关的布局助手。
'use strict';
var layouts = require('./handlebars-layouts');
module.exports = function (Handlebars) {
layouts.register(Handlebars);
return Handlebars;
};
3. 项目的配置文件介绍
项目的配置文件主要是 package.json
,它包含了项目的依赖、脚本和其他元数据。
{
"name": "handlebars-layouts",
"version": "4.0.0",
"description": "Handlebars helpers which implement layout blocks similar to Jade, Jinja, Nunjucks, Swig, and Twig.",
"main": "lib/index.js",
"scripts": {
"test": "mocha"
},
"repository": {
"type": "git",
"url": "git+https://github.com/shannonmoeller/handlebars-layouts.git"
},
"keywords": [
"handlebars",
"layout",
"partial",
"block",
"extends",
"helper"
],
"author": "Shannon Moeller <me@shannonmoeller.com> (http://shannonmoeller.com)",
"license": "MIT",
"bugs": {
"url": "https://github.com/shannonmoeller/handlebars-layouts/issues"
},
"homepage": "https://github.com/shannonmoeller/handlebars-layouts#readme",
"devDependencies": {
"chai": "^4.1.2",
"handlebars": "^4.0.11",
"mocha": "^5.0.1"
}
}
- name: 项目名称。
- version: 项目版本。
- description: 项目描述。
- main: 项目入口文件。
- scripts: 项目脚本,如测试脚本。
- repository: 项目仓库地址。
- keywords: 项目关键词。
- author: 项目作者。
- license: 项目许可证。
- bugs: 项目问题跟踪地址。
- homepage: 项目主页。
- devDependencies: 开发依赖包。