README.md

April 30, 2026 · View on GitHub

InkMD Logo

InkMD Editor

A modern Markdown editor for Windows with real-time preview, powerful file management, and a distraction-free writing experience.

Stars Forks License

About InkMD

InkMD Editor is a lightweight yet feature-rich Markdown editor built for developers, technical writers, and note-takers who need speed and simplicity without sacrificing functionality.

Designed with performance in mind, InkMD combines a smooth writing workflow with live preview rendering, smart file management, and a clean modern interface — making it ideal for documentation, note-taking, blogging, and everyday Markdown editing.

Features

  • Live Preview Rendering
    Instantly preview Markdown as you type with responsive, real-time rendering.

  • Rich Editing Experience
    Syntax highlighting, smooth editing interactions, and a distraction-free writing layout.

  • Integrated File Explorer
    Manage folders, recent files, and auto-save workflows directly inside the app.

  • Built-in Templates
    Quickly create README files, journals, notes, and documentation templates.

  • Customizable Appearance
    Switch between Light/Dark themes and personalize editor fonts.

  • Keyboard Shortcut Support
    Improve productivity with intuitive shortcuts for editing and navigation.

Screenshots

Main Editor View

Installation

Download Prebuilt Version

Download the latest release from:

Build From Source

Build instructions

Prerequisites

InkMD requires:

  • Visual Studio 2022 or later
  • Windows 10/11
  • Node.js + npm

Install the following Visual Studio workloads:

  • WinUI application development
  • .NET desktop development
  • Windows 10 SDK (10.0.19041.0 or later)

1. Clone the repository

git clone --recurse-submodules https://github.com/tribeti/InkMD-Editor.git

2. Build the preview editor

The Markdown preview pane is powered by Milkdown, so build the web editor first:

cd milkdown-editor
npm i
npm run build

3. Generate application assets

To generate the required application visual assets:

  1. Open Package.appxmanifest
  2. Navigate to the Visual Assets tab
  3. Under Source, select Square400x400Logo.png
  4. Click Generate

This will generate the required app icons and visual assets for the project.

4. Run the application

Open the solution in Visual Studio 2022+, then press:

F5

Contributing

Contributions are welcome and appreciated.

  1. Fork the repository
  2. Create your branch:
git checkout -b feature/my-feature
  1. Commit your changes:
git commit -m "Add my feature"
  1. Push to GitHub:
git push origin feature/my-feature
  1. Open a Pull Request

💎 Special Thanks

This project stands on the shoulders of giants. A huge shoutout to these amazing projects and libraries that made InkMD Editor possible:

  • TextControlBox-WinUI (by JuliusKirsch) for providing the powerful text editing foundation that powers InkMD's core writing experience.

  • Markdig for delivering a fast, reliable, and standards-compliant Markdown engine for .NET.

  • Windows Community Toolkit for offering essential utilities and extensions that simplify Windows application development.

  • Milkdown for enabling the rich and modern Markdown preview experience inside InkMD.

  • Advanced Installer for providing professional packaging tools that help deliver InkMD to users smoothly.

And most importantly, heartfelt thanks to every contributor, maintainer, and open-source creator whose work inspires and supports projects like this every day.

License

Licensed under the MIT License.

See the LICENSE file for details.

Happy Writing!