SEO

Each page's head comes from its front matter (see Front matter):

  • title is the page's title, and defaults to its first heading. The document <title> is the page's title and the site title, Installation | My site, from the titleTemplate option, and a version's home page is titled with the site title. An explicit <title> in the Markdown takes its place.
  • description is <meta name="description">.
  • head.meta adds <meta name> entries, head.og adds Open Graph <meta property="og:…"> entries, and head.canonical is the page's <link rel="canonical">.
---
title: Installation
description: Install the project and run your first example.
head:
  og: { image: https://example.com/social.png, type: article }
---

These are HTML Next head declarations in the page component's <defs>, which MarkupKit renders into the document head. A page's title, meta names and canonical link win over its layout's.

Canonical pages

The site root serves the default version, and its pages are the canonical copies. The same pages under /v/<default>/ link to their root copy as canonical, as do a page's aliases (see Versions).

Language alternates

With origin and locales configured, Markupress emits reciprocal rel="alternate" links for translations sharing a document identity in the same version, plus x-default for an available default-locale counterpart. Missing translations are omitted. Aliases retain their page's canonical group. See Languages.

Sitemap and robots.txt

With the origin option, such as "https://example.com", build writes sitemap.xml at the base, listing each page at its canonical URL. The robots option writes robots.txt: true allows every crawler, and a string is the file's text. With origin set, robots.txt ends with a Sitemap line.

{ "origin": "https://example.com", "base": "/docs/", "robots": true }
Edit this page

Last updated