https://github.com/stuyk/honkit-plugin-sitemap

A sitemap generator for the Honkit Documentation Engine.
https://github.com/stuyk/honkit-plugin-sitemap

Last synced: 20 days ago
JSON representation

A sitemap generator for the Honkit Documentation Engine.

• Host: GitHub
• URL: https://github.com/stuyk/honkit-plugin-sitemap
• Owner: Stuyk
• Created: 2021-03-15T22:28:28.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-16T00:45:21.000Z (almost 4 years ago)
• Last Synced: 2024-12-15T17:44:38.634Z (26 days ago)
• Language: JavaScript
• Size: 5.86 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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

```sh

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

```

## Usage

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

```json

{

    "plugins": ["sitemap"],

    "pluginsConfig": {

        "sitemap": {

            "url": "https://example.com"

        }

    }

}

```

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

```json

"pluginsConfig": {

    "sitemap": {

        "url": "https://example.com",

        "pathSuffix": "/yourSuffix/"

    }

}

```