@@ -13,40 +13,69 @@ Simple Markdown editor built with syntax highlighting and an optional preview th
13
13
- Export the raw .md file
14
14
- Optional Preview
15
15
16
- ## Development / Self Hosting
16
+ ## Development / Self Hosting
17
17
18
18
### 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
+ ```
20
48
21
49
### Manually using Source Code
22
50
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.
24
52
25
53
** Prerequisite**
26
- 1 . [ Node] ( https://nodejs.org/en/ ) at least v12
54
+
55
+ 1 . [ Node] ( https://nodejs.org/en/ ) at least v12
27
56
2 . [ git] ( https://git-scm.com/ )
28
57
29
58
** Steps**
59
+
30
60
``` sh
31
- # clone this repo
61
+ # clone this repo
32
62
git clone https://github.com/barelyhuman/mark
33
63
34
64
# cd into it and install the basic dependencies
35
- npm i
65
+ npm i
36
66
37
67
# run the dev server to check if it's working (optional)
38
- npm dev
68
+ npm dev
39
69
40
- # build the app into static files
70
+ # build the app into static files
41
71
npm build
42
72
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
44
74
npx serve dist
45
- # or
75
+ # or
46
76
python –m SimpleHTTPServer dist
47
77
```
48
78
49
-
50
79
## Contribute
51
80
52
81
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