Git Codex Projects

Connect your Git repositories to ChapterWise Codex for seamless integration of your codex files, markdown documentation, and world-building content. Git projects automatically sync on push and provide powerful organizational features through the index.codex.yaml file.

What are Git Codex Projects?

Git Codex Projects allow you to:

• Connect GitHub Repositories: Link your existing GitHub repositories to ChapterWise Codex
• Automatic Syncing: Changes pushed to your repository automatically sync to ChapterWise
• File Organization: Use index.codex.yaml to define custom file trees and hierarchies
• Version Control: Keep your codex files under version control with Git
• Collaboration: Share repositories with team members for collaborative world-building

Quick Start

1. Connect Your GitHub Account

First, connect your GitHub account to grant ChapterWise access to your repositories:

1. Navigate to Projects page
2. Click "Connect GitHub"
3. Authorize ChapterWise Codex
4. Select which repositories to grant access

2. Create a Git Project

Once connected, create a new Git project:

1. Click "New Git Project"
2. Select a repository from the dropdown
3. Choose the branch to track (default: main)
4. Configure webhook settings (automatic or manual)
5. Click "Create Project"

ChapterWise will clone your repository and automatically detect supported files.

3. View Your Files

After creation, you can:

• Browse files in the File Tree view
• Click any .codex.yaml or .md file to view it
• Navigate through folders and subfolders
• Search and filter files

Supported File Types

ChapterWise automatically detects and displays these file types:

Key Features

Automatic Syncing

When you push changes to your repository:

1. GitHub sends a webhook to ChapterWise
2. ChapterWise pulls the latest changes
3. Files are automatically updated
4. Index is regenerated if needed
5. You see changes immediately

Custom Organization

Use index.codex.yaml to control how files appear:

• Define folder structure
• Set display order
• Hide files or folders
• Add titles and descriptions
• Control which files are visible

File Tree Navigation

Intuitive file browser with:

• Expandable/collapsible folders
• File type icons
• Search functionality
• Keyboard navigation
• Mobile-responsive design

Learn More

Explore these topics in detail:

Index File Format

Complete specification for index.codex.yaml files

Best Practices

Tips and recommendations for organizing your Git codex projects

Examples

Real-world examples of index files for different use cases

Troubleshooting

Common issues and solutions

Use Cases

Story Bibles for Multi-Book Series

Keep character profiles, world facts, and plot threads in a Git repository that your entire writing team can access and update.

Game Development Documentation

Store lore, character designs, and world-building documents that sync automatically with your game development workflow.

Collaborative World-Building

Work with co-authors, sharing a repository where everyone can contribute to the shared universe.

Academic Research

Version-control your research notes, character analyses, and thematic explorations of literary works.

Getting Started

Ready to create your first Git codex project?

Next: Learn about the Index File Format to customize how your files are organized.