Nuxt Sitemap 模块使用教程

Nuxt Sitemap 模块使用教程

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

Nuxt Sitemap 模块的目录结构如下：

nuxt-sitemap/
├── lib/
│   ├── module.js
│   ├── plugin.js
│   ├── utils.js
│   └── sitemap.js
├── templates/
│   ├── sitemap.xml.ejs
│   └── robots.txt.ejs
├── package.json
├── README.md
└── LICENSE

目录结构介绍

• lib/: 包含模块的核心逻辑文件。
  • module.js: 模块的主文件，负责初始化和配置。
  • plugin.js: 插件文件，用于在 Nuxt 应用中注册 sitemap 功能。
  • utils.js: 工具函数文件，包含一些辅助函数。
  • sitemap.js: 处理 sitemap 生成的逻辑。
• templates/: 包含模板文件。
  • sitemap.xml.ejs: sitemap 的 XML 模板。
  • robots.txt.ejs: robots.txt 文件的模板。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的说明文档。
• LICENSE: 项目的许可证文件。

2. 项目的启动文件介绍

Nuxt Sitemap 模块的启动文件主要是 lib/module.js。这个文件负责初始化模块并注册到 Nuxt 应用中。

lib/module.js 文件介绍

import { resolve } from 'path'

export default function () {
  this.addPlugin({
    src: resolve(__dirname, 'plugin.js'),
    fileName: 'sitemap.js'
  })

  this.extendBuild((config) => {
    // 添加构建配置
  })
}

• addPlugin: 注册插件文件 plugin.js。
• extendBuild: 扩展构建配置，可以根据需要添加自定义构建逻辑。

3. 项目的配置文件介绍

Nuxt Sitemap 模块的配置文件通常在 nuxt.config.js 中进行配置。

nuxt.config.js 配置示例

export default {
  modules: [
    '@nuxtjs/sitemap'
  ],
  sitemap: {
    path: '/sitemap.xml',
    hostname: 'https://example.com',
    gzip: true,
    exclude: [
      '/secret',
      '/admin/**'
    ],
    routes: [
      '/page1',
      '/page2',
      {
        url: '/page3',
        changefreq: 'daily',
        priority: 1,
        lastmod: new Date()
      }
    ]
  }
}

配置项介绍

• path: sitemap 文件的路径。
• hostname: 网站的域名。
• gzip: 是否启用 gzip 压缩。
• exclude: 需要排除的 URL 路径。
• routes: 需要包含在 sitemap 中的路由配置。
  • url: 页面的 URL。
  • changefreq: 页面更新频率。
  • priority: 页面的优先级。
  • lastmod: 页面上次修改时间。

通过以上配置，可以灵活地生成符合需求的 sitemap 文件。