Eleventy Netlify Boilerplate 使用教程

Eleventy Netlify Boilerplate 使用教程

eleventy-netlify-boilerplateA template for building a blog with the Eleventy static site generator and Decap CMS项目地址:https://gitcode.com/gh_mirrors/el/eleventy-netlify-boilerplate

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

eleventy-netlify-boilerplate/
├── _data/
│   └── metadata.json
├── _includes/
│   └── admin/
├── pages/
├── posts/
├── static/
│   └── img/
├── .eleventy.js
├── .eleventyignore
├── .gitignore
├── .nvmrc
├── 404.md
├── LICENSE
├── README.md
├── author.njk
├── authors.njk
├── favicon.ico
├── netlify.toml
├── package.json
└── tags.njk

目录结构介绍

• _data/: 包含全局数据文件，如 metadata.json，用于存储站点标题和作者详情。
• _includes/: 包含模板文件，如 admin/ 目录下的文件。
• pages/: 包含页面的 Markdown 文件。
• posts/: 包含博客文章的 Markdown 文件。
• static/: 包含静态资源，如图片等。
• .eleventy.js: Eleventy 的配置文件。
• .eleventyignore: 指定 Eleventy 忽略的文件和目录。
• .gitignore: Git 忽略文件。
• .nvmrc: Node 版本管理文件。
• 404.md: 404 错误页面。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• author.njk: 作者模板文件。
• authors.njk: 作者列表模板文件。
• favicon.ico: 网站图标。
• netlify.toml: Netlify 配置文件。
• package.json: 项目依赖和脚本配置文件。
• tags.njk: 标签模板文件。

2. 项目的启动文件介绍

启动文件

• .eleventy.js: 这是 Eleventy 的主要配置文件，用于配置 Eleventy 的行为和选项。

启动步骤

1. 克隆项目：

   git clone https://github.com/danurbanowicz/eleventy-netlify-boilerplate.git
   

2. 进入项目目录：

   cd eleventy-netlify-boilerplate
   

3. 安装依赖：

   npm install
   

4. 运行项目：

   npx @11ty/eleventy --serve
   

3. 项目的配置文件介绍

配置文件

• .eleventy.js: 配置 Eleventy 的行为，如模板引擎、输入输出目录等。
• netlify.toml: 配置 Netlify 的部署选项，如构建命令、发布目录等。
• package.json: 包含项目的依赖和脚本，如 start、build 等命令。

配置示例

.eleventy.js

module.exports = function(eleventyConfig) {
  // 添加自定义配置
  eleventyConfig.addPassthroughCopy("static");
  eleventyConfig.addPassthroughCopy("favicon.ico");

  return {
    dir: {
      input: ".",
      includes: "_includes",
      data: "_data",
      output: "_site"
    },
    templateFormats: ["njk", "md"],
    htmlTemplateEngine: "njk",
    markdownTemplateEngine: "njk"
  };
};

netlify.toml

[build]
  command = "npm run build"
  publish = "_site"

package.json

{
  "name": "eleventy-netlify-boilerplate",
  "version": "1.0.0",
  "description": "A template for building a blog with the Eleventy static site generator and Decap CMS",
  "scripts": {
    "start": "npx @11ty/eleventy --serve",
    "build": "npx @11ty/eleventy"

eleventy-netlify-boilerplateA template for building a blog with the Eleventy static site generator and Decap CMS项目地址:https://gitcode.com/gh_mirrors/el/eleventy-netlify-boilerplate