|
1 | 1 | # mdp |
2 | 2 | **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 |
3 | 5 |
|
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) |
5 | 26 |
|
6 | | -to use from the command line, put the `mdp` script in the `package` directory in your path. |
7 | 27 |
|
8 | 28 | ## logs |
9 | 29 | on Linux - `~/.config/<app name>/log.log` |
@@ -39,20 +59,18 @@ upstream repo is `git clone https://github.com/ericlink/electron-forge-webapp-te |
39 | 59 | - [ ] zoom by window? |
40 | 60 |
|
41 | 61 | ### tech |
42 | | -- [ ] auto updater using git releases |
43 | 62 | - [ ] get electron-forge start working (not passing arg; detect mode and default arg to readme?) |
44 | | -- [ ] installer - install command line script |
45 | 63 | - [ ] load modules more efficiently? |
46 | | -- [ ] webpack |
| 64 | +- [ ] webpack? |
47 | 65 |
|
48 | 66 | ### nice to have |
49 | 67 | - [ ] preferences to set editor, e.g. var executablePath = "mvim"; |
50 | 68 | - [ ] get working with *highlight.js* themes |
51 | 69 | - [ ] get working with *marked* themes |
52 | 70 |
|
53 | 71 | ### 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 |
56 | 74 |
|
57 | 75 | ## done |
58 | 76 | - [x] emoji support |
|
0 commit comments