Skip to content

getting-started.md

Latest commit

 

History

History
49 lines (33 loc) · 1.94 KB

getting-started.md

File metadata and controls

49 lines (33 loc) · 1.94 KB
Raw

Getting Started

This guide walks through downloading ReadMark, installing it, and opening your first Markdown file.

Requirements

  • Windows 10 or 11 (64-bit).
  • WebView2 runtime: preinstalled on Windows 11. If it is missing, the installer will guide you.
  • .NET 8 Desktop Runtime: bundled with the installer, so there is nothing extra to install.

Download

Get the latest ReadMark .msi installer from:

Install

  1. Run the downloaded .msi.
  2. Follow the installer prompts and accept the license.
  3. ReadMark installs and registers itself as a handler for Markdown files.

Open your first document

Any of these work:

  • Double-click a .md file, or right-click it → Open with → ReadMark.
  • In ReadMark, press Ctrl+O and pick one or more files.
  • Drag & drop a Markdown file onto the ReadMark window.
  • From a terminal: ReadMark.exe path\to\file.md.

ReadMark recognizes .md, .markdown, .mdown, .mkd, .mkdn, .mdwn, and .mdtxt (case-insensitive).

First things to try

  • Press F1 to see every keyboard shortcut at a glance.
  • Press Ctrl+T to cycle Light → Dark → System appearance.
  • Press Ctrl+Shift+N to show the navigation sidebar, then switch it between Outline and Files.
  • Press Ctrl+F to find text in the document.
  • Press Ctrl+M to switch between Extended (GitHub) and strict CommonMark rendering.
  • Click the </> control in the status bar to switch between the rendered document and its syntax-highlighted Markdown source.
  • Hover over a rendered fenced code block and click Copy code to copy its exact text.
  • Follow a link to a heading or another document, then press Alt+Left to go back.

Next steps