criticalmashcriticalmash
8

Assemble Navigation

screenshot of Assemble Navigation

Creates navigation data for sites built with Assemble

Github

Overview

The Navigation Generator Plugin for Assemble is a powerful tool designed for developers and designers who want to streamline the creation of web projects. This plugin enables users to easily generate and inject hierarchal navigation data into a web page with minimal effort. With its recent public-beta release (version 0.4.1), developers can enjoy enhanced features while also benefiting from Assemble’s robust capabilities for rapid project prototyping.

Assemble itself is a versatile static site generator that caters to various project types, from blogs to API documentation. By integrating the Navigation Generator Plugin, users can automate their menu creation while maintaining flexibility in designing custom templates. Whether you’re building a complex site or a simple one, this navigation tool promises efficiency and ease of use.

Features

  • Hierarchical Navigation Generation: Automatically creates a hierarchal navigation structure based on the file and directory hierarchy, simplifying menu creation.

  • Integration with Assemble: Designed to work seamlessly with Assemble version 0.11 and later, ensuring compatibility for most web projects.

  • Custom Menu Support: Allows developers to easily create multiple menus (e.g., main, footer) and customize which pages appear in each.

  • Dynamic Data Context: Each page object includes metadata about its file location, providing essential context for rendering navigation structures.

  • Sensible Defaults: Comes with sensible default settings but can be overridden easily in the Assemblefile.js or front-matter, allowing for tailored navigation solutions.

  • CSS Class Adjustments: Offers the ability to modify menu item styles dynamically based on the current page and its parents, enhancing user experience and navigation clarity.

  • Navigation Helpers: Includes a collection of navigation-related helper functions to aid in building menus and breadcrumbs, making customizations easier for developers.

This plugin is an exceptional asset for anyone looking to enhance their web projects by providing quick, reliable navigation solutions.