npm 包 express-simple-sitemap 使用教程

简介

express-simple-sitemap 是一个基于 Express.js 的轻量级网站地图生成器。

在网站中加入网站地图可以帮助搜索引擎更好地索引网站的内容。同时，网站地图也可以成为用户快速了解网站结构的方法。

安装

使用 npm 进行安装:

npm install express-simple-sitemap

使用

1. 引入模块

在 Express.js 应用中引入 express-simple-sitemap 模块。

const express = require('express');
const sitemap = require('express-simple-sitemap');
const app = express();

2. 配置

使用 sitemap 函数生成一个网站地图的实例。

const sitemapInstance = sitemap({
  // 配置选项
});

配置选项

• route: 地图的访问路径。默认为 /sitemap.xml。
• sitemap: 地图的配置选项。
• xmlStylesheet: 地图的 XSL 样式表。

地图的配置选项

• url: 网站的根 URL 地址。必填。
• pages: 网站地图中的页面，支持以下属性：
  • title: 页面的标题。
  • url: 页面的 URL。
  • lastmod: 页面的更新时间。可以使用 JavaScript Date 对象或 YYYY-MM-DD 格式的字符串。
  • changefreq: 页面的变更频率。
  • priority: 页面的优先级。

示例代码如下:

const sitemapInstance = sitemap({
  route: '/sitemap.xml',
  sitemap: {
    url: 'https://example.com',
    pages: [
      {
        title: '首页',
        url: '/',
        priority: 0.8,
        changefreq: 'daily'
      },
      {
        title: '关于我们',
        url: '/about',
        changefreq: 'monthly'
      },
      {
        title: '博客',
        url: '/blog',
        lastmod: new Date('2019-01-01')
      }
    ]
  }
});

3. 设置路由

在 Express.js 应用中添加地图的路由。

app.use('/', sitemapInstance);

示例代码

完整的示例代码如下:

const express = require('express');
const sitemap = require('express-simple-sitemap');

const app = express();
const sitemapInstance = sitemap({
  route: '/sitemap.xml',
  sitemap: {
    url: 'https://example.com',
    pages: [
      {
        title: '首页',
        url: '/',
        priority: 0.8,
        changefreq: 'daily'
      },
      {
        title: '关于我们',
        url: '/about',
        changefreq: 'monthly'
      },
      {
        title: '博客',
        url: '/blog',
        lastmod: new Date('2019-01-01')
      }
    ]
  }
});

// 将地图路由添加到应用中
app.use('/', sitemapInstance);

// 启动应用
app.listen(3000, () => console.log('Example app listening on port 3000!'));

总结

express-simple-sitemap 是一个简单易用的网站地图生成器，可以轻松帮助我们在 Express.js 应用中实现网站地图的功能。在开发中，使用网站地图能够更好地索引网站内容，提高网站在搜索引擎中的排名，同时也能够方便用户快速了解网站的结构。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/600673e2fb81d47349e53d9a