hexo-breadcrumb

Generate breadcrumb for Hexo

1.2.4
latest
Source
npm

Version published: 4 months ago

Weekly downloads: 1; decreased by-92.31%

Maintainers: 0

Weekly downloads

Created: 7 years ago

Source

A Hexo plugin to generate breadcrumb navigation for post and page layouts.

Features

Compatible with post and page layouts.
Set custom title for the home page.
Customize delimiter and styling.
Accessible navigation with ARIA attributes of navigation.

Installation

ni: ni hexo-breadcrumb -D
npm: npm i hexo-breadcrumb -D
yarn: yarn add hexo-breadcrumb -D
pnpm: pnpm add hexo-breadcrumb -D

Usage

Configuration

In _config.yml file, specify the breadcrumb settings as following:

breadcrumb:
  delimiter:
    # /, >, etc.
    content: "/"
    # Applied on ::after pseudo element.
    style: "font-weight: bold;"
  aria:
    nav: "Breadcrumb"
  homepage:
    # Customize the title for the homepage in the breadcrumb.
    title: Home
  templates:
    - layout: post
      tokens:
        - home
        - category
        - title
    - layout: page
      tokens:
        - home
        - title

Integration with Hexo themes

Add the following snippets to a layout file in order to display the breadcrumb.

<%- page.breadcrumb %>

License

This project is licensed under the MIT License.

Keywords

FAQs

What is hexo-breadcrumb?

Is hexo-breadcrumb popular?

Is hexo-breadcrumb well maintained?

Package last updated on 04 Oct 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install