Features
Contents
Editor compatibility
OnyxFolio reads standard `.md` files with YAML frontmatter — it works with any text editor. The features below are fully unlocked when writing in **[Obsidian](https://obsidian.md)**. The closest alternatives are [Foam](https://foambubble.github.io/foam/) (VS Code) and [Logseq](https://logseq.com) (Markdown mode).
Obsidian-native syntax
Everything rendered server-side — no client-side plugins required.
- Callouts —
> [!tip] Title→ styled callout boxes; collapsible with> [!type]-or pinned open with> [!type]+— docs - Wiki-links —
[[Note]],[[Note|alias]],[[Note | alias]],[[Note#Heading]],[[Note^block-id]]— all resolve correctly even when filename, title, and slug differ — docs -
Image embeds —
![[file.jpg]]→ lightbox; multiple on one line → slider;![[photo.jpg|Caption]]→ figcaption — docs -
Audio embeds —
![[file.mp3]]→<audio>element; supports.mp3,.ogg,.wav,.flac,.m4a— docs - Checkboxes —
- [ ]/- [x]→ HTML checkbox lists with nested indentation — docs - Highlights —
==text==→<mark>— docs - Footnotes —
[^1]syntax — docs - Block references —
^block-idon a paragraph creates an anchor target — docs
Math and diagrams
- Mermaid — fenced
```mermaid ```blocks rendered client-side; adapts to dark/light theme — [[Math and Diagrams|docs]] - LaTeX / KaTeX —
$inline$and$$block$$; expressions protected from the markdown parser before rendering — [[Math and Diagrams|docs]]
Dataview
Server-side execution of Dataview queries in fenced ```dataview ``` blocks — docs:
TABLEandLISTquery typesFROM(tags or folders),WHERE,SORT,LIMIT,GROUP BYwith per-group headings- Inline queries —
`= this.field`evaluated against the current note's frontmatter
Publishing and content
- Private notes — notes without
website: trueare invisible as web pages but fully queryable by Dataview — docs - Aliases —
aliases:frontmatter registers alternate wiki-link names — docs - Author field —
author:shown in post meta and JSON-LD — docs - Date last modified —
updated:frontmatter shows "Updated …" in post meta — docs - Banner images —
banner: "url"in frontmatter for a hero image;banner_x/banner_ycontrol focal point — docs
Navigation and discovery
- Auto-generated nav — top-level vault folders automatically appear as nav links — docs
- Nav pinning —
menu_order: Nin frontmatter pins any page to the top nav — docs - Breadcrumb navigation —
Home › Section › Posttrail on every post — docs - Related posts — automatic "See also" scored by shared tags and section — docs
- Next / previous navigation — "← Older" / "Newer →" links at the bottom of each post — docs
- Tags —
tags:frontmatter + inline#hashtagbody mentions; clickable badges;/tag/<name>archive pages;/tagsindex (opt-in:show_tags: true) — docs - Search — full-text search at
/searchwith tag filter (opt-in:show_search: true) — docs - Pagination — listing pages paginate at 20 posts per page — docs
Feeds, SEO, and metadata
- RSS feeds — site-wide at
/feed.xml; per-section at/<section>/feed.xml— docs - Sitemap — auto-generated at
/sitemap.xml— docs - OpenGraph / Twitter Card — per-page meta tags; uses banner image if set — docs
- JSON-LD — Article, Book, and WebSite schemas for rich Google results — docs
Developer experience
- Hot-reload — server watches file modification times and reloads on any change; no restart needed — docs
- Syntax highlighting — fenced code blocks with language labels, copy button, and Tokyo Night Dark theme — docs
- Dark / light mode — toggle in header; preference persisted in
localStorage— docs - Mobile nav — collapsible hamburger menu on narrow viewports (≤ 600 px)
- Print stylesheet —
@media printhides nav, resets colours, appends link URLs inline - Custom 404 — styled 404 page consistent with the rest of the site
- Reading time — estimated reading time on post pages and listing cards
- Vault-wide attachments — media resolution falls back to vault root
_attachments/thenATTACHMENTS_PATHfrom.env— docs