Documentation Index

All synced markdown docs

Every page here is generated from markdown already present in the repository.

Overview

Narrarium Framework

Narrarium Framework is a local-first writing stack built around three pieces:

Source: README.md

Narrarium Agent Rules

Use Narrarium as a book-writing framework where the repository is the source of truth.

Source: AGENTS.md

Reference

Publishing

Narrarium is prepared to publish as five public npm packages.

Source: docs/publishing.md

Query Canon Guide

`query_canon` is the fastest way to ask the repository a continuity question in natural language.

Source: docs/query-canon.md

Reader Password Protection

Narrarium Reader supports AES-256-GCM build-time content encryption. When enabled, all prose is encrypted before the static site is generated. Visitors must enter the correct password in the browser before any text is revealed. The password never leaves the browser — all decryption runs client-side via the Web Crypto API.

Source: docs/reader-password.md

Repository Spec

Narrarium treats a repository as the source of truth for a book project.

Source: docs/repository-spec.md

Review Dialogue Action Beats Guide

`review_dialogue_action_beats` is a proposal-only editorial tool for final paragraph files in `chapters/`.

Source: docs/review-dialogue-action-beats.md

Revise Chapter Guide

`revise_chapter` is the proposal-only editorial tool for a final chapter in `chapters/`.

Source: docs/revise-chapter.md

Revise Paragraph Guide

`revise_paragraph` is a proposal-only editorial tool for final scene files in `chapters/`.

Source: docs/revise-paragraph.md

Writing Style Guide

Narrarium now uses a simpler writing-style model.

Source: docs/style-profiles.md

Packages

narrarium-astro-reader

Astro reader and reader scaffolding CLI for Narrarium book repositories.

Source: packages/astro-reader/README.md

narrarium

Core Narrarium helpers for local-first book repositories.

Source: packages/core/README.md

create-narrarium-book

Starter CLI for scaffolding and upgrading Narrarium book repositories.

Source: packages/create-narrarium-book/README.md

narrarium-mcp-server

Local MCP server for Narrarium book repositories.

Source: packages/mcp-server/README.md

narrarium-sdk

Dedicated TypeScript SDK package for loading, editing, and pushing Narrarium repositories over GitHub or Azure DevOps.

Source: packages/sdk-typescript/README.md