Sitemap

Writes sitemap.xml and robots.txt from the pages you built, with translations cross-referenced.

Add it

dotnet add package Nacara.Plugin.Sitemap --prerelease

Site.create "My library"
|> Site.origin "https://example.com"
|> Markdown.register
|> Sitemap.register

Site.origin is required. A sitemap holds absolute URLs, and only you know where your site is published. Leave it out and nothing is written, and the build tells you why:

! warning sitemap/origin-missing: No sitemap was written: the site does not say where it is published
    hint: Declare it with Site.origin "https://example.com"

The origin is never guessed: without it you get the warning and no file.

What you get

<url>
  <loc>https://example.com/guide/setup/</loc>
  <xhtml:link rel="alternate" hreflang="en" href="https://example.com/guide/setup/" />
  <xhtml:link rel="alternate" hreflang="fr" href="https://example.com/fr/guide/setup/" />
</url>

Translations cross-reference each other, so a search engine can offer a reader the language they asked for. That comes from locales with nothing to configure.

The origin also lets the default theme put <link rel="canonical"> on every page. That part is the theme's, and happens whether or not this plugin is registered.

Options

Leave out drafts, or anything else a search engine should not be offered:

|> Sitemap.registerWith (fun options ->
    { options with
        ExcludeCollections = [ "drafts" ]
    }
)

Turn WriteRobots off when you keep a robots.txt of your own in the static directory. Otherwise both want the same file and the build reports nacara/duplicate-output.

Versioned sites

Each version is its own build, so each one writes its own sitemap under its own prefix. Submit the current version's, and leave the older ones where they are for anyone who follows a link into them.

Reference

Every function and option of it, signature by signature: Sitemap.