Skip to content

Repository files navigation

inCompleat

A demo desktop application for md-compleat, showcasing how to integrate the web component into an Electron app with file management, navigation, and AI provider configuration.

MIT License

Features

  • WYSIWYG markdown editing via md-compleat (Tiptap/ProseMirror)
  • File operations: New, Open, Save, Save As with unsaved changes detection
  • Heading index sidebar with click-to-scroll and active section tracking
  • Find & Replace with match navigation
  • AI directives: type /ai to insert directive tags, then execute with Mod+Enter
  • Configurable CLI-based AI provider (e.g., Claude, Ollama)
  • Native OS menus with keyboard shortcuts

Install

Download the latest release from the Releases page.

Available formats:

  • Linux: AppImage, .deb
  • macOS: .dmg
  • Windows: .exe installer

Development

npm install
npm start          # launch the app
npm run start:dev  # launch with --no-sandbox (Linux)
npm test           # run tests

Building

npm run pack       # build unpacked (for testing)
npm run dist       # build distributable

Keyboard Shortcuts

Action Shortcut
New Ctrl+N
Open Ctrl+O
Save Ctrl+S
Save As Ctrl+Shift+S
Find & Replace Ctrl+H
Toggle Sidebar Ctrl+B
Execute AI Ctrl+Enter

AI Provider Setup

Go to Settings > AI Provider and configure a CLI command. The command receives the document on stdin and should return the modified document on stdout.

Example with Claude Code:

  • Command: claude
  • Arguments: -p --permission-mode bypassPermissions

License

MIT

About

A demo using md-compleat

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages