Skip to content

Commit bdf6832

Browse files
committed
docs: updated docs
1 parent d7e2c18 commit bdf6832

File tree

1 file changed

+40
-11
lines changed

1 file changed

+40
-11
lines changed

README.md

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,40 +13,69 @@ Simple Markdown editor built with syntax highlighting and an optional preview th
1313
- Export the raw .md file
1414
- Optional Preview
1515

16-
## Development / Self Hosting
16+
## Development / Self Hosting
1717

1818
### Docker
19-
TBD
19+
20+
```sh
21+
# for a single run
22+
; docker run -p 8000:80 ghcr.io/barelyhuman/mark:pro
23+
# or in detached mode / background mode
24+
docker run -p 8000:80 --detach ghcr.io/barelyhuman/mark:pro
25+
```
26+
27+
Or if you prefer using a docker compose
28+
29+
```yaml
30+
version: "3"
31+
32+
services:
33+
mark:
34+
image: ghcr.io/barelyhuman/mark:pro
35+
ports:
36+
- 8000:80
37+
restart: unless-stopped
38+
```
39+
40+
and then
41+
42+
```sh
43+
# for a single run
44+
; docker compose up
45+
# or in detached mode / background mode
46+
; docker compose up -d
47+
```
2048

2149
### Manually using Source Code
2250

23-
The app is a straightforward vuejs app and just a client sided one. You can set it up using the following steps.
51+
The app is a straightforward vuejs app and just a client sided one. You can set it up using the following steps.
2452

2553
**Prerequisite**
26-
1. [Node](https://nodejs.org/en/) at least v12
54+
55+
1. [Node](https://nodejs.org/en/) at least v12
2756
2. [git](https://git-scm.com/)
2857

2958
**Steps**
59+
3060
```sh
31-
# clone this repo
61+
# clone this repo
3262
git clone https://github.com/barelyhuman/mark
3363

3464
# cd into it and install the basic dependencies
35-
npm i
65+
npm i
3666

3767
# run the dev server to check if it's working (optional)
38-
npm dev
68+
npm dev
3969

40-
# build the app into static files
70+
# build the app into static files
4171
npm build
4272

43-
# you can then serve the output folder using your favorite http serving solution
73+
# you can then serve the output folder using your favorite http serving solution
4474
npx serve dist
45-
# or
75+
# or
4676
python –m SimpleHTTPServer dist
4777
```
4878

49-
5079
## Contribute
5180

5281
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

0 commit comments

Comments
 (0)