https://github.com/ericlink/mdp

markdown preview using marked, highlight.js, mermaid, node-emoji and live reload
https://github.com/ericlink/mdp

electron electron-forge emoji highlight-js live-reload markdown mermaid mermaid-diagrams node-emoji preview previewer

Last synced: 11 months ago
JSON representation

markdown preview using marked, highlight.js, mermaid, node-emoji and live reload

• Host: GitHub
• URL: https://github.com/ericlink/mdp
• Owner: ericlink
• License: apache-2.0
• Created: 2019-03-16T17:39:31.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T17:46:29.000Z (over 3 years ago)
• Last Synced: 2024-11-25T16:38:52.793Z (over 1 year ago)
• Topics: electron, electron-forge, emoji, highlight-js, live-reload, markdown, mermaid, mermaid-diagrams, node-emoji, preview, previewer
• Language: CSS
• Homepage: https://ericlink.github.io/mdp/
• Size: 3.46 MB
• Stars: 44
• Watchers: 5
• Forks: 7
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


# mdp

markdown preview using marked, highlight.js, mermaid, node-emoji and live reload

[https://ericlink.github.io/mdp/](https://ericlink.github.io/mdp/)

![markdown.png](./docs/markdown.png)

![mermaid.png](./docs/mermaid.png)

## features

### 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)

### marked markdown parsing

github flavored markdown

[https://marked.js.org/](https://marked.js.org/)

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

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

### keys

_Open as HTML_ ⌘K

_Edit Markdown_ ⌘E

_Zoom_ - zoom in ⌘+, zoom out ⌘-, actual size ⌘0

### macOS

full screen support

dark mode window

### command line

put `mdp.app/Contents/Resources/app/package/mdp` script in your path

### logs

on Linux - `~/.config//log.log`

on macOS - `~/Library/Logs//log.log`

on Windows - `%USERPROFILE%\AppData\Roaming\\log.log`