sil3ncer1 / markus

MARKus - online Markdown editor

MARKus

---

⋆⭒˚｡⋆ Single Page View Markdown Editor ⋆⭒˚｡⋆

---

Description

Based on the Idea of a Single Page Editor from MarkTwo we created our own Markdown editor around that concept. The editor exchanges Markdown and HTML block by block seamlessly via the help of markdown-it and turndown.

---

Features

• Single Page View - Switch between Markdown and HTML Blocks
• Snippets - Create your own Markdown rules via RegEx
• Dark Mode - for everyone who doesn't like to be blinded
• Drag & Drop Files - Just Drag & Drop your Markdown Files into the Editor
• Export - Export as Markdown or HTML file
• CommonMark & GFM - CommonMark and GitHub Flavored Markdown already included wow !
• Context Menu - use the right click to fast edit entire blocks !
• Offline saves - the local storage of the browser is used to save and auto save the file

---

Security Warning

Important: The HTML in this Markdown editor doesn't get sanitized. Because of this, you need to be careful when including HTML to avoid potential security risks.

---

Still To-Do

• Database + Profiles for Cloud Storage e.g Files and Pictures
• Collaborative writing
• Presentation + Document View
• More Settings
  • Hotkeys
  • Safety Settings
  • Preferable Markdown Syntax
  • ...
• QoL Stuff

---

Installation

# install dependencies
npm install

# serve with hot reload at localhost:3000
node .

---

Tech used

Backend

• Node.js: Free, open-source, cross-platform JavaScript runtime environment
• Express.js: Fast, unopinionated, minimalist web framework for Node.js

Parser

• markdown-it: Markdown --> HTML Parser
• turndown: HTML --> Markdown Parser

Prototyping

• Figma - Figma is a collaborative web application for interface design