0

note

Simple Real-time Markdown previewer

Github repo
Main metrics
  • Owner: sachaos/note
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

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

note2 mp4

PlantUML

plantuml mp4

Install

Binary

Go to release page and download.

or

$ wget https://github.com/sachaos/note/releases/download/v0.3.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}

Main metrics

Overview
Name With Ownersachaos/note
Primary LanguageGo
Program languageGo (Language Count: 5)
Platform
License:MIT License
所有者活动
Created At2018-07-17 03:27:26
Pushed At2023-03-06 23:45:24
Last Commit At2021-12-15 11:20:18
Release Count9
Last Release Namev0.4.0 (Posted on )
First Release Namev0.0.1 (Posted on )
用户参与
Stargazers Count111
Watchers Count5
Fork Count5
Commits Count119
Has Issues Enabled
Issues Count5
Issue Open Count2
Pull Requests Count15
Pull Requests Open Count6
Pull Requests Close Count3
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private