Skip to content

Commit

Permalink
0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Link committed Mar 30, 2019
1 parent f2dbab3 commit 439a475
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 8 deletions.
32 changes: 25 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,29 @@
# mdp
**m**ark **d**own **p**review using marked, highlight.js, mermaid, node-emoji and live reload
- [mdp releases](https://github.com/ericlink/mdp/releases)
- for command line on macOS - put the `mdp.app/Contents/Resources/app/package/mdp` script in your path

[mdp releases](https://github.com/ericlink/mdp/releases)
## features

### example
[example.md](https://github.com/ericlink/mdp/blob/master/assets/example.md)

### marked markdown parsing
[https://marked.js.org/](https://marked.js.org/)

[https://github.com/markedjs/marked](https://github.com/markedjs/marked)

### highlight.js syntax highlighting
[https://highlightjs.org/](https://highlightjs.org/)

### mermaid diagrams
[https://mermaidjs.github.io/](https://mermaidjs.github.io/)

### node-emoji
[https://github.com/omnidan/node-emoji](https://github.com/omnidan/node-emoji)

[supported emoji](https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)

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

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

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

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

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

## done
- [x] emoji support
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,9 @@
"name": "@electron-forge/maker-zip",
"platforms": [
"darwin"
]
],
"config": {
}
},
{
"name": "@electron-forge/maker-deb",
Expand Down

0 comments on commit 439a475

Please sign in to comment.