11ty/eleventy-base-blog 使用教程

11ty/eleventy-base-blog 使用教程

eleventy-base-blog A starter repository for a blog web site using the Eleventy static site generator. 项目地址: https://gitcode.com/gh_mirrors/el/eleventy-base-blog

1. 项目目录结构及介绍

eleventy-base-blog 项目目录结构如下：

.
├── .github/
│   └── workflows/
├── _data/
├── _includes/
│   ├── layouts/
│   └── postslist.njk
├── content/
│   ├── about/
│   ├── blog/
│   └── index.njk
├── public/
│   ├── css/
│   └── js/
├── .editorconfig
├── .gitignore
├── .nojekyll
├── .nvmrc
├── LICENSE
├── README.md
├── eleventy.config.js
├── netlify.toml
├── package.json
└── vercel.json

• .github/workflows/：存放 GitHub Actions 工作流文件，用于自动化处理如代码审查、部署等任务。
• _data/：用于存储网站数据，如元数据、导航菜单等。
• _includes/：包含可重用的模板片段，如布局文件。
• content/：存放网站的内容文件，如博客文章、关于页面等。
• public/：存放静态文件，如 CSS、JavaScript 文件等。
• .editorconfig：定义代码编辑器的配置，确保不同开发者之间的一致性。
• .gitignore：定义 Git 忽略的文件和目录。
• .nojekyll：告诉 GitHub Pages 不要处理这个目录。
• .nvmrc：定义 Node.js 版本。
• LICENSE：项目的许可协议文件。
• README.md：项目的说明文件。
• eleventy.config.js：Eleventy 的配置文件。
• netlify.toml：Netlify 的配置文件。
• package.json：Node.js 项目配置文件。
• vercel.json：Vercel 的配置文件。

2. 项目的启动文件介绍

eleventy-base-blog 项目的启动主要通过 package.json 文件中的脚本实现。

在 package.json 文件中，你可以找到以下命令：

"scripts": {
  "start": "npx @11ty/eleventy --serve",
  "build": "npx @11ty/eleventy"
}

• start：启动一个本地开发服务器，用于实时预览你的网站更改。
• build：构建网站的生产版本，生成静态文件到 _site 目录。

你可以通过以下命令启动项目：

npm start

或者在构建生产版本时使用：

npm run build

3. 项目的配置文件介绍

eleventy.config.js 文件是 Eleventy 网站生成器的配置文件，用于自定义网站的行为。

以下是一些常见的配置选项：

module.exports = function(config) {
  // 配置支持的模板格式
  config.setTemplateFormats([
    'html', 'njk', 'md', 'txt'
  ]);

  // 配置布局文件路径
  config.addLayoutsDir('_includes/layouts');

  // 配置 passthrough 复制静态文件
  config.addPassthroughCopy('public');

  // 配置 Eleventy 插件
  config.addPlugin(require('eleventy-plugin-bundle'));

  // 其他自定义配置...
};

在这个文件中，你可以设置模板格式、添加布局文件、复制静态文件到输出目录、配置插件等，以自定义你的 Eleventy 项目。

eleventy-base-blog A starter repository for a blog web site using the Eleventy static site generator. 项目地址: https://gitcode.com/gh_mirrors/el/eleventy-base-blog