oriel

on this page

Turn any folder of Markdown into a beautiful website — instantly.

A folder of agent notes rendered as a live oriel site — nav, prose, KaTeX math, and an inline figure

pip install oriel
oriel serve .        # live site → http://127.0.0.1:18787

Point oriel at a folder and get a rendered, browsable site: prose with math, a wall of figures, dated-note journals — whatever's in there. Nothing is written to disk, and edits show on refresh, so the folder is the site.

Note

You're reading these docs through oriel — the docs/ folder rendered live (or frozen with oriel build). A folder of Markdown, viewed as a site, with no step in between.

The mental model

A folder is the site — oriel reads it on every request and renders on the fly:

in the folder on the site
loose .md at the top level pages (a root README.md is the home)
a subfolder of Markdown a nav tab
YYYY-MM-DD_*.md notes a dated journal with older/newer nav
images a browsable figures wall
HTML files live inline previews

No project to scaffold, no front matter to add. Want to customize — title, theme, figures? A single oriel.toml does it, or skip it.

When to reach for it

  • 📥 Agent output — read what Claude Code or a research run left behind (dated notes, plots, \(…\) math) as a real site, not raw files.
  • 🔗 An Obsidian vault — flat notes cross-linked with [[wikilinks]], browsable as-is. No export, no Obsidian Publish.
  • 🗂️ A working project view — keep oriel serve running; docs and figures stay current, never rebuilt.
  • 📓 A dated journal — a running log of notes plus a figures wall.
  • 🚀 Publishing — oriel build → static HTML for GitHub Pages, Netlify, or a zip.

How it compares

oriel markserv / live md MkDocs / Quarto
No build, no config ✅ ✅ ❌
Live on refresh ✅ ✅ ~
Figures wall + HTML preview ✅ ❌ ~
Dated-note journal nav ✅ ❌ ❌
Scoped read-only auth ✅ ❌ n/a
Plugin dashboards ✅ ❌ ~
Static export ✅ ❌ ✅
Footprint small Python package Node / Java Python + config

Start here

  • Guide → quickstart · serving · static export
  • Reference → configuration · plugins · math & LLM output · security
  • Themes → every bundled preset, light and dark