Git Product home page Git Product logo

topicmenu's Introduction

Grav Topic Menu Plugin

topicmenu is a simple Grav plugin that traverses a portion of a website, typically /blog, and creates a two-dimensional array containing a first level taxonomy and each second level taxonomy associated with them.

Said another way, it returns an array like this: topicmenu_array[level_1][level_2]. If the level_1 taxonomy was a blog category and the level_2 taxonomy was the post tags, you’d have an array that listed all the tags that were associated with each category.

That array is then available to your Twig templates as the variable topics_tags.

Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to topicmenu. You can find these files on GitHub.

You should now have all the plugin files under

/your/site/grav/user/plugins/topicmenu

NOTE: This plugin is a modular component for Grav which requires Grav to function

Usage

The plug-in is enabled by default and will automatically start working. To configure or disable it, copy the user/plugins/topicmenu/topicmenu.yaml to user/config/plugins/topicmenu.yaml and make your modifications.

enabled: true                  # global enable/disable the entire plugin
page_page: /blog			   # set the starting path of the files to traverse
taxonomy_level_1: topic        # set the first level of the taxonomy to use
taxonomy_level_2: tag          # set the first level of the taxonomy to use

topicmenu's People

Contributors

bobrocke avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.