rxdn / mdbook-sitemap-generator

Utility to generate a sitemap.xml file for an mdbook project

mdbook-sitemap-generator

What is this?

mdbook-sitemap-generator is a simple utility to generate sitemap.xml files for mdbook projects.

Installation

Binaries are distributed on the Github Releases Page.

It is also possible to install this utility via cargo, using cargo install mdbook-sitemap-generator.

Usage

The utility should be run from the root of the project.

USAGE:
    mdbook-sitemap-generator [OPTIONS] --domain <DOMAIN>

OPTIONS:
    -d, --domain <DOMAIN>
    -h, --help               Print help information
    -o, --output <OUTPUT>

When running the utility, you must pass the site's domain on URL via the -d flag, for example, -d docs.example.com.

If the -o flag is not passed, the sitemap will be written to stdout.

For example:

$ ls
book  book.toml  src
$ mdbook-sitemap-generator -d docs.example.com -o book/sitemap.xml

mdbook-sitemap-generator's Issues

Incorrrect sitemap?

Hi there! I just created a sitemap, hosted it and submitted it to google, but got a couple of errors:

Sitemap can be read, but has errors
Invalid XML tag
96 instances
This tag was not recognised. Please fix it and resubmit.
Examples
Line 1
Parent tag:
urlset
Tag:
urls
Line 1
Parent tag:
urlset
Tag:
urls
Line 1
Parent tag:
urlset
Tag:
urls
Missing XML tag
1 instance
This required tag is missing. Please add it and resubmit.
Examples
Line 1
Parent tag:
urlset
Tag:
url
Incorrect namespace
1 instance
Your Sitemap or Sitemap index file does not properly declare the namespace.
Examples
Line 1
Tag:
urlset