Netlify Sitemap 插件项目教程

1. 项目目录结构及介绍

Netlify Sitemap 插件项目的目录结构如下：

netlify-plugin-sitemap/
├── .github/             # GitHub 仓库配置目录
├── .gitattributes       # Git 属性配置文件
├── .gitignore           # Git 忽略文件
├── .prettierrc.json     # Prettier 配置文件
├── CHANGELOG.md         # 更改日志
├── CODE_OF_CONDUCT.md   # 行为准则
├── CONTRIBUTING.md      # 贡献指南
├── LICENSE              # 许可证文件
├── README.md            # 项目说明文件
├── commitlint.config.js # Commit 校验配置文件
├── index.js             # 插件主文件
├── make_sitemap.js      # 生成 Sitemap 的脚本文件
├── manifest.yml         # Netlify 插件配置文件
└── package.json         # Node.js 项目配置文件

• .github/：包含 GitHub 仓库相关的配置文件。
• .gitattributes：配置 Git 属性，如忽略特定文件的换行符差异。
• .gitignore：定义 Git 忽略的文件和目录。
• .prettierrc.json：配置 Prettier 代码格式化工具的规则。
• CHANGELOG.md：记录项目历史版本的更改和更新。
• CODE_OF_CONDUCT.md：定义项目参与者的行为准则。
• CONTRIBUTING.md：提供贡献指南，帮助新贡献者了解如何参与项目。
• LICENSE：项目的 MIT 许可证。
• README.md：提供项目的概述、安装和使用说明。
• commitlint.config.js：配置提交信息校验规则。
• index.js：插件的主要逻辑。
• make_sitemap.js：生成 Sitemap 的 JavaScript 脚本。
• manifest.yml：定义 Netlify 插件的元数据和配置。
• package.json：定义 Node.js 项目的依赖和脚本。

2. 项目的启动文件介绍

项目的启动文件是 index.js。该文件包含 Netlify 插件的主要逻辑，负责监听 Netlify 网站的构建事件，并在构建完成后生成 Sitemap。

const { addPlugin } = require('@netlify/build');
const { generateSitemap } = require('./make_sitemap');

addPlugin({
  name: 'netlify-plugin-sitemap',
  onPostBuild: generateSitemap,
});

在这段代码中，使用 @netlify/build 包的 addPlugin 函数注册了一个插件，并在网站构建完成后调用 generateSitemap 函数生成 Sitemap。

3. 项目的配置文件介绍

项目的配置文件主要包括 manifest.yml 和 package.json。

manifest.yml 文件定义了插件的元数据和配置选项，如下所示：

name: netlify-plugin-sitemap
title: Netlify Sitemap Plugin
description: Automatically generate a sitemap for your site after it finishes building in Netlify.
inputs:
  buildDir:
    label: Build directory
    description: Directory where your static files are outputted
    default: 'public'
  exclude:
    label: Exclude paths
    description: List of paths or glob patterns to exclude from the sitemap
    default: []
  filePath:
    label: File path
    description: Path where the sitemap should be written
    default: 'sitemap.xml'
  prettyURLs:
    label: Enable pretty URLs
    description: Convert site.com/index.html to site.com/
    default: true
  trailingSlash:
    label: Append trailing slashes
    description: Append trailing slashes to pretty URLs
    default: false
  changeFreq:
    label: Change frequency
    description: Default change frequency for sitemap entries
    default: 'daily'
  priority:
    label: Priority
    description: Default priority for sitemap entries
    default: 0.5

package.json 文件定义了项目依赖和脚本，如下所示：

{
  "name": "netlify-plugin-sitemap",
  "version": "0.8.1",
  "description": "Automatically generate a sitemap for your site after it finishes building in Netlify.",
  "main": "index.js",
  "scripts": {
    "build": "make_sitemap.js"
  },
  "dependencies": {
    "@netlify/build": "^1.0.0"
  },
  "devDependencies": {
    "eslint": "^6.7.2",
    "prettier": "^2.0.5"
  }
}

在 package.json 中，定义了项目的入口文件 index.js，构建脚本 build，项目依赖和开发依赖。