Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/barelyhuman/mark
Quick Web Markdown Editor
https://github.com/barelyhuman/mark
editor markdown webapp
Last synced: 6 days ago
JSON representation
Quick Web Markdown Editor
- Host: GitHub
- URL: https://github.com/barelyhuman/mark
- Owner: barelyhuman
- License: mit
- Created: 2020-08-04T00:58:47.000Z (over 4 years ago)
- Default Branch: pro
- Last Pushed: 2024-10-21T17:07:44.000Z (15 days ago)
- Last Synced: 2024-10-22T03:38:41.554Z (15 days ago)
- Topics: editor, markdown, webapp
- Language: Vue
- Homepage: https://mark.barelyhuman.dev
- Size: 1.41 MB
- Stars: 89
- Watchers: 5
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-markdown-editors - `barelyhuman/mark` - Simple Web Markdown Editor (Markdown Online Editors)
README
Mark
Web Markdown Editor
[](LICENSE)
## Motivation
Simple Markdown editor built with syntax highlighting and an optional preview that I mostly use for my work. I don't like the apps that exist and are mostly pretty memory heavy, on the other hand the web app is pretty simple and suffices most of what I use Markdown for
## Features
- System Controlled Dark Mode
- Export the raw .md file
- Optional Preview
## Development / Self Hosting
### Docker
```sh
# for a single run
; docker run -p 8000:80 ghcr.io/barelyhuman/mark:pro
# or in detached mode / background mode
docker run -p 8000:80 --detach ghcr.io/barelyhuman/mark:pro
```
Or if you prefer using a docker compose
```yaml
version: "3"
services:
mark:
image: ghcr.io/barelyhuman/mark:pro
ports:
- 8000:80
restart: unless-stopped
```
and then
```sh
# for a single run
; docker compose up
# or in detached mode / background mode
; docker compose up -d
```
### Manually using Source Code
The app is a straightforward vuejs app and just a client sided one. You can set it up using the following steps.
**Prerequisite**
1. [Node](https://nodejs.org/en/) at least v12
2. [git](https://git-scm.com/)
**Steps**
```sh
# clone this repo
git clone https://github.com/barelyhuman/mark
# cd into it and install the basic dependencies
npm i
# run the dev server to check if it's working (optional)
npm dev
# build the app into static files
npm build
# you can then serve the output folder using your favorite http serving solution
npx serve dist
# or
python –m SimpleHTTPServer dist
```
## Contribute
The easiest way to contribute is to fork the project and raise PR's. Though, do inform the mainter as to what issue you pick up to avoid overlaps
## License
[MIT](LICENSE) © Reaper