Nested Jekyll Menus

Demo of how to generate Jekyll menus dynamically based on project structure

Note

This project is no longer maintained.

_It is still a useful demo and prototype that I'll keep. But I have moved on to a bigger and better repo here: MichaelCurrin/fractal theme. Improvements include the listing.html layout is not needed and flexbox CSS styling has been used.

Purpose

The easy way to nest content in your Jekyll site and have menus auto-generate for you at each level.

Create directories and content pages in you Jekyll site using any number of nested levels and an index.md file at each level. Then use the logic in the project to iterate over all pages and filter to just the pages and directories at the current level. This is handled in two includes files which can be adapted to build a menu for a Jekyll site.

Demo

Here is the homepage of this demo site - it just has minimal styling.

One page doesn't really showcase the functionality of this project, so keep reading to see how this works. Or checkout my Cheatsheets where I took the prototype from this project and applied it there.

Navigation example

Structure

In this repo, we have the following file which is nested in a few levels of directories:

animals/reptiles/snakes/rattlesnake.md

The repo structure is like this. Note that the index.md pages are necessary to build the menu at each level.

Sample

animals/
    reptiles/
        snakes/
            rattlesnake.md
            index.md
        index.md
    index.md
index.md

On the frontend, the rendered page has these breadcrumbs displayed:

Using this project, it is easy to navigate from the Homepage to that nested page using menus which are generated dynamically at each level. So that if you move/rename/delete a page or directory, your menus will be rebuilt to match that new setup.

See the navigation steps below.

Level 1 - Home

Path: /

The Homepage knows about animals and food directories at the top-level.

Level 2 - Animals

Path: /animals/

Go into the Animals section and you'll see a listing of pages about animals and then sections (directories) to explore deeper.

Level 3 - Reptiles

Path: /animals/reptiles

If you go in Reptiles, you see types of reptiles.

Level 4 - Snakes

Path: /animals/reptiles/snakes/

Within Snakes, you can see these pages.

Level 5 - Rattlesnake

Path: /animals/reptiles/snakes/rattlesnake.html

Follow the the Rattlesnake page and you'll end up at this page, which is the final level.

Linking to files

If you want to link between files, you can do it using the link tag.

For example:

[Rattlesnake]({{ site.baseurl }}{% link animals/reptiles/snakes/rattlesnake.md %})

Using link is more verbose than a plain markdown link, but it gives security as your build will give you an error if the path is to a file that has been moved or renamed without the link to it also being updated.

How this project works

Understand how this project works then you can apply the pattern to your own project.

List files

See the list-pages.html and list-sections.html files in the _includes directory. Those form the core logic of this repo for getting files or directories which are exactly one level below the current page and build a menu from that. It can do that on any given page.

Those are used in the listing.html layout file, which means that any page with that layout will have those menus. Otherwise a page is just a stub and just has content and no menu.

Use this project directly by forking it and setting it up yourself. Or copy any list and layout files that you need.

Project structure

The only requirement for this pattern to build the directory structure is that there must be an index.md page at each level which has frontmatter that includes a page title.

Example of structure, relative to repo root:

Minimal
```
directory-1/
    index.md
index.md
```

Pages nested one level down

directory-1/
    file-a.md
    file-b.md
    ...
    index.md
    ...
    file-z.md
index.md

Directory nested in a directory:

directory-1/
    directory-2/
        file-a.md
        file-b.md
        ...
        index.md
        ...
        file-z.md
    file-a.md
    file-b.md
    ...
    index.md
    ...
    file-z.md
index.md

Note that the nesting levels do not have to be equal - you can have some paths which are shallow and some which are deep. If you decide that a page needs multiple pages, you can split just that page into a directory of multiple pages.

On the index.md page at each level needs to have a menu on it from the listing layout. The other pages can have just a page layout.

Examples:

directory-1/index.md

---
title: Directory 1
layout: listing
---

directory-1/file-a.md
```
---
title: File A
---
```

Note: Avoiding setting the listing layout as a default layout in the config - this causes memory issues and therefore a slow build on larger projects, due to looking for the index.md pages at multiple levels. Rather set the layout on eac file as above.

About

This approach here makes it easy to add and rename pages in a site without having to update a config file, as the menu is generated automatically based on your content. This is especially when there are nested levels and each level has a few files and folders.

The approach show the looks for pages and sections (directories) at the current level and adds those to a menu.

Note that a limitation of the approach here is that the order is assumed to be alphabetical rather than manually ordered, but that okay.

It is recommended to add breadcrumbs trail to your pages to help the user see where they are in the nested structure. See the breadcrumbs.html includes file which is used here.

This project used the Unsplash API to search for and embed images, to make this project more fun.

Other approaches

While the Minima Jekyll theme handles pulling pages into a navbar automatically, the idea here is that there are nested pages such as a collection and those need to appear in a nested navbar or in a table of contents menu which is appropriate for the current level.

Another approach would be to generate a menu as a config file. Or to generate a table of contents of the entire site - which can work in a nested navbar or a sidebar. But it can get overwhelming if there are many levels.

If you don't want to use the alphabetical auto-generated menus, you can make your own like this:

- [Foo]({% link foo/index.md %})
- [Bar]({% link bar/index.md %})
    - [Baz]({% link bar/baz.md %})

Documentation

To setup and run this project locally or on GitHub Pages, see the docs.

License

Released under MIT by @MichaelCurrin.

Please link back to this repo if you use a portion of it. Also include a copy of the original license.

Stock images provided from the unsplash.com Source API.

Breadcrumbs file is based on:

https://jekyllcodex.org/without-plugin/breadcrumbs/

michaelcurrin / nested-jekyll-menus Goto Github PK