abaoworld / markdownfox

a simple Markdown viewer with auto update and PDF export

MarkdownFox

a simple Markdown viewer with auto update and PDF export

Features

• updates preview when you make changes to the Markdown file
• supports GFM (GitHub Flavored Markdown)
• renders LaTeX-like formulae if they're surrounded by $$
• PDF export
• syntax highlighting in code blocks

Downloads

... can be found at releases

Known issues

• When using gedit only the first change to the Markdown file triggers an update of the preview in MarkdownFox. This doesn't seem to happen with other editors. Issue regarding this bug

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:9080
npm run dev

# build electron application for production
npm run build

# lint all JS/Vue component files in `src/`
npm run lint

Powered by

• Vue.js by Yuxi (Evan) You
• Electron by GitHub Inc.
• Electron-Vue by SimulatedGREG
• Marked by chjj
• highlight.js by isagalaev
• github-markdown-css by sindresorhus
• KaTeX by Khan Academy

License

MIT
Open Source licenses can be found in OPENSOURCE_LICENSES and in the app

---

This project was generated with electron-vue@7c4e3e9 using vue-cli. Documentation about the original structure can be found here.