simple-sitemap-renderer

simple-sitemap-renderer

A bare minimum sitemap renderer written in TypeScript.

Features

• Render standard sitemap XML
• Zero-dependencies
• Written in TypeScript

💻 Installation

$ npm i simple-sitemap-renderer

or

$ yarn add simple-sitemap-renderer

🎈 Usage

import { renderSitemap } from 'simple-sitemap-renderer'

renderSitemap([
  {
    url: 'https://your-site/your-page-1',
    lastmod: '2020-10-10',
    changefreq: 'always',
    priority: 0.8,
  },
  {
    url: 'https://your-site/your-page-2',
    lastmod: '2020-10-10',
  },
  {
    url: 'https://your-site/your-page-3',
  },
])

Rendered Result

the sample here is formatted for readability, but actual result will always be minified.

<?xml version="1.0" encoding="UTF-8"?>
<urlset>
  <url>
    <loc>https://your-site/your-page-1</loc>
    <lastmod>2020-10-10</lastmod>
    <changefreq>always</changefreq>
    <priority>0.8</priority>
  </url>
  <url>
    <loc>https://your-site/your-page-2</loc>
    <lastmod>2020-10-10</lastmod>
  </url>
  <url>
    <loc>https://your-site/your-page-3</loc>
  </url>
</urlset>

API

renderSitemap(entries: Entry[], options?: RenderOptiopns)

returns sitemap xml string.

Entry

type Entry = {
  url: string
  lastmod?: string // yyyy-mm-dd
  changefreq?: ChangeFreq // always|hourly|daily|weekly|monthly|yearly|never
  priority?: number // 0.0 ~ 1.0
}

RenderOptiopns

type RenderOptiopns = {
  encodeUrl?: boolean
}

• encodeUrl: If you want this libary to encode urls for you, set it to true. (Otherwise, you don't need this option.)