Gition

Zero-config local web interface for Markdown documentation and task management. Think Notion + Jira for your local files.

🚧 Alpha Status

This project is currently in early alpha and stems from a personal need for better local documentation and task management.

It's also an experiment in pAIr programming, inspired by research showing the benefits of collaborative development with AI assistants. Expect rapid changes and breaking updates as we iterate toward a stable release.

Features

• 📚 Documentation: Auto-discover and render Markdown/MDX files with real-time editing
• 📋 Task Management: Kanban board with smart task parsing from Markdown syntax
• 🔄 Real-time Updates: File watching with instant UI updates
• 🎨 Customizable: Themes, task types, and flexible configuration
• 🌐 Multi-language: English, French, and Spanish support
• 📱 Responsive: Works on desktop and mobile devices

Quick Start

# Start gition
npx gition-ui

Open http://localhost:3000 to see your documentation and tasks.

Basic Usage

Documentation

Create .md or .mdx files in your docs/ folder:

---
title: "My Document"
tags: ["guide", "getting-started"]
---

# My Document

Content with **formatting** and [links](https://example.com).

Tasks

Add tasks to Markdown files using checkbox syntax:

# Project Tasks

- [ ] Todo item
- [~] In progress item
- [x] Completed item

Tasks automatically appear in the Kanban board and can be managed with drag-and-drop.

Configuration

Customize your workspace with .gitionrc/config.yaml:

name: "My Project"
docsDir: "docs"
tasksDir: "tasks"
theme:
  primaryColor: "#3b82f6"
  darkMode: true
features:
  taskManagement: true
  realTimeUpdates: true

See the Configuration Guide for all options.

Documentation

• 📖 Getting Started - Complete setup and usage guide
• ⚙️ Configuration - Customization options
• 🛠️ Development - Contributing and development setup
• 🔧 API Reference - REST API documentation

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

# Clone and install
git clone https://github.com/romainframe/gition.git
cd gition
pnpm install

# Start development server
pnpm dev

# Or use just for common tasks
just dev

See Development Guide for detailed instructions.

Roadmap

• ✅ v0.1: Core features, CLI, task management, real-time updates
• 🚧 v0.2: Advanced MDX features, collaboration, performance improvements

See the roadmap for detailed plans.

Support

• 🐛 Issues - Bug reports and feature requests
• 💬 Discussions - Questions and community
• 📧 Email - Direct support

License

MIT © Romain

---

Made with ❤️ for developers who love Markdown