MarkRight logo

MarkRight dvcrn

Use this command to install MarkRight:
winget install --id=dvcrn.markright -e

a minimalistic github flavored markdown editor

MarkRight is a minimalistic GitHub-flavored markdown editor designed to provide a clean and efficient writing environment. Built with Electron, it offers live preview functionality and supports GitHub Flavored Markdown (GFM), enabling users to create rich content with tables, task lists, and more.

Key Features:

  • Live Preview: Seamlessly view changes in real-time as you edit.
  • GitHub Flavored Markdown Support: Utilize extended markdown features like tables, task lists, and fenced code blocks.
  • Syntax Highlighting: Enhance code readability with syntax highlighting for various programming languages.
  • Multiple File Tabs: Work on multiple documents simultaneously with ease.
  • Distraction-Free Mode: Focus on writing by minimizing interface elements.
  • Split-Pane View: Compare and edit content side-by-side.

Audience & Benefit: Ideal for writers, developers, content creators, bloggers, and technical writers who need a straightforward yet powerful markdown editor. MarkRight enhances productivity by combining essential tools into one intuitive application, eliminating the need for bloated editors or frequent switching between apps.

Available as open-source software under the GPL-3.0 license, MarkRight can be installed via winget on supported platforms.

README

This project is currently frozen. If you want to help developing it, please feel free to ping me

banner

a minimalistic github flavored markdown editor

screenshot

Download

On mac, install it through cask:

brew install --cask markright

Alternatively, check out the latest release to quickly find the latest version. Here are the current binaries:

Command line

On mac, you can launch markright from the command line with a little alias:

alias markright="open -a /Applications/MarkRight.app"
markright README.md

Building

MarkRight is written in clojurescript. To build, make sure you have clojure and leiningen installed on your system.

Requirements

  • npm
  • leiningen
  • bower
  • npm install
  • bower install

Compiling

All commands you need are available inside package.json. To compile the code, run npm run compile:. node/ is the folder that goes into electron.

Development

To develop, run the self-reloading build:

  • lein run -m build/ui-dev
  • lein run -m build/main-dev

shadow-build will live-reload the frontend so you don't need to refresh. If you change main.cljs however, you'll have to restart electron to reload your changes.

License

Licensed under GPLv3

Versions
0.1.11
Website
License