Natural Push Machine

    tracey-plugin-breadcrumbs

    0.1.0 • Public • Published

    tracey-plugin-breadcrumbs

    Generates a breadcrumbs navigation for requirements.

    Usage

    Link requirements in a parent-child relationship using the frontmatter key parent

    Installation

    Install the plugin

    npm install tracey-plugin-breadcrumbs --save-dev

    Tracey configuration

    Add the plugin to the project configuration

    // tracey.config.js
    
    const BreadcrumbsPlugin = require('tracey-plugin-breadcrumbs');
    
    module.exports = {
        plugins: [
            BreadcrumbsPlugin({ /* configuration options */ }),
        ],
    };

    Plugin configuration

    The configuration object has the following options

    property

    Default: parent

    Use this option to configure the frontmatter key for linking requirements

    separator

    Default: >

    Use this option to configure the breadcrumb separator

    Keywords

    Install

    npm i tracey-plugin-breadcrumbs

    DownloadsWeekly Downloads

    1

    Version

    0.1.0

    License

    ISC

    Unpacked Size

    5.24 kB

    Total Files

    5

    Last publish

    Collaborators

    • k.hatvan