Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sil3ncer1/markus
MARKus - online Markdown editor
https://github.com/sil3ncer1/markus
editor javascript markdown markdown-editor
Last synced: 3 days ago
JSON representation
MARKus - online Markdown editor
- Host: GitHub
- URL: https://github.com/sil3ncer1/markus
- Owner: Sil3ncer1
- License: mit
- Created: 2024-05-14T14:13:06.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T10:15:12.000Z (16 days ago)
- Last Synced: 2024-09-24T21:14:26.744Z (3 days ago)
- Topics: editor, javascript, markdown, markdown-editor
- Language: JavaScript
- Homepage: http://markus.redirectme.net/
- Size: 17.4 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
MARKus
* * *
⋆⭒˚｡⋆ Single Page View Markdown Editor ⋆⭒˚｡⋆
* * *
## Description
Based on the Idea of a Single Page Editor from [MarkTwo](https://github.com/anthonygarvan/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`](https://github.com/markdown-it/markdown-it) and [`turndown`](https://github.com/mixmark-io/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](https://nodejs.org/en): Free, open-source, cross-platform JavaScript runtime environment
* [Express.js](https://expressjs.com/): Fast, unopinionated, minimalist web framework for Node.js
### Parser
* [markdown-it](https://github.com/markdown-it/markdown-it): Markdown --> HTML Parser
* [turndown](https://github.com/mixmark-io/turndown): HTML --> Markdown Parser
### Prototyping
* [Figma](https://www.figma.com) - Figma is a collaborative web application for interface design