Skip to content
/ mdp Public
forked from ericlink/mdp

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

License

Notifications You must be signed in to change notification settings

fgantt/mdp

 
 

Repository files navigation

mdp

mark down preview using marked, highlight.js, mermaid and live reload

mdp releases

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

dev

  1. npm install
  2. npm run dev

test and publish

  1. npm run dev & - run in background to test open-file with subsequent open
  2. npm run dev-noarg - tests launch with no arg, app starts with no window
  3. ./node_modules/.bin/electron ./src/main.js ./README.md
  4. npm run dev-publish
  5. open from finder once packaged
  6. open from mdp shell script once packaged
  7. tail -f ~/Library/Logs/mdp/log.log

upstream repo is git clone https://github.com/ericlink/electron-forge-webapp-template.git

package

  1. npm install
  2. npm run package
  3. npm run make && npm run publish

todo

usability

  • 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

nice to have

  • get working with highlight.js themes
  • get working with marked themes

package and install

  • installer - install command line script
  • mac code signing

done

  • open url only add listener once, not every reload
  • export menu (html, open in browser)
  • open links in os browser
  • expand cmd args to absolute path
  • fix up js
  • window menu
  • close window key
  • get working from file associated in finder
  • get working opening multiple from command line
  • get working as cmd line
  • get working as packaged
  • github release using electron-forge
  • keep scroll position on reload
  • move poc into app (works using dev command line)

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CSS 76.3%
  • JavaScript 22.6%
  • Other 1.1%