Nuxt Navi

Nuxt.js module for building an Array of navigation routes

📖 Release Notes

Overview

This modules takes a YAML file that sets an array of routes and then adds it to the Store.

The only required property for each route is title. For each route, if no path property is set then nuxt-navi automically slugifies that title.

Setup

1. Add nuxt-navi dependency to your project

   yarn add nuxt-navi # or npm install nuxt-navi

2. Add nuxt-navi to the buildModules section of nuxt.config.js if you are using Nuxt v2.9 or later. Otherwise, use the modules section.

   {
     modules: [
       // Simple usage
       "nuxt-navi",
   
       // With options
       [
         "nuxt-navi",
         {
           /* module options */
         }
       ]
     ];
   }

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using npm run dev

License

MIT License

Copyright (c) David Royer [email protected]