Depdok

A macOS-first documentation editor built specifically for developers who write technical docs — not code.

This project focuses on Markdown + diagram-driven documentation, with an emphasis on interactive previews, offline usage, and a developer-friendly workflow.

This is a lightweight desktop application for writing technical documentation, such as:

• Design documents
• Architecture overviews
• Sequence diagrams
• Developer-facing markdown docs

Unlike general-purpose editors or note-taking apps, this tool treats documentation and diagrams as first-class citizens, not side features.

• Dual-mode editing:
  • Code mode (raw Markdown)
  • Preview mode (rendered, powered by TipTap)
• Real-time preview
• Editor ↔ Preview scroll synchronization

• Native support for Mermaid sequenceDiagram (offline)
• Code + Preview modes for diagrams
• Interactive diagram preview:
  • Click a diagram element to jump to its source code
  • Fold / unfold alt blocks
  • Hover to highlight related code

Diagrams are parsed into an internal AST, enabling structured interactions instead of static rendering.

• Export documentation to:
  • PDF
  • PNG (for diagrams)
• Export output matches the preview (WYSIWYG)

• Open and edit local folders
• Works seamlessly with Git repositories
• Fully offline and local-first

If you have Homebrew installed, you can simply install via:

# 1. Tap the repository
brew tap hudy9x/depdok https://github.com/hudy9x/depdok

# 2. Install the app
brew install --cask depdok

Tip: If you encounter permission issues, add the --no-quarantine flag.

irm https://raw.githubusercontent.com/hudy9x/depdok/main/install.ps1 | iex

• Not a code editor
• Not a note-taking or “second brain” app
• Not a plugin-heavy or cloud-based platform

The goal is focus, clarity, and a streamlined documentation workflow for developers.

• Documentation-first, developer-centric
• Opinionated and minimal
• Structured content over free-form text
• Offline by default

• Desktop framework: Tauri
• UI framework: React
• Rendering: AST-driven Markdown & diagram rendering
• Target platform: macOS

This project is currently in early development / MVP exploration.

Scope is intentionally limited to validate the core idea:

interactive, diagram-aware technical documentation for developers.

Depdok includes a built-in MCP (Model Context Protocol) server so AI agents (Claude Desktop, Cursor, Continue, etc.) can read and write to the knowledge base directly. It also features a native offline-first AI chat assistant using local GGUF models.

→ Connect an AI agent to Depdok via MCP → LLM & Native AI Chat Integration Guide

TBD