Open Source Documentation Tool

Document Your Codebase
Beautifully

All your technical documentation—rich text, smart code snippets, ERDs, architecture diagrams, and more—in your codebase.

No more scattered docs. No more context switching.

Quick Install
Install Doclific with a single command
curl -fsSL https://raw.githubusercontent.com/muellerluke/doclific/main/scripts/install.sh | bash

Screenshot or video demo placeholder

Add a screenshot or video showcasing Doclific's interface here

Powerful Features

Everything you need to create beautiful, maintainable documentation

Notion-like Editor
Rich text editing experience with support for headings, lists, code blocks, and more
AI-Powered Documentation
Generate documentation using AI (currently supports Google Gemini, with more providers coming soon)
Codebase Integration
Reference code snippets directly from your repository
ERD Diagramming
Create Entity Relationship Diagrams with AI assistance to visualize your database schema
Whiteboarding
Document architecture and system designs with an interactive whiteboard for visual planning
Fast & Local
Runs entirely on your machine - no external services required
Coming Soon

CI Integration

Keep your documentation in sync with your codebase automatically

Automated Documentation Sync
Never let your documentation get out of date

Dynamic Code Snippets

The Doclific editor allows you to insert code snippets that automatically pull from your files, ensuring your documentation always reflects the current state of your codebase.

CI Workflow Integration

The new CI tool runs during your CI workflow to check if referenced code snippets have changed. It compares your documentation against the actual code to detect any discrepancies.

Smart Detection & Auto-Updates

When changes are detected, the CI tool will warn you that snippets need updating. For simple changes like line number shifts (when code is added above a snippet), it can automatically update the start and end line numbers to keep your documentation accurate.

Ready to get started?
Install Doclific and start documenting your codebase today
curl -fsSL https://raw.githubusercontent.com/muellerluke/doclific/main/scripts/install.sh | bash