11ty-Website 项目使用教程
1. 项目目录结构及介绍
11ty-Website 是 Eleventy 静态网站生成器的文档网站。以下是项目的目录结构及各部分功能的简要介绍:
11ty-website/
├── .github/ # GitHub 工作流和模板
│ ├── ISSUE_TEMPLATE # Issue 模板
├── config/ # 配置文件目录
├── src/ # 源代码目录
│ ├── .eleventyignore # Eleventy 忽略文件
│ ├── .gitignore # Git 忽略文件
│ ├── .prettierignore # Prettier 忽略文件
│ ├── LICENSE # 许可证文件
│ ├── README.md # 项目说明文件
│ ├── eleventy.config.js # Eleventy 配置文件
│ ├── package.json # 项目依赖和脚本
│ ├── saved-author-redirects.json
│ └── vercel.json # Vercel 配置文件
2. 项目的启动文件介绍
项目的启动主要依赖于 package.json
文件中定义的 npm 脚本。以下是主要的启动脚本:
npm install
:安装项目依赖。npm run get-new-data
:获取新数据,用于更新文档内容。npx @11ty/eleventy --serve
:启动 Eleventy 服务器,默认端口为 8080。
启动项目后,你可以在浏览器中访问 http://localhost:8080/
来查看文档网站的实时预览。
3. 项目的配置文件介绍
项目的配置主要通过 eleventy.config.js
文件进行。以下是配置文件的一些主要部分:
module.exports = function(eleventyConfig) { ... }
:这是 Eleventy 配置的入口函数。eleventyConfig.addPassthroughCopy
:用于指定需要直接复制到输出目录的文件或文件夹。eleventyConfig.setUseGitIgnore
:设置是否使用.gitignore
文件来忽略文件。eleventyConfig.addTransform
:添加自定义转换,用于处理或修改内容。
通过修改 eleventy.config.js
文件,可以自定义 Eleventy 的行为,以适应不同的项目需求。