Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: migrated the navigation metadata from inline MD title decorations to frontmatter #2485

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

paulcodiny
Copy link

@paulcodiny paulcodiny commented Feb 28, 2025

Currently the order and parenting in the navigation menu is controlled by a special syntax, added to a title of the document:

# Button >> Overview ||10

Internally this format is converted to frontmatter, which is understood by Eleventy:

---
parts: [ 'Overview', 'Button' ],
title: 'Button: Overview',
eleventyNavigation: {
    key: 'Button: Overview,
    title: 'Overview',
    order: 10,
    parent: 'Button'
}
---

The benefit of this approach is that is removes a boilerplate text. Note how many times words"Button" and "Overview" are duplicated above.

The downside is that it happens every time which slightly slows down the building time. Apart from it it decreases compatibility of the Lion MD files with other systems because they need a to support extended syntax of the markdown.

Copy link

changeset-bot bot commented Feb 28, 2025

⚠️ No Changeset found

Latest commit: a3d8d9c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant