MARKFLY

Live Markdown Previewer

Install

npm install -g markfly

Features

• Live update without reloading the page.
• Automatically scrolls to match text changes!
• Scrolling options, to always keep the important text visible
• Syntax highlighting for code blocks (powered by highlight.js)
• Multiple browser connections
• Editor agnostic. It's only a webapp.
• Works on Linux and MacOSX. Windows still needs to be tested.
• Control routes, for remote access.

Usage

In a terminal window, run markfly <mardown file>, and point a browser to localhost:8494. You should see a compiled version of your file.

Edit the markdown file, and the change should reflect instantly in the browser preview.

Command Line Arguments

• --port: the port to run the server. Default is 8494
• -p: alias to --port
• --host: the host to connect websockets. Default is localhost.
• -h: alias to --host

markfly --port=9000 myfile.md #opens in localhost:9000

markfly -p9000 myfile.md      #same as previous, shorter

markfly --host=192.168.10.10  #changes the host
                              #could also be -h192.168.10.10

Scrolling Modes

There are three scrolling modes available just yet, accessible with the icons on the right of the screen.

• Smart Scroll will make the screen scroll to match the last change!!!
• The Pin Down icon (with an arrow), will make the window scroll to the bottom whenever text changes.
• Fix Scroll, will make the browser window to not scroll at all when the content changes.

Control Routes

Accessing these routes will control Markfly remotely. This feature is intended to be used by editor extensions, to avoid restarts in Markfly server and to allow them to tweak into the Markfly window.

GET /scroll/smart

This will change all connected clients into Smart scroll mode.

GET /scroll/pin-down

This will change all connected clients into Pin Down scroll mode;

GET /scroll/fixed

This will change all connected clients into Fixed scroll mode;

POST /file

Send a plain text content, with the full path of a markdown file. This will change the file that Markfly will be watching. Also, will automatically update any browser window currently opened.

POST /content

Send a markdown content in the body. This will compile and send that markdown directly to the connected browser windows. This can be used to preview files without the need to save them.

GET /quit

Terminates Markdown server.

Also, there is a .markfly_port file that will be created in the directory markfly was run, containing only the port number that markfly is running. This file is automatically deleted when markfly closes.

License

Markfly is released under ISC License. Click here for details.

TODOS

• Include some control routes, such as /set-content and /config, for use in editor extensions.
• Check smart scroll accuracy across different browsers.
• Test on windows.

Author

jsanchesleao [email protected]