Back to Marktext

Installation

packages/website/content/docs/end-user/INSTALLATION.md

0.19.13.8 KB
Original Source

Installation

MarkText is a free, open-source Markdown editor for Linux, macOS and Windows. Pre-built binaries are published with every release on GitHub releases. Pick the one that matches your platform.

Windows

ArtifactWhen to choose
marktext-win-x64-<version>-setup.exeRecommended. NSIS installer; per-user install, lets you pick the install directory, creates Start Menu and Desktop shortcuts.
marktext-win-x64-<version>.zipPortable zip. Extract anywhere and run marktext.exe. See Portable mode for details on keeping your data alongside the app.

After installing, MarkText registers itself as a handler for .md, .markdown, .mmd, .mdown, .mdtxt and .mdtext files.

macOS

ArtifactWhen to choose
marktext-mac-arm64-<version>.dmgApple Silicon (M1 / M2 / M3 / M4).
marktext-mac-x64-<version>.dmgIntel Macs.
marktext-mac-<arch>-<version>.zipPlain zip alternative to the DMG.

Open the DMG and drag MarkText into your Applications folder. Builds are not currently notarized, so the first launch may prompt the system Gatekeeper — right-click the app and choose Open to accept it once.

You can also install via Homebrew Cask:

sh
brew install --cask mark-text

Linux

MarkText is shipped in five Linux formats. Most users want the AppImage.

ArtifactWhen to choose
marktext-linux-<version>.AppImageRecommended. Runs on most distros without root. chmod +x and double-click (or run directly).
marktext-linux-<version>.debDebian, Ubuntu, Linux Mint, Pop!_OS, … (sudo apt install ./marktext-linux-<version>.deb).
marktext-linux-<version>.rpmFedora, RHEL, openSUSE, … (sudo rpm -i marktext-linux-<version>.rpm).
marktext-linux-<version>.snapUbuntu / any snap-enabled distro (sudo snap install marktext-linux-<version>.snap --dangerous --classic).
marktext-linux-<version>.tar.gzPortable tarball. Extract and run the included marktext binary.

Arch Linux users can install MarkText from the AUR (marktext-bin).

[!NOTE] See Linux notes for distro-specific tips (sandbox flags, font configuration, file-association quirks).

Verify the download

Every release contains a latest-<platform>.yml file with SHA-512 hashes. To verify:

sh
# Example on macOS / Linux
shasum -a 512 marktext-linux-<version>.AppImage

Compare the value to the entry in latest-linux.yml on the release page.

Build from source

If you'd rather build from source — for example to track develop, to run on an architecture we don't publish a binary for, or to contribute — see the Build instructions in the developer docs. A minimal recap:

sh
git clone https://github.com/marktext/marktext.git
cd marktext
pnpm install
pnpm run build

Output installers land in the repository's dist/ folder.

Updating

MarkText checks for updates on launch (this can be disabled under Preferences → General → Updates). When an update is published, the app downloads it in the background and installs on next restart.

Portable installs and the AppImage do not auto-update — re-download the latest artifact when you want to upgrade.

Uninstall

PlatformHow
WindowsSettings → Apps, or run the bundled Uninstall MarkText.exe.
macOSDrag MarkText.app to the Trash. Optionally also remove ~/Library/Application Support/marktext.
Linux (.deb)sudo apt remove marktext
Linux (.rpm)sudo rpm -e marktext
Linux (snap)sudo snap remove marktext
Linux (AppImage / tar.gz)Delete the file you extracted.

To wipe MarkText's user data as well, remove its application data directory.