gitdocs/src/core/sitemap.js

Easy to use, SEO-friendly, beautiful documentation that lives in your git repo.

const { minify } = require('html-minifier')

class Sitemap {
  constructor () {
    this.urls = []
    this.urlMap = {}
  }

  addUrl (url, data = {}) {
    const filename = data.filename || 'unknown_file'
    const merged = Object.assign({}, {
      loc: url,
      priority: 0.5,
      changefreq: null,
      lastmod: null,
    }, data)

    if (this.urlMap[url]) {
      const duplicated = [url, filename, this.urlMap[url]]
      throw new Error(`Duplicated URL was found: ${duplicated.join('\n\t- ')}`)
    }

    this.urlMap[url] = filename
    this.urls.push(merged)
  }

  generate () {
    return minify(`
      <?xml version="1.0" encoding="UTF-8"?>
      <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
        ${this.urls.map(data => `
          <url>
            ${data.loc ? `<loc>${data.loc}</loc>` : ''}
            ${data.lastmod ? `<lastmod>${data.lastmod}</lastmod>` : ''}
            ${data.changefreq ? `<changefreq>${data.changefreq}</changefreq>` : ''}
            ${data.priority ? `<priority>${data.priority}</priority>` : ''}
          </url>
        `).join('\n')}
      </urlset>
    `, {
      collapseWhitespace: true,
    })
  }
}

module.exports = Sitemap