sachaos / note

Simple Real-time Markdown previewer

note

Simple Real-time Markdown previewer & editor.

Description

note is a command written in Go. This command improve your Markdown editing experience on your favorite editor(emacs, vim etc) by rendering on Web browser in real time.

This software watch markdown file which you are editing, and serve that markuped HTML to browser through WebSocket when that file changed.

Features

• Style like GitHub
• No dependencies on specific editor
  • note use editor which is set in $EDITOR
• Support PlantUML

Demo

PlantUML

Install

Binary

Go to release page and download.

or

$ wget https://github.com/sachaos/note/releases/download/v0.4.0/note_darwin_amd64 -O /usr/local/bin/note
$ chmod +x /usr/local/bin/note

Manually Build

You need Go 1.11 compiler.

$ git clone https://github.com/sachaos/note.git
$ make install

How to use

$ note {filename}