Skip to content

Commit 75e82b2

Browse files
authored
Update README.md
1 parent eb609b2 commit 75e82b2

File tree

1 file changed

+27
-2
lines changed

1 file changed

+27
-2
lines changed

README.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,34 @@ Simple Markdown editor built with syntax highlighting and an optional preview th
1515
- Export the raw .md file
1616
- Optional Preview
1717

18-
## TODO
18+
## Development / Self Hosting
19+
20+
The app is a straightforward vuejs app and just a client sided one. You can set it up using the following steps.
21+
22+
**Prerequisite**
23+
1. [Node](https://nodejs.org/en/) at least v12
24+
2. [git](https://git-scm.com/)
25+
26+
**Steps**
27+
```sh
28+
# clone this repo
29+
git clone https://github.com/barelyhuman/mark
30+
31+
# cd into it and install the basic dependencies
32+
npm i
33+
34+
# run the dev server to check if it's working (optional)
35+
npm dev
36+
37+
# build the app into static files
38+
npm build
39+
40+
# you can then serve the output folder using your favorite http serving solution
41+
npx serve dist
42+
# or
43+
python –m SimpleHTTPServer dist
44+
```
1945

20-
- Browser storage (store the currently entered text in the browser)
2146

2247
## Contribute
2348

0 commit comments

Comments
 (0)