Skip to content

Latest commit

 

History

History
85 lines (58 loc) · 1.85 KB

README.md

File metadata and controls

85 lines (58 loc) · 1.85 KB
Raw

Mark

Web Markdown Editor

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

# 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

version: "3"

services:
  mark:
    image: ghcr.io/barelyhuman/mark:pro
    ports:
      - 8000:80
    restart: unless-stopped

and then

# 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 at least v12
  2. git

Steps

# 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 © Reaper