morkdown

A markdown editor built on Chrome & Node

npm install morkdown
1 downloads in the last day
52 downloads in the last week
68 downloads in the last month

Morkdown

A beautifully simple editor for Markdown documents

NPM

Morkdown is primarily designed to render GitHub Flavored Markdown (GFM), so it's ideal for your README.md. When rendering the Markdown, it uses the same syntax highlighter as GitHub (the Python Pygments library) and the styling is near identical to GitHub. Markdown content is parsed using marked, a JavaScript Markdown parser capable of parsing GFM.

WOW!!!

Morkdown editing the LevelUP README

Morkdown is a Google Chrome App coupled to a Node server and uses CodeMirror for the editor panel.

GFM you say?

Morkdown editing the LevelUP README with the "monokai" theme

Morkdown will automatically save your document as you edit it.

Themes

Morkdown is packaged with the standard CodeMirror themes, you can switch to a different theme with the --theme <themename> commandline argument:

  • ambiance
  • ambiance-mobile
  • blackboard
  • cobalt
  • eclipse
  • elegant
  • erlang-dark
  • lesser-dark
  • midnight
  • monokai
  • neat
  • night
  • rubyblue
  • solarized
  • twilight
  • vibrant-ink
  • xq-dark
  • xq-light

The default theme is neat but you can set your own default theme by saving a JSON file in your home directory named .morkdownrc with the following content: { "theme": "themename" }. (My theme of choice is monokai).

Installing & Using

You'll need Google Chrome of course, plus you'll need a python interpreter on your system to get the syntax highlighting working—which should be fine for Linux and Mac users. Getting it running on Windows might be a little tricky (but presumably not impossible!).

You can install from npm, the Node.js package manager, with npm install -g morkdown (you may need to sudo that depending on your setup). Once installed you can simply run the morkdown <path to file.md> command and you're away!

If you want to use an editor of your choice, launch morkdown with a watch flag, e.g. morkdown -w <path to file.md> and morkdown will re-render the output in the browser when the file is saved locally.

Contributors

morkdown is brought to you by the following hackers:

Morkdown is Copyright (c) 2013 Rod Vagg <@rvagg> and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

Morkdown contains remnants of me, which is Copyright (c) 2013 Julian Gruber julian@juliangruber.com and licenced under the MIT licence.rubyblue.css

npm loves you