Skip to content

Commit 439a475

Browse files
author
Eric Link
committed
0.0.4
1 parent f2dbab3 commit 439a475

File tree

2 files changed

+28
-8
lines changed

2 files changed

+28
-8
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,29 @@
11
# mdp
22
**m**ark **d**own **p**review using marked, highlight.js, mermaid, node-emoji and live reload
3+
- [mdp releases](https://github.com/ericlink/mdp/releases)
4+
- for command line on macOS - put the `mdp.app/Contents/Resources/app/package/mdp` script in your path
35

4-
[mdp releases](https://github.com/ericlink/mdp/releases)
6+
## features
7+
8+
### example
9+
[example.md](https://github.com/ericlink/mdp/blob/master/assets/example.md)
10+
11+
### marked markdown parsing
12+
[https://marked.js.org/](https://marked.js.org/)
13+
14+
[https://github.com/markedjs/marked](https://github.com/markedjs/marked)
15+
16+
### highlight.js syntax highlighting
17+
[https://highlightjs.org/](https://highlightjs.org/)
18+
19+
### mermaid diagrams
20+
[https://mermaidjs.github.io/](https://mermaidjs.github.io/)
21+
22+
### node-emoji
23+
[https://github.com/omnidan/node-emoji](https://github.com/omnidan/node-emoji)
24+
25+
[supported emoji](https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)
526

6-
to use from the command line, put the `mdp` script in the `package` directory in your path.
727

828
## logs
929
on Linux - `~/.config/<app name>/log.log`
@@ -39,20 +59,18 @@ upstream repo is `git clone https://github.com/ericlink/electron-forge-webapp-te
3959
- [ ] zoom by window?
4060

4161
### tech
42-
- [ ] auto updater using git releases
4362
- [ ] get electron-forge start working (not passing arg; detect mode and default arg to readme?)
44-
- [ ] installer - install command line script
4563
- [ ] load modules more efficiently?
46-
- [ ] webpack
64+
- [ ] webpack?
4765

4866
### nice to have
4967
- [ ] preferences to set editor, e.g. var executablePath = "mvim";
5068
- [ ] get working with *highlight.js* themes
5169
- [ ] get working with *marked* themes
5270

5371
### package and install
54-
- [ ] installer - install command line script
55-
- [ ] mac code signing
72+
- [ ] installer - install command line script into /usr/local/bin
73+
- [ ] sign app to enable auto updater using git releases
5674

5775
## done
5876
- [x] emoji support

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@
6262
"name": "@electron-forge/maker-zip",
6363
"platforms": [
6464
"darwin"
65-
]
65+
],
66+
"config": {
67+
}
6668
},
6769
{
6870
"name": "@electron-forge/maker-deb",

0 commit comments

Comments
 (0)