Documentation Theme

Documentation that reads like an unrolled manuscript.

Makimono is an Astro documentation theme for product teams and developer tools that want reference material to feel tactile, legible, and authored.

Read the Docs Browse API

Highlights

Collapsible manuscript sidebar
Searchable knowledge index
Ink-wash code block treatment
GSAP unroll and reveal sequences

Rhythm

Documentation paced like a reading surface, not a dashboard.

Makimono uses measured gutters, section seams, and restrained type to keep dense technical content calm.

Motion

An opening sequence that feels like a scroll being unbound.

The hero, chapter rails, and code samples reveal with deliberate motion so the first interaction feels authored.

Structure

Reference systems built for depth, not marketing gloss.

Breadcrumbs, local ToC, and sidebar search keep orientation intact even when content runs long.

Chapter Map

Every route is organized like a manuscript chapter with its own pace and local wayfinding.

Section 01

Getting Started

Introduction Theme philosophy, IA, and manuscript reading rhythm. Installation Project setup, content collections, and first launch.

Section 02

Guides

Authoring Docs How to structure pages, callouts, and embedded examples. Search and Discovery Sidebar search, wayfinding, and long-scroll reading patterns.

Section 03

Patterns

API Content Patterns Schemas for endpoints, parameters, examples, and edge cases.

Reference Surface

API layouts tuned for long sessions, examples, and migration-oriented reading.

GET /v1/documents/{slug}

Documents

Fetch a fully rendered document with navigation context, table of contents, and edit metadata.

ETag support
locale-aware slug resolution
draft gating

POST /v1/search

Search

Search the knowledge base with weighted title, heading, and excerpt ranking optimized for doc retrieval.

prefix matching
section boosting
keyboard-first UI

GET /v1/releases

Changelog

Return release notes grouped by stream with upgrade notes and related document pointers.

semver filters
date windows
linked migration guides

Recent Releases

Release notes treated like editorial inserts instead of flat version logs.

v0.4.0

Search surface refined

Introduced command-style search, better section labels, and sidebar keyboard affordances.

v0.3.0

Reference page polish

Added parameter tables, response cards, and code copy interactions tuned for long sessions.

v0.2.0

Scroll manuscript motion

Brought in opening ribbon animation and paragraph reveal pacing for chapter transitions.