Skip to content

Using front matter to drive navigation placement #127

@desktophero

Description

@desktophero

Love the updates and approach to awesome navigation from the project.

Sort of similar to #85 but not looking to take actions like sorting.

Sorting was called out as not possible so wanted to see if frontmatter is either an existing option or something that would be of interest for a roadmap item and contribution.

I have a use case where I want to be able to use frontmatter to set a status for a particular markdown file. The purpose of the file is an architecture decision record. I would like to have an ADR section in nav and then be able to place the same rendered page into different navigation sections.

I see how I could sort of do this with filename regexes but that sort of has a smell and would be harder to reuse the metadata.

An example would be something like:

---
status: accepted
portfolio: commercial
<snip>
----
Markdown content

And then have navigation for both portfolio and status that would link to the same page. But navigation would look something like:

- ADRs:
  - All ADRs
  - By Portfolio:
    - Commercial
    - ...
  - By Status:
    - Accepted
    - ...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions