Markdown Viewer

July 2, 2026 ยท View on GitHub

A Windows desktop app for browsing, previewing, and editing Markdown files in a selected folder.

Overview

Markdown Viewer is a WinUI app built with .NET. It lets you choose a folder, lists the top-level .md files, and shows each file in two tabs:

  • Preview renders a readable Markdown view.
  • Code shows the editable source text.

The current preview supports common Markdown shapes such as headings, paragraphs, lists, block quotes, horizontal rules, fenced code blocks, inline code markers, emphasis markers, and links.

App Workflow

  1. Choose a folder.
  2. Select a Markdown file from the file list.
  3. Read it in the Preview tab.
  4. Click Edit to change the source in the Code tab.
  5. Save to overwrite the file, or revert to discard edits.

The app blocks folder changes and file switches while there are unsaved edits, so changes are not lost by accident.

Development Workflow

Requirements:

  • Windows 10 version 1809 or later.
  • .NET 10 SDK.

Restore and build:

dotnet restore MarkdownViewerApp.slnx
dotnet build MarkdownViewerApp.slnx -c Debug

Run:

dotnet run --project MarkdownViewerApp\MarkdownViewerApp.csproj

Use conventional commit messages for repository changes:

git add README.md
git commit -m "docs: add project README"
git push

Project Structure

MarkdownViewerApp.slnx
MarkdownViewerApp/
  App.xaml
  MainWindow.xaml
  MainPage.xaml
  MainPage.xaml.cs
  MarkdownViewerApp.csproj
  Assets/
  • MainWindow sets up the app window and navigates to MainPage.
  • MainPage owns folder picking, file loading, editing, saving, and Markdown preview rendering.
  • Assets contains app icons and package images.