• Stars
    star
    326
  • Rank 129,027 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated about 4 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

We need a better Markdown previewer.

logo

We need a better Markdown previewer.

travis

pen is a Markdown previewer written in JavaScript, aiming to just work.

There are literally tons of Markdown previewers out there. I love some of them, I even made one of them. Nevertheless, we always need a better one, don't we?

Using pen is super simple, we don't need to install any special editor or launch any GUI application. pen is just a tidy command-line tool. You can use your favourite editor and browser. No manual refresh is even needed.

Also, the previewer renders the content using React. It means that it will not re-render entire DOM when the document is updated. This is a huge advantage because images or other media won't be reloaded for the DOM update.

I personally love to use pen, and I hope you love it too. βœ’οΈ

Demo

Here is a short demo showing how awesome pen is.

demo

The following demo shows pen incrementally updates only modified part using React and its Reconciliation.

incremental update

Requirement

pen uses Node.js >= 4.0. It may not work on earlier versions.

Install

Using npm:

npm i -g pen

You can try using pen with npx:

npx pen

Usage

To use pen, simply run the pen command.

pen README.md

The command above will launch a pen server and open the file in your default browser. The server will listen to a 6060 port by default. To be honest, you don't even need to launch it with a filename. You can manually open http://localhost:6060/README.md, or any other files in the same directory.

To stop the server, enter ^C.

For the further details of the pen command, please enter pen -h or pen --help.

Pandoc

Pen uses markdown-it as Markdown parser by default, but it also supports Pandoc. Please provide a proper Pandoc format for the value.

pen --pandoc gfm README.md

Contribution

I welcome every contribution on pen. You may start from forking and cloning this repo.

git clone [email protected]:your_username/pen.git
cd pen

# Install dependencies
npm i

# Lint, build, and test pen codes at once
npm test

To build frontend scripts:

npm run build

To lint with ESLint:

npm run lint

To test with Mocha

npm run mocha

License

Pen is released under the MIT License.

More Repositories

1

kawa

A macOS input source switcher with user-defined shortcuts.
Swift
1,369
star
2

react-render-html

Render HTML as React element, possibly replacing dangerouslySetInnerHTML
JavaScript
216
star
3

lens.ts

TypeScript Lens implementation with property proxy
TypeScript
142
star
4

kou

A minimal language compiled into wasm bytecode
TypeScript
134
star
5

express-formidable

An Express middleware of Formidable that just works.
JavaScript
132
star
6

tinypack

A simple TypeScript module bundler
TypeScript
63
star
7

monkey-hs

An interpreter for the Monkey programming language written in Haskell
Haskell
49
star
8

incinerator

A PoC implementation of unused code elimination in runtime
JavaScript
43
star
9

monkey-rs

An interpreter for the Monkey programming language written in Rust
Rust
37
star
10

line

Haskell SDK for the LINE APIs
Haskell
31
star
11

ClassHierarchy

Class Hierarchy with CTags for Sublime Text 2
Python
20
star
12

uit-meetup-11

UIT meetup vol.11 talk: Build you a static site generator
JavaScript
13
star
13

futaba

TensorFlow.js Example for Color Personalization
Vue
12
star
14

s-exify

Beautifier for S-expression, mainly for WAT
TypeScript
11
star
15

react-attr-converter

Convert HTML attribute names to React props
JavaScript
8
star
16

purescript-halogen-free-html

Free monad for Halogen HTML
PureScript
8
star
17

dotfiles

dotfiles for me
Vim Script
8
star
18

osx-screen-capture

Screen capture and upload tool for OS X.
Python
4
star
19

coursera-machine-learning

Programming assignments of the Machine Learning course in Coursera
MATLAB
4
star
20

mitty

A Brain*uck to WASM compiler
Brainfuck
4
star
21

suzu

SimpleHTTPServer alternative for Node.js, with no cache
JavaScript
3
star
22

MACwMP

Monadic array comprehension with meta programming in JS
JavaScript
3
star
23

smi-editor

Command-line SMI editor script only for synchronizing the subtitle!
Python
2
star
24

previewable-iterator

Previewable Iterable/Iterator for JavaScript/TypeScript
TypeScript
2
star
25

lint-webpack-plugin

A webpack plugin to run custom lint shell command
JavaScript
2
star
26

touhou-css

A CSS practice with Touhou
CSS
2
star
27

evernote2bitly

import evernote enex file format bookmarks into bitly
Python
1
star
28

bookmark

A simple bookmark script for me and you.
1
star
29

safari-imgur

DIY Safari Extension to upload images to Imgur
JavaScript
1
star
30

shogi-ui

A collection of HTML, CSS and JS for Shogi (将棋) UI on Web.
JavaScript
1
star
31

chess

A chess server
Go
1
star
32

scenic

See great pictures with your friends!
JavaScript
1
star
33

game-of-life

Conway's Game of Life with CoffeeScript
CoffeeScript
1
star
34

mahjong-statistics

django powered mahjong statistics
Python
1
star
35

euler

A Haskell adventure into Project Euler
Haskell
1
star
36

typed-styled-components

TypeScript + styled-components in a simple way
TypeScript
1
star
37

soramaru

A Twitter list viewer for images
JavaScript
1
star