Skip to content

📝MakText 2: A simple and elegant markdown editor, available for Linux, macOS and Windows.

License

Notifications You must be signed in to change notification settings

ManoloZocco/marktext

Repository files navigation

MarkText2

MarkText2

🔆 Next generation markdown editor 🌙
A simple and elegant open-source markdown editor that focused on speed and usability.
Available for Linux, macOS and Windows.

Originally built with ❤︎ by Jocs and contributors . Now maintained and developed by ManoloZocco.

🔧 About This Fork

This is an actively maintained fork of MarkText, started from the original project which had accumulated numerous unresolved dependency issues and a completely broken build pipeline.

What Changed

The project has been fully stabilized with the following work:

Area Change Details
Electron 18.0.437.2.6 Major security and performance upgrade
Webpack 5.72.05.104.1 Security fix
Axios 1.12.01.13.5 Security fix + updated internal API usage
CodeMirror Fixed at 5.65.x Restored compatibility (upstream had v6 installed but v5 code)
ESLint Fixed at 8.57.x Restored compatibility (upstream had v9 without flat config)
Electron Builder 23.0.625.0.0 Compatibility with Electron 37
Node.js Pinned >=18 Added .nvmrc (Node 20 LTS recommended)
Other 11 security upgrades total postcss, playwright, turndown, babel-loader, etc.

Development Prerequisites

  • Node.js >= 18 (recommended: Node 20 LTS — see .nvmrc)
  • Yarn 1.x (classic)
  • Platform build tools for native modules (Xcode CLI on macOS, build-essential on Linux, Visual Studio Build Tools on Windows)

Screenshot

Features

  • 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.
  • Backlinks panel (supports both [[wiki links]] and markdown links).
  • Unlinked mentions panel for quick backlink opportunities.
  • Graph view for note connectivity around the current file.
  • Cloud sync panel with Dropbox plus folder-mode sync for Google Drive, OneDrive and iCloud Drive (macOS).
  • Renderer plugin hooks for runtime commands and custom sidebar panels (marktext.plugins).

Plugin hooks (experimental)

Renderer plugins can register runtime commands and sidebar panels through window.marktext.plugins:

const disposeCommand = window.marktext.plugins.registerCommand({
  id: 'plugin.hello',
  description: 'Plugin: Hello',
  execute: () => console.log('hello')
})

const disposePanel = window.marktext.plugins.registerSidebarPanel({
  id: 'plugin-panel',
  title: 'Plugin Panel',
  load: ({ currentFile }) => ({ items: [{ label: currentFile.filename }] })
})

🌙themes🔆

Cadmium Light Dark
Graphite Light Material Dark
Ulysses Light One Dark

😸Edit modes🐶

Source Code Typewriter Focus

Why MarkText2?

  1. I love writing. I have used a lot of markdown editors, yet there is still not an editor that can fully meet my needs. MarkText2 uses virtual DOM to render pages which has the added benefits of being highly efficient and being open source.
  2. MarkText2 is completely free and open source and will be open source forever. We hope that all markdown lovers will contribute their own code and help develop MarkText2 into a popular markdown editor.
  3. There are many markdown editors and all have their own merits. It's difficult to satisfy each markdown user's needs but we hope MarkText2 will be able to satisfy each markdown user as much as possible.

Getting Started (Build From Source)

platform

MarkText2 is currently in active development and there are no official release binaries at the moment.

To try it right now, build it from source on your operating system.

Build from source (Linux, macOS, Windows)

The core build flow is the same on all supported systems:

  1. Clone the repository
  2. Install dependencies
  3. Run yarn run build
git clone https://github.com/ManoloZocco/marktext.git
cd marktext
yarn install
yarn run build

Build output is generated in the build/ directory.

Each OS still has its own prerequisites (for example Xcode CLI on macOS, Linux dev libraries, or Visual Studio Build Tools on Windows), so please check the full build guide:

Build prerequisites (all systems)

  • Node.js >= 18 (recommended: Node 20 LTS — see .nvmrc)
  • Yarn 1.x (classic)
  • Platform build tools for native modules:
    • macOS: Xcode Command Line Tools
    • Linux: build-essential (or equivalent)
    • Windows: Visual Studio Build Tools

OS-specific notes

  • Linux may require extra native libraries depending on distro. See docs/dev/BUILD.md for Debian/Red Hat package examples.
  • Windows may require Windows SDK on older systems. See docs/dev/BUILD.md.
  • macOS follows the same build workflow once Xcode CLI tools are installed.

Build steps (Linux, macOS, Windows)

The build commands are the same across all supported operating systems:

# Clone the repository
git clone https://github.com/ManoloZocco/marktext.git
cd marktext

# Install dependencies
yarn install

# Run in development mode
yarn run dev

# Build for production
yarn run build

For detailed troubleshooting and packaging notes, check the build instructions.

Development

If you have any questions regarding MarkText2, you are welcome to write an issue. Of course, if you submit a PR directly, it will be greatly appreciated.

Contribution

MarkText2 is in active development. Please make sure to read the Contributing Guide before making a pull request.

Acknowledgements

This fork is based on the original MarkText project created by @Jocs and its contributors. Special thanks to @Yasujizr who designed the MarkText logo.

License

MIT.

About

📝MakText 2: A simple and elegant markdown editor, available for Linux, macOS and Windows.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

 
 
 

Contributors