SEO

MinimalDoc generates SEO-friendly output automatically.

Sitemap

A sitemap.xml is generated during build:

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://example.com/docs/</loc>
    <lastmod>2025-01-15</lastmod>
  </url>
  <url>
    <loc>https://example.com/docs/getting-started/</loc>
    <lastmod>2025-01-14</lastmod>
  </url>
</urlset>

Submit to search engines:

• Google Search Console
• Bing Webmaster Tools

Meta Tags

Title

Generated from frontmatter:

---
title: Installation Guide
---

Produces:

<title>Installation Guide - My Docs</title>

Override with SEO title:

---
title: Installation Guide
seo:
  title: How to Install MyProject - Complete Guide
---

Description

---
description: Step-by-step installation instructions
---

Produces:

<meta name="description" content="Step-by-step installation instructions">

Keywords

---
seo:
  keywords:
    - installation
    - setup
    - getting started
---

Produces:

<meta name="keywords" content="installation, setup, getting started">

Open Graph

For social media sharing:

---
title: MinimalDoc
description: Static site generator for documentation
seo:
  image: /images/social-card.png
---

Produces:

<meta property="og:title" content="MinimalDoc">
<meta property="og:description" content="Static site generator for documentation">
<meta property="og:image" content="https://example.com/images/social-card.png">
<meta property="og:type" content="article">
<meta property="og:url" content="https://example.com/docs/">

Twitter Cards

Also generates Twitter Card meta:

<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="MinimalDoc">
<meta name="twitter:description" content="Static site generator for documentation">
<meta name="twitter:image" content="https://example.com/images/social-card.png">

Canonical URLs

Specify canonical URL:

---
seo:
  canonical: https://example.com/docs/installation
---

Produces:

<link rel="canonical" href="https://example.com/docs/installation">

Robots Control

Noindex

Hide page from search engines:

---
seo:
  noindex: true
---

Produces:

<meta name="robots" content="noindex">

Nofollow

Prevent following links:

---
seo:
  nofollow: true
---

Both:

---
seo:
  noindex: true
  nofollow: true
---

Produces:

<meta name="robots" content="noindex, nofollow">

Base URL

Configure in config.yaml:

base_url: https://docs.example.com

Used for:

• Sitemap URLs
• Canonical URLs
• Open Graph URLs
• Absolute links

Clean URLs

Enable for SEO-friendly URLs:

clean_urls: true

Setting	URL
false	/docs/installation.html
true	/docs/installation/