Improve documentation for breadcrumbs
Nobody has claimed this yet.
- Dominant language
- Nunjucks
- Stars
- 547
- Forks
- 726
- Avg merge
- 2h 23m
- Merged PRs (30d)
- 3
Description
The documentation for rendering breadcrumbs with Eleventy Navigation (here) would be more helpful if it showed the most common use case, rendering breadcrumbs for the current page. This would help new users to get started quickly and also help them avoid the pitfall of attempting to load breadcrumb info on a page without a navigation key (which causes an unclear error of Node does not exist: undefined).
E.g. for Liquid:
{% if eleventyNavigation.key %}
{{ collections.all | eleventyNavigationBreadcrumb: eleventyNavigation.key | eleventyNavigationToHtml }}
{% endif %}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the linked Eleventy Navigation documentation section, especially “Render the menu items using the eleventy-navigation-to-html or eleventy-navigation-to-markdown filters.” Add the Liquid current-page breadcrumb example with the navigation-key guard and explain the undefined-key pitfall; it is done when new users can follow the example without triggering that error.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100