Doc77 — Local Document Preview & Management · Markdown · PDF · MCP Server · LAN Sharing

Document viewer | Document manager | Markdown reader | PDF viewer | Code viewer | Knowledge base | Local document server

Open-source · Free · Cross-platform · Mobile-ready · Zero-config · 📦 Desktop app

Doc77 is a lightweight local document previewer, MCP file-operation bridge, and AI conversation-driven document management agent. Your browser is the workbench — supports Windows / macOS / Linux / WSL. Also available as an Electron desktop app for non-technical users, double-click to use. Can be safely exposed to the internet with password protection.

In read-only mode it's a multi-project showcase; in write mode it's an intelligent steward that asks for your approval — every file operation is confirmed by you before execution, backed by built-in security review, atomic transaction rollback, and cross-drive fault tolerance.

Preview

Dashboard	Document Preview

Login	Mobile

Use Cases

Current Focus

Doc77 prioritizes preview experience, complemented by lightweight editing. Text files can be quickly edited and saved in-page (with external change conflict detection); heavy editing launches VS Code or your system editor with one click. Current focus:

• 🚀 Performance — Instant startup, smooth with large files
• 🐛 Stability — Multi-platform compatibility, eliminate experience bugs
• ✨ Preview Quality — Format support, reading tools, AI assistance pushed to the limit

Capabilities

Installation

Desktop (Recommended for non-technical users)

Double-click to install, desktop shortcut launches the app. Native file dialog to select folders, ready out of the box.

CLI (Recommended for developers)

npm install -g idoc77                # Install
doc77 register ./my-docs --name "My Docs"   # Register a project
doc77 start                          # Start (127.0.0.1:27777)
doc77 start --bind 0.0.0.0           # Or allow LAN access

Command Reference

Core Commands

Configuration

Common config keys:

MCP Service

Task Approval

Lock Management

Offline Support

# Download all CDN resources locally (~16MB)
doc77 vendor-install

# Skip Pyodide (Python runtime), save ~12MB
doc77 vendor-install --no-pyodide

# Download offline translation models (en↔zh, ~80MB each)
doc77 vendor-install --translate en-zh
doc77 vendor-install --translate zh-en

Resources are cached in ~/.doc77/vendor/ and auto-detected on restart. Re-running skips already-downloaded files.

Supported Formats

Markdown Features

Offline Availability

Doc77 uses a vendor system for CDN → local fallback. doc77 vendor-install downloads resources to ~/.doc77/vendor/. The Electron desktop build bundles vendor resources at build time (extraResources).

One-Command Restart

./scripts/restart.sh              # Default port 27777
./scripts/restart.sh --port 8080  # Custom port

To bind 0.0.0.0 for external access, use doc77 start --bind 0.0.0.0 (a password will be required).

Design Philosophy

1. Documents stay where they are — never copy or upload user files, read-only access to local paths
2. Preview ≠ Edit — let professional tools (VS Code / Typora) handle editing, let Doc77 handle preview
3. Register once, manage forever — register a project directory once, it's remembered permanently
4. Lightweight first — single process, SQLite, zero-config, out of the box
5. Conversation-driven — natural language interaction, AI-assisted planning, human final decision

Documentation

Tech Stack

Project Structure

doc77/
├── packages/
│   ├── core/          # @doc77/core  Preview engine + FS abstraction + Express Server
│   ├── mcp/           # @doc77/mcp   MCP service layer + security guard + transaction system
│   ├── ai/            # @doc77/ai    AI provider + Agent core + Chat API
│   ├── cli/           # doc77 CLI    Command-line entry
│   ├── electron/      # Desktop shell (tray / native dialogs / port 28888)
│   └── doc77/         # idoc77 meta-package for npm publishing
├── docs/
│   ├── design/        # Design docs
│   ├── analysis/      # Analysis reports
│   └── planning/      # Implementation planning
├── scripts/           # Tool scripts
├── CLAUDE.md          # Project conventions
└── README.md          # This file

Contributing

Contributions are welcome! Here is the full local setup and submission flow.

Prerequisites

Local Setup

git clone https://github.com/xyy277/doc77.git
cd doc77
pnpm install            # install dependencies (builds each package's dist on first run)
pnpm build              # build all packages

Common Scripts

Branching & Submission Flow

The main branch is protected by GitHub Rulesets:

• ❌ Direct push to main is forbidden
• ❌ Force push / deletion of main is forbidden
• ✅ Changes must be merged via Pull Request
• ✅ Before merge, the following CI checks must all pass: Lint & Format Check, Build, Test (Node 22 on ubuntu/macos/windows-latest)
• ✅ Squash merge is recommended to keep history linear

Recommended workflow:

1. Branch off main: git checkout -b feat/your-feature
2. Self-test locally: pnpm lint && pnpm format:check && pnpm test
3. Commit (Conventional Commits recommended, e.g. fix(web): ..., feat(core): ...)
4. Push the branch: git push -u origin feat/your-feature
5. Open a PR into main on GitHub, wait for CI to go green, then merge

Code Conventions

• See CLAUDE.md for detailed conventions
• TypeScript strict mode; ensure pnpm build passes before committing
• i18n strings must be updated in both zh-CN.json and en-US.json; run pnpm check:i18n before committing

Privacy & Security

• All data stored locally in ~/.doc77/
• AI tokens encrypted in SQLite
• No file content sent to external servers (unless you manually enable AI features)
• Password-protected access supported

License

MIT License