honkit-plugin-breadcrumbs v0.0.2

honkit-plugin-breadcrumbs

This is a Honkit plugin for displaying breadcrumbs.

Installation

npm install honkit-plugin-breadcrumbs

Add this plugin into book.json.

{
  "plugins": ["breadcrumbs"]
}

Configuration

book.json add the options

"pluginsConfig": {
  "breadcrumbs": {
    "subdir": "/subdir/", // You can be specified when the root is a subdirectory.
    "home": "HOME",       // You can specify the character that root.
    "separator": ">",     // You can specify the character that separator.
    "aliases": [          // You can specify aliases.
      {"path": "posts", "alias": "articles"}
    ] 
  }
}