Skip to main content
Inkdown is available for macOS, Windows, and Linux. Choose your platform below for detailed installation instructions.

​
Platform Downloads

macOS

Download .dmg installer
  • Apple Silicon (M1/M2/M3)
  • Intel (x86_64)

Windows

Download .msi installer
  • 64-bit (x86_64)

Linux

Download .AppImage
  • Universal binary
Download the latest release from the GitHub Releases page.

​
macOS Installation

1

Download

Download the appropriate .dmg file for your Mac:
  • Apple Silicon (M1, M2, M3): Inkdown-aarch64.dmg
  • Intel: Inkdown-x86_64.dmg
Not sure which Mac you have? Click the Apple menu → About This Mac. Look for “Chip” (Apple Silicon) or “Processor” (Intel).
2

Install

  1. Open the downloaded .dmg file
  2. Drag the Inkdown icon to your Applications folder
  3. Eject the disk image
# Optional: Install via command line
cp -r /Volumes/Inkdown/Inkdown.app /Applications/
3

First Launch

Since Inkdown is not from the App Store, you need to bypass Gatekeeper on first launch:
  1. Right-click (or Control-click) on Inkdown in Applications
  2. Select “Open”
  3. Click “Open” in the security dialog
If you see “Inkdown is damaged”, run this command:
xattr -cr /Applications/Inkdown.app
4

Verify Installation

Launch Inkdown from Applications or Spotlight (Cmd + Space, type “Inkdown”).You should see the welcome screen prompting you to open or create a workspace.

​
macOS Requirements

  • macOS 10.15 (Catalina) or later
  • 50 MB of disk space

​
Windows Installation

1

Download

Download the .msi installer:
  • 64-bit: Inkdown-x86_64.msi
Inkdown requires Windows 10 or later (64-bit).
2

Run Installer

  1. Double-click the downloaded .msi file
  2. If you see a security warning, click “More info” → “Run anyway”
  3. Follow the installation wizard:
    • Accept the license agreement
    • Choose installation location (default: C:\Program Files\Inkdown)
    • Click “Install”
The installer may require administrator privileges.
3

Launch Inkdown

After installation:
  • Launch from Start Menu → Inkdown
  • Or run from command line:
"C:\Program Files\Inkdown\Inkdown.exe"
4

Verify Installation

The Inkdown window should open with the workspace selection screen.

​
Windows Requirements

  • Windows 10 (64-bit) or later
  • 50 MB of disk space
  • WebView2 (automatically installed by the installer)
“App can’t run on your PC”
  • Make sure you downloaded the 64-bit version
  • Check that you’re running Windows 10 or later
“Windows protected your PC” warning
  • Click “More info”
  • Click “Run anyway”
  • This appears because Inkdown is not yet signed with a Windows certificate
WebView2 installation fails

​
Linux Installation

1

Download

Download the .AppImage file:
  • Universal: Inkdown-x86_64.AppImage
The AppImage is a universal binary that runs on most Linux distributions.
2

Make Executable

Make the AppImage executable:
chmod +x Inkdown-*.AppImage
3

Run Inkdown

Run the AppImage:
./Inkdown-*.AppImage
You can move the AppImage to ~/Applications or /opt for easier access.
4

Optional: Desktop Integration

To add Inkdown to your application menu:
# Install AppImageLauncher (recommended)
# Ubuntu/Debian
sudo apt install appimagelauncher

# Arch Linux
yay -S appimagelauncher

# Or manually create desktop entry
cat > ~/.local/share/applications/inkdown.desktop <<EOF
[Desktop Entry]
Name=Inkdown
Exec=/path/to/Inkdown.AppImage
Icon=inkdown
Type=Application
Categories=Office;TextEditor;
EOF

​
Linux Requirements

  • 64-bit Linux distribution
  • GLIBC 2.31 or later
  • GTK 3 or later
  • 50 MB of disk space

​
Tested Distributions

# Install dependencies (if needed)
sudo apt install libgtk-3-0 libwebkit2gtk-4.0-37

# Run Inkdown
chmod +x Inkdown-*.AppImage
./Inkdown-*.AppImage
Tested on:
  • Ubuntu 20.04, 22.04, 24.04
  • Debian 11, 12
# Install dependencies (if needed)
sudo dnf install gtk3 webkit2gtk3

# Run Inkdown
chmod +x Inkdown-*.AppImage
./Inkdown-*.AppImage
Tested on:
  • Fedora 38, 39, 40
  • RHEL 9
# Install dependencies (if needed)
sudo pacman -S gtk3 webkit2gtk

# Run Inkdown
chmod +x Inkdown-*.AppImage
./Inkdown-*.AppImage
Tested on:
  • Arch Linux (rolling)
  • Manjaro
“No such file or directory” when running AppImage
  • Install FUSE: 
    # Ubuntu/Debian
sudo apt install fuse libfuse2

# Arch
sudo pacman -S fuse2
AppImage won’t run
  • Extract and run directly: 
    ./Inkdown-*.AppImage --appimage-extract
./squashfs-root/AppRun
Missing dependencies
  • Check for missing libraries: 
    ldd Inkdown-*.AppImage

​
Building from Source

Advanced users can build Inkdown from source.
Building from source requires development tools and can take 10-20 minutes.

​
Prerequisites

# Install Homebrew (if not installed)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install dependencies
brew install node
curl -fsSL https://bun.sh/install | bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

​
Build Steps

1

Clone Repository

git clone https://github.com/inkdown/inkdown.git
cd inkdown
2

Install Dependencies

bun install
This installs all Node.js and Rust dependencies.
3

Build Desktop App

# Development build (with dev tools)
bun run dev

# Production build
bun run build
The production build creates installers in apps/desktop/src-tauri/target/release/bundle/.
4

Run Development Server

For active development with hot reload:
bun tauri dev

​
Build Commands

CommandDescription
bun run devStart development server
bun run buildBuild for production
bun run typecheckTypeScript type checking
bun run lintRun linter (Biome)
bun run checkRun all checks (lint + typecheck)
bun tauri devStart Tauri dev server with hot reload

​
Project Structure

inkdown/
├── apps/
│   └── desktop/          # Tauri desktop app
│       ├── src/          # React frontend
│       └── src-tauri/    # Rust backend
├── packages/
│   ├── core/             # @inkdown/core - Core logic
│   ├── ui/               # @inkdown/ui - Components
│   ├── plugins/          # @inkdown/plugins - Built-in plugins
│   └── native-tauri/     # @inkdown/native-tauri - Tauri bindings
└── docs/                 # Documentation
Rust compilation fails
  • Update Rust: rustup update
  • Check Rust version: rustc --version (should be 1.70+)
Node/Bun dependency issues
  • Clear cache: bun pm cache rm
  • Reinstall: rm -rf node_modules && bun install
Tauri build failsTypeScript errors
  • Run type check: bun run typecheck
  • Regenerate types: bun run typecheck:packages

​
Verifying Your Installation

After installation, verify everything works:
1

Launch Inkdown

Open Inkdown from your application launcher or command line.
2

Create Test Workspace

Create or open a workspace folder when prompted.
3

Create Test Note

  1. Press Cmd/Ctrl + N to create a new note
  2. Type some markdown:
# Test Note

This is a **test** note.
  1. Toggle preview with Cmd/Ctrl + E
4

Check Version

Open Settings (Cmd/Ctrl + ,) and check the version number at the bottom.
If you encounter any issues, check the GitHub Issues or ask for help in GitHub Discussions.

​
Updating Inkdown

Inkdown does not have auto-update yet. To update:
  1. Check the Releases page for new versions
  2. Download the latest installer for your platform
  3. Install over your existing installation
Your workspace and settings are stored separately and will be preserved during updates.

​
Uninstalling Inkdown

  1. Quit Inkdown
  2. Drag Inkdown.app from Applications to Trash
  3. Empty Trash
Remove settings and data:
rm -rf ~/Library/Application\ Support/com.inkdown.app
Uninstalling Inkdown does not delete your workspace or notes. Those are stored in the folder you selected as your workspace.

​
Next Steps

Quickstart Guide

Learn the basics and create your first note

Keyboard Shortcuts

Master keyboard shortcuts for productivity

Configuration

Customize Inkdown to your preferences

Contributing

Build Inkdown from source and contribute