Codex Format & Git Projects
Learn about the ChapterWise Codex format for structured narrative projects
Codex Format & Git Projects
Welcome to the Codex documentation. The ChapterWise Codex format is a powerful YAML-based specification for defining structured narrative projects, literary works, and content collections.
What is Codex?
Codex is a flexible, human-readable format for describing: - Multi-chapter books and manuscripts - Story series and collections - Literary analyses and commentary - Structured content hierarchies
Codex files (.codex.yaml or .codex.json) define the structure, metadata, and content of narrative projects that can be version-controlled with Git.
Key Topics
Codex Format Specification
Codex Format Overview
Complete specification of the Codex v1.0 format including: - File structure and syntax - Metadata fields and attributes - Content organization patterns - Template variables and includes
Codex Format v1
Detailed v1.0 specification with examples: - Schema validation rules - Required and optional fields - Advanced features - Version migration - YAML vs JSON formats - Include mechanisms
Manuscript Format
Manuscript Format
Learn about ChapterWise's internal manuscript format: - How manuscripts are stored - JSON structure - Chapter organization - Metadata fields
Codex Tools
Explode Codex
Modularize your codex files for better collaboration: - Extract children into separate files - Automatic include directive generation - Type-based filtering - Auto-fix integration - Git-friendly workflows
Git Codex Projects
Git Projects Overview
Version control your narrative projects: - Git integration features - Repository structure - Collaboration workflows - Automated syncing
Index File Format
Master the Git Codex index format: - Project index structure - Multi-codex repositories - Navigation hierarchies - Build configurations
Best Practices
Optimize your Codex workflow: - Repository organization - Commit strategies - Branch management - Team collaboration
Examples
Real-world Codex examples: - Simple book projects - Series and collections - Complex hierarchies - Template libraries
Troubleshooting
Solve common issues: - Validation errors - Git sync problems - Template rendering - Format conversion
Why Use Codex?
Version Control
Track every change to your narrative project with Git. See what changed, when, and why.
Collaboration
Work with co-authors, editors, and reviewers using standard Git workflows.
Templating
Use powerful template features to generate content dynamically and maintain consistency.
Flexibility
Define complex structures with nested chapters, parts, and sections.
Portability
Human-readable YAML/JSON format works everywhere and never locks you in.
Getting Started with Codex
- Learn the format - Read the Codex Format Overview
- See examples - Browse real-world examples
- Create a project - Build your first Codex file
- Connect to Git - Set up Git integration
Codex on ChapterWise
Access Codex features at codex.chapterwise.app: - Create and edit Codex projects - Preview rendered content - Validate format compliance - Sync with Git repositories - Generate exports
Ready to start with Codex? Begin with the Codex Format Overview or jump to Git Projects if you're ready to version control your work.