Typedown

Typedown is a lightweight Markdown editor designed specifically for the Windows platform. With the WinUI framework, it provides users with a seamless interface and efficient editing experience that perfectly matches the operating system. Whether you're writing technical documents, academic papers, or blog posts, Typedown is your go-to assistant!

Screenshots

Building from source

1. Prerequisites

• Visual Studio 2026 with the WinUI / Windows application development workload and the ARM64 build tools
• .NET 10 SDK
• Git for Windows
• Node.js with Yarn Classic 1.x (npm i -g yarn)

2. Clone the repository

git clone https://github.com/byxiaozhi/Typedown

This will create a local copy of the repository.

3. Build the editor frontend

Install the frontend dependencies once, then build the WebView bundle:

cd Typedown\Dev\Typedown.Editor
yarn
yarn build

yarn build writes the bundle into Typedown\Dev\Typedown.WinUI\Resources\Statics. The WinUI build does not build the frontend, so run yarn build again whenever the editor frontend changes.

4. Build and run

Open Typedown\Typedown.sln in Visual Studio, right-click the Typedown.WinUI project, and select Set as Startup Project. For daily development use Debug_Local (unpackaged, unsigned) with ARM64 or x64, then click Run!

The Debug and Release configurations produce an MSIX package (signing is disabled by default; see docs/build.md).

Contributors

Want to contribute to this project? Let us know with an issue that communicates your intent to create a pull request.