Would be nice if it would default to README.md when no file name is supplied.

Following up on #32, we might want to improve the syntax highlighting. GitHub uses pygments, so https://github.com/rvagg/node-pygmentize-bundled might be a good option. Any other suggestions / options? I've tried https://github.com/atom/highlights once, but I remember it being slightly different from the github.com's styles.

derp, wrong repo haha

Firstly, really cool little app + tool- this is exactly something I've been wanting of late, as I have a similar folder like your knowledge repo 😉 However, I often find myself needing to toggle between a few .md files on a given topic, like git for instance!

The idea I have is adding the ability to pass vmd a directory of .md files. Upon doing this, vmd would create a sidebar containing a list of links of these files, which upon clicking on loads in the rendered view.

Sound useful to anyone else?

Currently the window title is "Atom Shell". Would be nice if it was something like "filename - vmd" instead.

I am writing keyboard reference documentation, and need to use ⌘ for the Apple Command Symbol. VMD only displays a box instead of ⌘

Any way to fix this?

Given that drag'n'drop functionality for markdown files exist (#69), would it be feasible to have a default view for the app when started in a folder without an existing .md file?

Eg. something like this (just a single UX element without animations or simple text would work fine)
https://cdn.css-tricks.com/wp-content/uploads/2015/11/drag-drop-upload-1.gif

I'd be willing to work on a PR for this if you're interested, but am swamped with things at least the upcoming week, so if someone else is keen just go ahead.

GFM is nice and all, but it has some inconsistencies with common markdown; most notably for me, the characters used to generate a table.

Hmm, just started hitting this on a fresh global install. I cleared my ~/.electron cached downloads and tried again, same error.

I'll poke around.

e.g. be able to do this:

cat README.md | vmd

Doesn't make vmd a pager yet, but does allow for more unixy actions. Also maybe detect if in TTY to pipe to stdout. Not sure what the added value would be over something like cat, but playing ball with cli tools is a good thing imo.

vmd README.md | grep -C 3 foo > file.md

On OSX with a fresh install (just found out about this project today) the About vmd menu option throws an error:

This happens consistently (tried a few times).

Support emoji

I have retroactively added and pushed version tags to the corresponding commits so it's easier to check out the source at a specific version.

I love this tool and use it almost every day while looking over READMEs in local node_modules. One thing that I personally would really enjoy—which is a bit of a pipe dream—would be keyboard scrolling with J and K keys. (It would also be nice to be able to use gg and G as well, not to mention searching for text with /).

Like this:

• yolo
• w00t

This pager is inaccessible to me, and others, without the ability to change the default text size or zoom.

/cc @blink1073 @Carreau

There are some unnecessary and broken menu items in the "vmd" menu. I believe they were just copy-pasted from Electron's menu template example and we should get rid of them.

• At least on Linux all menu items except "Quit" are broken and result in an error (see screenshot at the bottom)
• The "About" menu item could be fixed to provide some basic information about the package. But until there's a proper "About" dialog it should be removed or disabled.
• The "Services" menu is empty.
• The "Hide", "Hide others", "Show all" menus are unnecessary (and broken). Pretty much every OS comes with a window manager that already has convenient ways to show, hide, etc. a window.

This is the error when clicking any of the menu items:

Would be awesome if you guys added an archive to the releases so we wont have to download and run npm ourselfs. What do you think?

Code inside the tripple-back-tick blocks ``` currently isn't highlighted.

Hi,

I always get:

Cannot load style node_modules/github-markdown-css/github-markdown.css: no such file

error when using default, documented command line:

vmd README.md 

or:

vmd

or:

npm view browserify readme | vmd

The github-markdown-css is listed as dependency.

node --version
v4.2.4
npm --version
2.14.12
vmd --version
1.22.1

OS X/10.10.*

[email protected] /usr/local/lib/node_modules/vmd
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected]
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
├── [email protected] ([email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected], [email protected])
└── [email protected] ([email protected], [email protected])

Thanks!

Would be cool if it was possible to drag files from the desktop or file manager in to vmd.
When vmd receives a file it would automatically render the new file and start watching it.
The functionality to change the file inside a vmd window is already implemented.

Bonus features

• Dropping a file while holding the shift key would open the dropped file in a new window.
• Ability to drop an URL to a markdown file and render it.

Can't scroll atm. Should add:

body {
  overflow-y: auto;
}

From PintaProject/Pinta

I just updated vmd to version 1.25.1 and now it won't start anymore 😢

App threw an error when running [TypeError: Cannot read property 'on' of undefined]
A JavaScript error occurred in the main process
Uncaught Exception:
TypeError: Cannot read property 'on' of undefined
    at Object.<anonymous> (/usr/lib/node_modules/vmd/main/main.js:65:4)
    at Module._compile (module.js:425:26)
    at Object.Module._extensions..js (module.js:432:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:313:12)
    at loadApplicationPackage (/usr/lib/node_modules/vmd/node_modules/electron-prebuilt/dist/resources/default_app/main.js:257:23)
    at Object.<anonymous> (/usr/lib/node_modules/vmd/node_modules/electron-prebuilt/dist/resources/default_app/main.js:289:5)
    at Module._compile (module.js:425:26)
    at Object.Module._extensions..js (module.js:432:10)
    at Module.load (module.js:356:32)

I really love this app, so is there anything I can do to fix it?

I tried to run vmd README.md and it does... nothing.

Does it perhaps not work on Linux?

expected

After installing with npm -g vmd, running vmd readme.md will open a window with a markdown preview of my readme.

actual

running vmd readme.md or even vmd without arguments, I get the following:

I can open a file to preview with the app menu (Command+O) after the program has opened, but initial state is always the contents of main/main.js from the vmd repo as far as I can tell. I haven't cloned it locally so it's definitely coming from inside the electron app.

When hovering over a link there's no preview like it happens in the browser. I think it's useful to verify that links indeed point to the intended location.

Would be cool to have a nice window icon that would be visible in the task bar & window title bar.

When opening a link to a markdown file in a new window and closing it again, the application menu in the first throws an exception when clicking on an item in the menu.

Images with a relative path to the Markdown file won't load.

It only works when inside the vmd repository and ./cli.js README.md. But it doesn't work with anything else.

Downloading electron-v0.30.6-darwin-x64.zip
[============================================>] 100.0% of 35.32 MB (780.66 kB/s)
/usr/local/lib/node_modules/vmd/node_modules/electron-prebuilt/install.js:15
throw err
^
Error: EACCES, rename '/usr/local/lib/node_modules/vmd/node_modules/electron-prebuilt/electron-tmp-download-4550-1441578968203/electron-v0.30.6-darwin-x64.zip'
at Error (native)
npm ERR! Darwin 14.5.0
npm ERR! argv "node" "/usr/local/bin/npm" "install" "-g" "vmd"
npm ERR! node v0.12.4
npm ERR! npm v2.10.1
npm ERR! code ELIFECYCLE

npm ERR! [email protected] postinstall: node install.js
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] postinstall script 'node install.js'.
npm ERR! This is most likely a problem with the electron-prebuilt package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR! node install.js
npm ERR! You can get their info via:
npm ERR! npm owner ls electron-prebuilt
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR! /Users/jonatasfreitas/npm-debug.log

for example q does not quit app, but ESC does work. 😄

I just updated to latest vmd and <img> tags don't seem to be showing anymore. Screenshot attached:

(look near the bottom)

I installed the latest (1.21.0) and can't seem to use it any more. Error attached.

node v4
npm 2.14.2

I'm planning on packaging vmd for Arch Linux. But "vmd" is already taken as a package name in the Arch User Repository (AUR) by a program that does "Visual Molecular Dynamics".

Is there a preferred alternative name that I should use? Any suggestions?

Open a file in vmd by selecting it from the file system.

Menu structure:

• File
  • Open
  • Open in new window
  • Print

Creating this issue for discussion. See recent comments on #6.

Some menu items in both the context menu and the application menu should only be enabled when certain conditions are met, others should be hidden.

Examples:

• Edit -> Copy should only be visible when some text is selected
• History -> Back should only be enabled if it's possible to go back
• History -> Forward should only be enabled if it's possible to go forward

here's the idea:

1. I create a very light weight plugin for my editor (vi, sublime text, emacs, atom, whatever)
2. all the plugin does is vmd scroll-to <current text buffer> either on save, or perhaps when the text buffer changes, or perhaps polling - where <current text buffer> is literally the text being displayed by the editor
3. vmd renders the text buffer to html, and searches for that html, if there's a match then scroll to the beginning of the text

This is easier than trying to exactly co-ordinate scroll positions between an editor and the vmd window, and would make editor plugin creation trivial

Only consideration could be how heavy this is - probably not that heavy, how big is a text buffer, couple of hundred bytes?

For most Highlight.js themes background is pretty much part of the theme. However, background is currently missing with vmd.

should be:

Some themes are really ugly without a proper background:

Fixing this issue requires applying a hljs class on pre element or containing div. Unfortunately, it isn't that simple because of a higher-specificity rule in github-markdown-css. I don't really know how to solve that. Any ideas?

Would be nice to be able to search within a document.

I was thinking about the following functionality, similar to how it works in browsers:

• Press Control/Cmd+F or select "Search" from a menu, type search query.
• Highlight all results (preferably as you type).
• Jump back and forth between results.
• Press Esc to hide search input and clear results.

Things to check out:

• webContents.findInPage(text[, options]) (docs)
• webContents.stopFindInPage(action) (docs)

Some thoughts and opinions on what links inside the rendered markdown document should do.

• Links to external sites should open in the default desktop browser.
• Links to sections within the same document (e.g. #my-section-title) should load in the same window.
• Debatable: Relative links to other markdown documents in (e.g. ./CHANGELOG.md)
• Debatable: Links to external markdown documents (e.g. github.com/other/project/README.md)
• Thinkable: How does one get back after opening a link that opens in the same window?

atom-shell has the shell module that could help with this. It also provides shell.openExternal(url).

Being able to generate html/pdf files from the terminal would be great.

vmd readme.md > readme.html
vmd readme.md > readme.pdf

It would be nice to be able to modify the defaults stylesheets to use alternative one.

vmd README.md --style=/folderCss/styles.css"

or with a config file vmd.conf in the .md directory