MarkText

Translations also available in: CN TW DE ES FR JP KR PT

---

🔆 Next generation markdown editor 🌙
A simple and elegant open-source markdown editor that focused on speed and usability.

• MarkText is a free and open source markdown editor originally written by Jocs and contributors.

• Sadly, the core repository became unmaintained since about 3 years ago, but various Quality of Life issues remained that I noticed in my daily usage.

• This repository serves as an attempt at modernising my favourite Markdown Editor, and is a fork based off Jacob Whall's Fork

  • See my motivation below

• You can read more about my motivation below

1. Installing

⚠️ These releases are still in beta (since I do not know how much stuff I might have broken during the migration). Please report any bugs in the issue tracker

Windows

• Simply check out the Releases Page!

• Tested on:

  • Windows 11

Linux

• Simply check out the Releases Page
• Tested on:
  • Ubuntu 24.0.2 (AppImage and .deb packages)
  • Would love some help in testing the other Linux packages!

Linux Package Managers

1. Arch Linux

• Available on AUR thanks to @kromsam

MacOS

⚠️ MacOS releases will show a "MarkText is damaged and can't be opened" due to a lack of notorisation. Please see this fix here (which also applies to any other app that lacks a Developer Account signing)

• Available on the Releases Page

2. Screenshots

3. ✨Features ⭐

• 🆕 Now available in 9 languages from the Preferences editor (Special thanks to @hubo1989)

  • English 🇺🇸
  • 简体中文 🇨🇳
  • 繁體中文 🇹🇼
  • Deutsch 🇩🇪
  • Español 🇪🇸
  • Français 🇫🇷
  • 日本語 🇯🇵
  • 한국어 🇰🇷
  • Português 🇵🇹

• Realtime preview (WYSIWYG) and a clean and simple interface to get a distraction-free writing experience.

• Support CommonMark Spec, GitHub Flavored Markdown Spec and selective support Pandoc markdown.

• Markdown extensions such as math expressions (KaTeX), front matter and emojis.

• Support paragraphs and inline style shortcuts to improve your writing efficiency.

• Output HTML and PDF files.

• Various themes: Cadmium Light, Material Dark etc.

• Various editing modes: Source Code mode, Typewriter mode, Focus mode.

• Paste images directly from clipboard.

3.1 🌙 Themes🔆

Cadmium Light	Dark
Graphite Light	Material Dark
Ulysses Light	One Dark

3.2 😸Edit Modes🐶

Source Code	Typewriter	Focus

4. Motivation

1. Soo is this fork any different from the countless others?

• A main gripe I had when looking into marktext was that the development framework + environment was aging badly and took forever to compile

  • Most libaries were outdated and some couldn't even be installed with modern versions of Node.JS/Python

• Hence, this fork is kind of a major "re-write" that makes use of electron-vite instead of the old Babel + Webpack setup

  • The goal here is to give marktext a fresh start using modern frameworks and libraries as much as possible
  • Everything has also been migrated to Vue3 and Pinia with all libraries updated to their latest possible versions

• The main and preload processes are still compiled to CommonJS, but the renderer is now fully ESModules only (which posed some interesting issues during migration)

2. That's cool! How can I help?

• Any form of:

  1. Testing for bugs (Bug-Reports)
  2. Pull Requests

  Are more than welcome!

• You can find a basic list of commands for getting around this repo below, but otherwise - the file structure should be very similar to the original marktext

3. Project Setup

• See Developer Documentation