Use of commas in section key breaks sub-navigation, breadcrumbs and search

[johnpauldickie]

Issue

When the section key includes commas in a page front matter (for example Publish, update or retire), it breaks the sub-navigation, breadcrumbs and search.

For the sub-navigation, the page (and any child pages) no longer appear in the sub-navigation and the sub-navigation doesn't appear on pages with the section key.

For the breadcrumbs, the page no longer shows breadcrumbs at all.

In search results, pages no longer appear in search where the section key includes a comma.

Attempted fixes

I've attempted to use standard ways to show that it's one string (rather than two), for example wrapping it in quotes (single and double) and using square brackets with quotes however non of these have fixed the issue.

[paulrobertlloyd]

Looks like this is a limitation of Eleventy’s navigation plugin, which is used to construct navigation menus.

The way around this is to explicitly define a navigation key on the parent page, and then use that key when addressing a parent from a child page. For example:

# parent page
---
title: Publish, update or retire
eleventyNavigation:
  key: publish-update-or-retire
---

# child page
---
title: Publishing a new document 
eleventyNavigation:
  parent: publish-update-or-retire
---

Let me know if this works!