Skip to content

agent-ix/quire

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Quire

@agent-ix/quire

Discord

quire (noun) — a gathering of sheets, folded together; from Latin quaternī (four each). In bookbinding, the fundamental unit of structure from which a complete volume is assembled.

Structured document interaction library — Parse, query, and render markdown document sections as typed React components.

What It Does

Quire takes raw markdown content and provides:

  • Parsing — split documents into a typed section tree
  • Querying — access sections, tables, lists, and diagrams by name
  • Rich rendering — render parsed objects as custom React components (badges, icons, interactive tables)
  • Markdown fallback — sections without custom renderers display via markdown-editor (read-only)
  • Write-back — modify sections and serialize back to markdown

Architecture

Layer 3: React Context     — QuireProvider, SectionCard, SectionTable, AutoSections
Layer 2: Query API         — section(), tables(), lists(), diagrams(), search()
Layer 1: Parser            — parseDocument(), extractFrontmatter(), parseBulletList()

Layers 1+2 are pure TypeScript with zero React dependency — usable by agents, scripts, and CLI tools.

Install

Published on the public npm registry:

npm install @agent-ix/quire

Development

Storybook

Run Storybook locally in Docker (exposed at http://quire.ix):

make storybook

Stop Storybook:

make storybook-stop

Testing

make test

Build

make build

About

Structured markdown document library — parse, query, and render spec sections as typed React components.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors