Sitemap

A sitemap is a structured list of pages that enables web crawlers to find the pages of a site. getSitemap provides SEO information about the pages created within Makeswift. You can combine the results of getSitemap with SEO information for your hardcoded pages to create a sitemap.

AnchorVersions

AnchorExamples

AnchorUsing next-sitemap

Here is an example using getSitemap with next-sitemap a popular Next.js library for generating sitemaps.

import { Makeswift } from '@makeswift/runtime/next'
import { GetServerSidePropsContext, GetServerSidePropsResult } from 'next'
// Use `getServerSideSitemapLegacy` for sitemap entries in the pages directory.
import { getServerSideSitemapLegacy } from 'next-sitemap'

import { runtime } from '@lib/makeswift'

export async function getServerSideProps(
  ctx: GetServerSidePropsContext,
): Promise<GetServerSidePropsResult<{}>> {
  const makeswift = new Makeswift('<makeswift_site_api_key>', { runtime })
  const sitemap = await makeswift.getSitemap()

  return getServerSideSitemapLegacy(ctx, sitemap)
}

export default function Sitemap() {}

AnchorCreating a sitemap for a subset of pages

The getSitemap method supports filtering results by a pathname prefix using the pathnamePrefix parameter.

import { Makeswift } from '@makeswift/runtime/next'
import { GetServerSidePropsContext, GetServerSidePropsResult } from 'next'
import { getServerSideSitemapLegacy } from 'next-sitemap'

import { runtime } from '@lib/makeswift'

export async function getServerSideProps(
  ctx: GetServerSidePropsContext,
): Promise<GetServerSidePropsResult<{}>> {
  const makeswift = new Makeswift('<makeswift_site_api_key>', { runtime })
  const blogSitemap = await makeswift.getSitemap({ pathnamePrefix: '/blog/' })

  return getServerSideSitemapLegacy(ctx, blogSitemap)
}

export default function BlogSitemap() {}

AnchorUsing pagination

The getSitemap method is paginated with a default page size of 50. If you want to request more pages or use a different page size pass the limit and after arguments.

import { Makeswift, Sitemap } from '@makeswift/runtime/next'
import { GetServerSidePropsContext, GetServerSidePropsResult } from 'next'
import { getServerSideSitemapLegacy } from 'next-sitemap'

import { runtime } from '@lib/makeswift'

export async function getServerSideProps(
  ctx: GetServerSidePropsContext,
): Promise<GetServerSidePropsResult<{}>> {
  const makeswift = new Makeswift('<makeswift_site_api_key>', { runtime })

  const sitemap: Sitemap = []
  let page: Sitemap = []
  let after: string | undefined = undefined

  do {
    page = await makeswift.getSitemap({ limit: 10, after })

    sitemap.push(...page)
    after = page.at(-1)?.id
  } while (page.length > 0)

  return getServerSideSitemapLegacy(ctx, sitemap)
}

export default function Sitemap() {}

AnchorSitemap for localized site

If a locale is using domain-based localization, passing the locale to getSitemap will return the sitemap for that particular domain.

For example, if in the site settings there is an es locale with a domain of foo.es, then passing es to getSitemap will return the sitemap for foo.es.

import { Makeswift } from '@makeswift/runtime/next'
import { GetServerSidePropsContext, GetServerSidePropsResult } from 'next'
import { getServerSideSitemapLegacy } from 'next-sitemap'

import { runtime } from '@lib/makeswift'

export async function getServerSideProps(
  ctx: GetServerSidePropsContext,
): Promise<GetServerSidePropsResult<{}>> {
  const makeswift = new Makeswift('<makeswift_site_api_key>', { runtime })
  const sitemap = await makeswift.getSitemap({
    locale: 'es',
  })

  return getServerSideSitemapLegacy(ctx, sitemap)
}

export default function Sitemap() {}

AnchorAPI

AnchorParameters

AnchorTypes

type Sitemap = {
  id: string
  loc: string
  lastmod?: string
  changefreq?: 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never'
  priority?: number
  alternateRefs?: {
    hreflang: string
    href: string
  }[]
}[]