Navigation
Contents
OnyxFolio builds all site navigation automatically from vault structure and frontmatter. No config files or menus to maintain.
Top navigation bar
Auto-generated section links
Every top-level vault folder that has a type: listing or type: homepage note appears as a nav link. The link text is the section title; the URL is the section root.
Example vault structure:
blog/
Blog Index.md ← type: listing → nav link "Blog" → /blog
gallery/
Gallery.md ← type: homepage → nav link "Gallery" → /gallery
The order of auto-generated section links is alphabetical by URL.
Pinned nav items
Any note with menu_order: N in its frontmatter is appended to the nav after the auto-generated section links:
menu_order: 1 # lower = further left
Multiple notes can be pinned. They are sorted by menu_order value (ascending). This is the intended mechanism for standalone pages like About or Contact.
Search and Tags links
Opt-in nav links controlled by root homepage frontmatter:
show_search: true # adds "Search" link
show_tags: true # adds "Tags" link
Breadcrumb trail
Every post page shows a breadcrumb trail: Home › Section › Post.
- Each segment links to its URL if that URL has a section route.
- The final segment (current post) is plain text — no link.
- Breadcrumbs are built from the URL path, not the folder structure directly.
Previous / next post navigation
Each post page shows ← Older and Newer → links at the bottom, navigating to the adjacent post within the same section, ordered by date.
- Posts without a date are excluded from prev/next ordering.
- Adjacent posts are computed within the same section — cross-section navigation is not included.
Related posts
Below each post, OnyxFolio shows up to 4 related posts. The relevance score is:
score = (shared tags × 2) + (same section ? 1 : 0)
Ties are broken by date (newest first). Posts with no shared tags and no section match are not shown.
Related posts are pre-computed at vault load time — O(n²) once, O(1) per request.
Mobile navigation
On narrow viewports (≤ 600 px), the nav collapses to a hamburger menu. Tapping the icon expands the full nav list.
See also
- Post Types — how
type: listingandtype: homepagecreate section roots - Frontmatter Reference —
menu_order,show_search,show_tags - Tags — the
/tagsindex page - Search — the
/searchpage