Post Types
Contents
The type: frontmatter field controls how OnyxFolio registers and renders a note. There are four types.
Regular post (default)
No type: field (or any unrecognised value):
---
website: true
title: My Post
date: 2026-04-16
---
- Served at
/<section>/<slug>or/<slug>for vault-root notes. - Appears in section listings, search, and RSS feeds.
- Uses the
post.htmltemplate.
type: homepage
type: homepage
- Renders this note's own markdown content at the section root URL.
- Root note (
/) — the site homepage, usesindex.html. - Subfolder note (
blog/) — the section homepage at/blog, usesindex.html. - Does not appear in listings, search, or RSS.
- The root homepage's
titlebecomes the globalWEBSITE_NAMEshown in the browser title and nav. - Root-only fields:
show_search,show_tags.
Each section can have at most one type: homepage. If multiple files in the same folder declare type: homepage, the last one loaded wins (undefined behaviour — avoid).
type: listing
type: listing
- Auto-generates a paginated post index at the section root URL.
- Lists all posts in the section (and sub-sections), sorted by date.
- Featured posts (with
featured: true) appear in a separate highlighted area at the top. - Does not appear in listings, search, or RSS.
- Uses the
listing.htmltemplate. - Intro content from the listing note's own body (if any) is shown above the post list.
Each section can have at most one type: listing.
Auto-listing fallback
If a section has posts but no explicit listing or homepage file, OnyxFolio automatically creates a minimal listing route for that section. The title is derived from the folder name.
type: book
type: book
- A specialised post type for long-form content with a cover image and metadata header.
- Uses the
book.htmltemplate instead ofpost.html. - The first
<img>paragraph in the body is extracted and rendered as a cover image in the template header — it does not appear in the body. - Appears in listings, search, and RSS like a regular post.
Typical use: book reviews, long essays, or any note where a prominent cover image + metadata header makes sense.
Choosing between listing and homepage
| Need | Use |
|---|---|
| Auto-generated post index for a section | type: listing |
| Custom intro page for a section with your own content | type: homepage |
| Site root with custom content | type: homepage at vault root |
| Book/long-form post with cover image | type: book |
| Regular post | omit type |
See also
- Navigation — how section roots appear in the nav bar
- Pagination — how listing pages paginate
- Publishing and Privacy —
website: trueand private notes - SEO and Metadata — how
type: bookuses JSON-LD Book schema