Sitemap Generator for Honkit

Generate a sitemap for the Honkit Documentation. The output sitemap file is sitemap.xml and copied automatically.

This updates some older versions of this plugin from Gitbook to the modern era.

Install

npm install honkit-plugin-sitemap --save-dev

Usage

Add it to your book.json with a basic configuration:

{
    "plugins": ["sitemap"],
    "pluginsConfig": {
        "sitemap": {
            "url": "https://example.com"
        }
    }
}

If you use a prefix for your domain use...

"pluginsConfig": {
    "sitemap": {
        "url": "https://example.com",
        "pathSuffix": "/yourSuffix/"
    }
}