Skip to content

Commit

Permalink
docs: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
barelyhuman committed Jul 7, 2024
1 parent d7e2c18 commit bdf6832
Showing 1 changed file with 40 additions and 11 deletions.
51 changes: 40 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,40 +13,69 @@ Simple Markdown editor built with syntax highlighting and an optional preview th
- Export the raw .md file
- Optional Preview

## Development / Self Hosting
## Development / Self Hosting

### Docker
TBD

```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.
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

1. [Node](https://nodejs.org/en/) at least v12
2. [git](https://git-scm.com/)

**Steps**

```sh
# clone this repo
# clone this repo
git clone https://github.com/barelyhuman/mark

# cd into it and install the basic dependencies
npm i
npm i

# run the dev server to check if it's working (optional)
npm dev
npm dev

# build the app into static files
# build the app into static files
npm build

# you can then serve the output folder using your favorite http serving solution
# you can then serve the output folder using your favorite http serving solution
npx serve dist
# or
# 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
Expand Down

0 comments on commit bdf6832

Please sign in to comment.